View Javadoc

1   /**
2    * Copyright 2005-2012 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.krad.uif;
17  
18  /**
19   * General constants used within the User Interface Framework
20   *
21   * @author Kuali Rice Team (rice.collab@kuali.org)
22   */
23  public class UifConstants {
24      public static final String CONTROLLER_METHOD_DISPATCH_PARAMETER_NAME = "methodToCall";
25      public static final String DEFAULT_MODEL_NAME = "KualiForm";
26      public static final String DEFAULT_VIEW_NAME = "default";
27      public static final String COMPONENT_ID_PREFIX = "u";
28      public static final String SPRING_VIEW_ID = "Application";
29      public static final String SPRING_REDIRECT_ID = "redirectURL";
30  
31      public static final String EL_PLACEHOLDER_PREFIX = "@{";
32      public static final String EL_PLACEHOLDER_SUFFIX = "}";
33      public static final String NO_BIND_ADJUST_PREFIX = "#form.";
34      public static final String DEFAULT_PATH_BIND_ADJUST_PREFIX = "#dp.";
35      public static final String FIELD_PATH_BIND_ADJUST_PREFIX = "#fp.";
36      public static final String LINE_PATH_BIND_ADJUST_PREFIX = "#lp.";
37      public static final String NODE_PATH_BIND_ADJUST_PREFIX = "#np.";
38  
39      public static enum Position {
40          BOTTOM, LEFT, RIGHT, TOP
41      }
42  
43      public static enum Order {
44          FIRST
45      }
46  
47      public static enum NavigationType {
48          VERTICAL_MENU, HORIZONTAL_TABS
49      }
50  
51      public static enum Orientation {
52          HORIZONTAL, VERTICAL
53      }
54  
55      public static enum MessageType {
56          NORMAL, CUTLINE, INSTRUCTIONAL, CONSTRAINT, REQUIRED, HELP_SUMMARY, HELP_DESCRIPTION
57      }
58  
59      public static enum ViewType {
60          DEFAULT, DOCUMENT, INQUIRY, LOOKUP, MAINTENANCE, INCIDENT;
61      }
62  
63      public static enum ControlType {
64          CHECKBOX, CHECKBOXGROUP, FILE, GROUP, HIDDEN, RADIOGROUP, SELECT,
65          TEXTAREA, TEXT, USER
66      }
67  
68      public static enum WorkflowAction {
69          SAVE, ROUTE, BLANKETAPPROVE, APPROVE, DISAPPROVE, CANCEL, FYI, ACKNOWLEDGE, COMPLETE
70      }
71  
72      public static class MethodToCallNames {
73          public static final String NAVIGATE = "navigate";
74          public static final String START = "start";
75          public static final String SAVE = "save";
76          public static final String SEARCH = "search";
77          public static final String CLOSE = "close";
78          public static final String ADD_LINE = "addLine";
79          public static final String DELETE_LINE = "deleteLine";
80          public static final String REFRESH = "refresh";
81          public static final String CANCEL = "cancel";
82          public static final String UPDATE_COMP = "updateComponent";
83          public static final String TOGGLE_INACTIVE = "toggleInactiveRecordDisplay";
84      }
85  
86      public static class ActionEvents {
87          public static final String ADD_LINE = "addLine";
88      }
89  
90      public static class LayoutComponentOptions {
91          public static final String COLUMN_SPAN = "colSpan";
92          public static final String ROW_SPAN = "rowSpan";
93      }
94  
95      public static class IdSuffixes {
96          public static final String ADD_LINE = "_add";
97          public static final String ATTRIBUTE = "_attribute";
98          public static final String COMPARE = "_comp";
99          public static final String CONSTRAINT = "_constraint";
100         public static final String DIRECT_INQUIRY = "_directinquiry";
101         public static final String DIV = "_div";
102         public static final String ERRORS = "_errors";
103         public static final String INSTRUCTIONAL = "_instructional";
104         public static final String LINE = "_line";
105         public static final String LABEL = "_label";
106         public static final String SUB = "_sub";
107         public static final String SUGGEST = "_suggest";
108         public static final String QUICK_FINDER = "_quickfinder";
109     }
110 
111     public static class ViewPhases {
112         public static final String INITIALIZE = "INITIALIZE";
113         public static final String APPLY_MODEL = "APPLY_MODEL";
114         public static final String FINALIZE = "FINALIZE";
115     }
116 
117     public static class ViewStatus {
118         public static final String CREATED = "C";
119         public static final String INITIALIZED = "I";
120         public static final String FINAL = "F";
121     }
122 
123     public static class ContextVariableNames {
124         public static final String COLLECTION_GROUP = "collectionGroup";
125         public static final String CONFIG_PROPERTIES = "ConfigProperties";
126         public static final String COMPONENT = "component";
127         public static final String CONSTANTS = "Constants";
128         public static final String DOCUMENT_ENTRY = "DocumentEntry";
129         public static final String INDEX = "index";
130         public static final String IS_ADD_LINE = "isAddLine";
131         public static final String LINE = "line";
132         public static final String READONLY_LINE = "readOnlyLine";
133         public static final String MANAGER = "manager";
134         public static final String NODE = "node";
135         public static final String NODE_PATH = "nodePath";
136         public static final String PARENT = "parent";
137         public static final String UIF_CONSTANTS = "UifConstants";
138         public static final String VIEW = "view";
139         public static final String VIEW_HELPER = "ViewHelper";
140     }
141 
142     public static class TableToolsKeys {
143         public static final String AASORTING = "aaSorting";
144         public static final String BAUTO_TYPE = "bAutoType";
145         public static final String SDOM = "sDom";
146         public static final String LANGUAGE = "oLanguage";
147         public static final String EMPTY_TABLE = "sEmptyTable";
148         public static final String AO_COLUMNS = "aoColumns";
149         public static final String SORT_SKIP_ROWS = "aiSortingSkipRows";
150         public static final String SORT_DATA_TYPE = "sSortDataType";
151         public static final String SORTABLE = "bSortable";
152         public static final String VISIBLE = "bVisible";
153         public static final String SORT_TYPE = "sType";
154         public static final String TABLE_SORT = "bSort";
155     }
156 
157     public static class TableToolsValues {
158         public static final String DOM_TEXT = "dom-text";
159         public static final String DOM_SELECT = "dom-select";
160         public static final String DOM_CHECK = "dom-checkbox";
161         public static final String DOM_RADIO = "dom-radio";
162         public static final String NUMERIC = "numeric";
163         public static final String STRING = "string";
164         public static final String DATE = "kuali_date";
165         public static final String PERCENT = "kuali_percent";
166         public static final String CURRENCY = "kuali_currency";
167         public static final String TIMESTAMP = "kuali_timestamp";
168          public static final String FALSE = "false";
169 
170         public static final int ADD_ROW_DEFAULT_INDEX = 0;
171     }
172 
173     public static class ReordererOptionKeys {
174         public static final String SELECTORS = "selectors";
175         public static final String MOVABLES = "movables";
176     }
177 
178     public static class TitleAppendTypes {
179         public static final String DASH = "dash";
180         public static final String PARENTHESIS = "parenthesis";
181         public static final String REPLACE = "replace";
182         public static final String NONE = "none";
183     }
184 
185     public static class UrlParams {
186         public static final String ACTION_EVENT = "actionEvent";
187         public static final String SHOW_HISTORY = "showHistory";
188         public static final String SHOW_HOME = "showHome";
189         public static final String FORM_KEY = "formKey";
190         public static final String PAGE_ID = "pageId";
191         public static final String HISTORY = "history";
192     }
193 
194     public static class Messages {
195         public static final String VALIDATION_MSG_KEY_PREFIX = "validation.";
196     }
197 
198     public static class MessageKeys {
199         public static final String QUERY_DATA_NOT_FOUND = "query.dataNotFound";
200     }
201 
202     public static class ClientSideVariables {
203         public static final String KRAD_IMAGE_LOCATION = "kradImageLocation";
204         public static final String KRAD_URL = "kradUrl";
205     }
206 
207     public static class RefreshCallerTypes {
208         public static final String LOOKUP = "LOOKUP";
209         public static final String MULTI_VALUE_LOOKUP = "MULTI_VALUE_LOOKUP";
210         public static final String QUESTION = "QUESTION";
211     }
212 }