View Javadoc
1   package org.andromda.cartridges.jsf2;
2   
3   /**
4    * Stores globals for the JSF cartridge metafacades.
5    *
6    * @author Chad Brandon
7    */
8   public class JSFGlobals
9   {
10      /**
11       * Should generate Impl classes, always ?.
12       */
13      public static final String GENERATE_CRUD_IMPLS = "generateCrudImpls";
14  
15      /**
16       * The suffix to append to the class names of CRUD value objects.
17       */
18      public static final String CRUD_VALUE_OBJECT_SUFFIX = "crudValueObjectSuffix";
19  
20      /**
21       * A space-separated list of types to which displaytag table are to be exported by default.
22       */
23      public static final String PROPERTY_DEFAULT_TABLE_EXPORT_TYPES = "defaultTableExportTypes";
24  
25      /**
26       * The default number of columns to render for input fields.
27       */
28      public static final String PROPERTY_DEFAULT_INPUT_COLUMN_COUNT = "defaultInputColumnCount";
29  
30      /**
31       * The default number of rows to render for textarea fields.
32       */
33      public static final String PROPERTY_DEFAULT_INPUT_ROW_COUNT = "defaultInputRowCount";
34  
35      /**
36       * Denotes the way application resource messages ought to be generated.
37       * When messages are normalized it means that elements with the same name
38       * will reuse the same label, even if they are located in entirely different
39       * use-cases or pages.
40       * <p/>
41       * This results in resource bundles that are not only smaller in size but
42       * also more straightforward to translate. The downside is that it will be
43       * less evident to customize labels for certain fields (which is rarely the
44       * case anyway).
45       * <p/>
46       */
47      public static final String NORMALIZE_MESSAGES = "normalizeMessages";
48  
49      /**
50       * The pattern for constructing the form name.
51       */
52      public static final String FORM_PATTERN = "formPattern";
53  
54      /**
55       * Contains the default value for whether or not all forwards should perform a HTTP redirect or not.
56       */
57      public static final String DEFAULT_ACTION_REDIRECT = "defaultActionRedirect";
58  
59      /**
60       * The pattern for constructing the form implementation name.
61       */
62      public static final String FORM_IMPLEMENTATION_PATTERN = "formImplementationPattern";
63  
64      /**
65       * The pattern for constructing the bean name under which the form is stored.
66       */
67      public static final String FORM_BEAN_PATTERN = "formBeanPattern";
68  
69      /**
70       * Stores the default form scope which can be overridden with a tagged value.
71       */
72      public static final String FORM_SCOPE = "formScope";
73  
74      /**
75       * Stores the pattern used for constructing the controller implementation name.
76       */
77      public static final String CONTROLLER_IMPLEMENTATION_PATTERN = "controllerImplementationPattern";
78  
79      /**
80       * The suffix given to title message keys.
81       */
82      public static final String TITLE_MESSAGE_KEY_SUFFIX = "title";
83  
84      /**
85       * The suffix given to the documentation message keys.
86       */
87      public static final String DOCUMENTATION_MESSAGE_KEY_SUFFIX = "documentation";
88  
89      /**
90       * The namespace property used to identify the pattern used to construct the backend service's accessor.
91       */
92      public static final String SERVICE_ACCESSOR_PATTERN = "serviceAccessorPattern";
93  
94      /**
95       * The namespace property used to identify the pattern used to construct the backend service's package name.
96       */
97      public static final String SERVICE_PACKAGE_NAME_PATTERN = "servicePackageNamePattern";
98  
99      /**
100      * Represents a hyperlink action type.
101      */
102     public static final String ACTION_TYPE_HYPERLINK = "hyperlink";
103 
104     /**
105      * Represents a popup action type.
106      */
107     public static final String ACTION_TYPE_POPUP = "popup";
108 
109     /**
110      * Represents a dialog action type.
111      */
112     public static final String ACTION_TYPE_DIALOG = "dialog";
113 
114     /**
115      * Represents a form action type.
116      */
117     public static final String ACTION_TYPE_FORM = "form";
118 
119     /**
120      * Represents a table action type.
121      */
122     public static final String ACTION_TYPE_TABLE = "table";
123 
124     /**
125      * Represents an image action type.
126      */
127     public static final String ACTION_TYPE_IMAGE = "image";
128 
129     /**
130      * Stores the default date format when dates are formatted.
131      */
132     public static final String PROPERTY_DEFAULT_DATEFORMAT = "defaultDateFormat";
133 
134     /**
135      * Stores the default time format when times are formatted.
136      */
137     public static final String PROPERTY_DEFAULT_TIMEFORMAT = "defaultTimeFormat";
138 
139     /**
140      * The default key under which the action form is stored.
141      */
142     public static final String ACTION_FORM_KEY = "actionFormKey";
143 
144     /**
145      * The pattern used for constructing the name of the filter that performs view form population.
146      */
147     public static final String VIEW_POPULATOR_PATTERN = "viewPopulatorPattern";
148 
149     /**
150      * The pattern used for constructing a parameter's backing list name.  A backing list
151      * is used when you want to select the value of the parameter from a list (typically
152      * used for drop-down select input types).
153      */
154     public static final String BACKING_LIST_PATTERN = "backingListPattern";
155 
156     /**
157      * The pattern used for constructing a parameter's backing value name.  A backing value
158      * is used when you want to select and submit values from a regular table (works well when
159      * you have a list of complex items with values you need to submit).
160      */
161     public static final String BACKING_VALUE_PATTERN = "backingValuePattern";
162 
163     /**
164      * The pattern used for constructing the label list name (stores the list
165      * of possible parameter value labels).
166      */
167     public static final String LABEL_LIST_PATTERN = "labelListPattern";
168 
169     /**
170      * The pattern used for constructing the values list name (stores the list of
171      * possible parameter values when selecting from a list).
172      */
173     public static final String VALUE_LIST_PATTERN = "valueListPattern";
174 
175     /**
176      * The item count for dummy arrays.
177      */
178     public static final int DUMMY_ARRAY_COUNT = 5;
179 
180     /**
181      * The pattern used for constructing the name of JSF converter classes (i.e.
182      * the enumeration converter).
183      */
184     public static final String CONVERTER_PATTERN = "converterPattern";
185 
186     /**
187      * The "textarea" form input type.
188      */
189     public static final String INPUT_TEXTAREA = "textarea";
190 
191     /**
192      * The "select" form input type.
193      */
194     public static final String INPUT_SELECT = "select";
195 
196     /**
197      * The "password" form input type.
198      */
199     public static final String INPUT_PASSWORD = "password";
200 
201     /**
202      * The "hidden" form input type.
203      */
204     public static final String INPUT_HIDDEN = "hidden";
205 
206     /**
207      * The "radio" form input type.
208      */
209     public static final String INPUT_RADIO = "radio";
210 
211     /**
212      * The "text" form input type.
213      */
214     public static final String INPUT_TEXT = "text";
215 
216     /**
217      * The "multibox" form input type.
218      */
219     public static final String INPUT_MULTIBOX = "multibox";
220 
221     /**
222      * The "table" form input type.
223      */
224     public static final String INPUT_TABLE = "table";
225 
226     /**
227      * The "checkbox" form input type.
228      */
229     public static final String INPUT_CHECKBOX = "checkbox";
230 
231     /**
232      * The "plain text" type.
233      */
234     public static final String PLAIN_TEXT = "plaintext";
235 
236     /**
237      * The suffix to append to the forward name.
238      */
239     public static final String USECASE_FORWARD_NAME_SUFFIX = "-usecase";
240 }