001package org.andromda.cartridges.jsf;
002
003/**
004 * Stores globals for the JSF cartridge metafacades.
005 *
006 * @author Chad Brandon
007 */
008public class JSFGlobals
009{
010    /**
011     * The suffix to append to the class names of CRUD value objects.
012     */
013    public static final String CRUD_VALUE_OBJECT_SUFFIX = "crudValueObjectSuffix";
014
015    /**
016     * A space-separated list of types to which displaytag table are to be exported by default.
017     */
018    public static final String PROPERTY_DEFAULT_TABLE_EXPORT_TYPES = "defaultTableExportTypes";
019
020    /**
021     * The default number of columns to render for input fields.
022     */
023    public static final String PROPERTY_DEFAULT_INPUT_COLUMN_COUNT = "defaultInputColumnCount";
024
025    /**
026     * The default number of rows to render for textarea fields.
027     */
028    public static final String PROPERTY_DEFAULT_INPUT_ROW_COUNT = "defaultInputRowCount";
029
030    /**
031     * Denotes the way application resource messages ought to be generated.
032     * When messages are normalized it means that elements with the same name
033     * will reuse the same label, even if they are located in entirely different
034     * use-cases or pages.
035     * <p/>
036     * This results in resource bundles that are not only smaller in size but
037     * also more straightforward to translate. The downside is that it will be
038     * less evident to customize labels for certain fields (which is rarely the
039     * case anyway).
040     * <p/>
041     */
042    public static final String NORMALIZE_MESSAGES = "normalizeMessages";
043
044    /**
045     * The pattern for constructing the form name.
046     */
047    public static final String FORM_PATTERN = "formPattern";
048
049    /**
050     * Contains the default value for whether or not all forwards should perform a HTTP redirect or not.
051     */
052    public static final String DEFAULT_ACTION_REDIRECT = "defaultActionRedirect";
053
054    /**
055     * The pattern for constructing the form implementation name.
056     */
057    public static final String FORM_IMPLEMENTATION_PATTERN = "formImplementationPattern";
058
059    /**
060     * The pattern for constructing the bean name under which the form is stored.
061     */
062    public static final String FORM_BEAN_PATTERN = "formBeanPattern";
063
064    /**
065     * Stores the default form scope which can be overridden with a tagged value.
066     */
067    public static final String FORM_SCOPE = "formScope";
068
069    /**
070     * Stores the pattern used for constructing the controller implementation name.
071     */
072    public static final String CONTROLLER_IMPLEMENTATION_PATTERN = "controllerImplementationPattern";
073
074    /**
075     * The suffix given to title message keys.
076     */
077    public static final String TITLE_MESSAGE_KEY_SUFFIX = "title";
078
079    /**
080     * The suffix given to the documentation message keys.
081     */
082    public static final String DOCUMENTATION_MESSAGE_KEY_SUFFIX = "documentation";
083
084    /**
085     * The namespace property used to identify the pattern used to construct the backend service's accessor.
086     */
087    public static final String SERVICE_ACCESSOR_PATTERN = "serviceAccessorPattern";
088
089    /**
090     * The namespace property used to identify the pattern used to construct the backend service's package name.
091     */
092    public static final String SERVICE_PACKAGE_NAME_PATTERN = "servicePackageNamePattern";
093
094    /**
095     * Represents a hyperlink action type.
096     */
097    public static final String ACTION_TYPE_HYPERLINK = "hyperlink";
098
099    /**
100     * Represents a popup action type.
101     */
102    public static final String VIEW_TYPE_POPUP = "popup";
103
104    /**
105     * Represents a form action type.
106     */
107    public static final String ACTION_TYPE_FORM = "form";
108
109    /**
110     * Represents a table action type.
111     */
112    public static final String ACTION_TYPE_TABLE = "table";
113
114    /**
115     * Represents an image action type.
116     */
117    public static final String ACTION_TYPE_IMAGE = "image";
118
119    /**
120     * Stores the default date format when dates are formatted.
121     */
122    public static final String PROPERTY_DEFAULT_DATEFORMAT = "defaultDateFormat";
123
124    /**
125     * Stores the default time format when times are formatted.
126     */
127    public static final String PROPERTY_DEFAULT_TIMEFORMAT = "defaultTimeFormat";
128
129    /**
130     * The default key under which the action form is stored.
131     */
132    public static final String ACTION_FORM_KEY = "actionFormKey";
133
134    /**
135     * The pattern used for constructing the name of the filter that performs view form population.
136     */
137    public static final String VIEW_POPULATOR_PATTERN = "viewPopulatorPattern";
138
139    /**
140     * The pattern used for constructing a parameter's backing list name.  A backing list
141     * is used when you want to select the value of the parameter from a list (typically
142     * used for drop-down select input types).
143     */
144    public static final String BACKING_LIST_PATTERN = "backingListPattern";
145
146    /**
147     * The pattern used for constructing a parameter's backing value name.  A backing value
148     * is used when you want to select and submit values from a regular table (works well when
149     * you have a list of complex items with values you need to submit).
150     */
151    public static final String BACKING_VALUE_PATTERN = "backingValuePattern";
152
153    /**
154     * The pattern used for constructing the label list name (stores the list
155     * of possible parameter value labels).
156     */
157    public static final String LABEL_LIST_PATTERN = "labelListPattern";
158
159    /**
160     * The pattern used for constructing the values list name (stores the list of
161     * possible parameter values when selecting from a list).
162     */
163    public static final String VALUE_LIST_PATTERN = "valueListPattern";
164
165    /**
166     * The item count for dummy arrays.
167     */
168    public static final int DUMMY_ARRAY_COUNT = 5;
169
170    /**
171     * The pattern used for constructing the name of JSF converter classes (i.e.
172     * the enumeration converter).
173     */
174    public static final String CONVERTER_PATTERN = "converterPattern";
175
176    /**
177     * The "textarea" form input type.
178     */
179    public static final String INPUT_TEXTAREA = "textarea";
180
181    /**
182     * The "select" form input type.
183     */
184    public static final String INPUT_SELECT = "select";
185
186    /**
187     * The "password" form input type.
188     */
189    public static final String INPUT_PASSWORD = "password";
190
191    /**
192     * The "hidden" form input type.
193     */
194    public static final String INPUT_HIDDEN = "hidden";
195
196    /**
197     * The "radio" form input type.
198     */
199    public static final String INPUT_RADIO = "radio";
200
201    /**
202     * The "text" form input type.
203     */
204    public static final String INPUT_TEXT = "text";
205
206    /**
207     * The "multibox" form input type.
208     */
209    public static final String INPUT_MULTIBOX = "multibox";
210
211    /**
212     * The "table" form input type.
213     */
214    public static final String INPUT_TABLE = "table";
215
216    /**
217     * The "checkbox" form input type.
218     */
219    public static final String INPUT_CHECKBOX = "checkbox";
220
221    /**
222     * The "plain text" type.
223     */
224    public static final String PLAIN_TEXT = "plaintext";
225
226    /**
227     * The suffix to append to the forward name.
228     */
229    public static final String USECASE_FORWARD_NAME_SUFFIX = "-usecase";
230}