View Javadoc

1   /**
2    * Copyright 2005-2011 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 SPRING_VIEW_ID = "ApplicationView";
28      public static final String SPRING_REDIRECT_ID = "redirectURL";
29  
30      public static enum Position {
31          BOTTOM, LEFT, RIGHT, TOP
32      }
33  
34      public static enum Order {
35          FIRST
36      }
37  
38      public static enum NavigationType {
39          VERTICAL_MENU, HORIZONTAL_TABS
40      }
41  
42      public static enum Orientation {
43          HORIZONTAL, VERTICAL
44      }
45  
46      public static enum MessageType {
47          NORMAL, INSTRUCTIONAL, CONSTRAINT, REQUIRED, HELP_SUMMARY, HELP_DESCRIPTION
48      }
49  
50      public static enum ViewType {
51          DEFAULT, DOCUMENT, INQUIRY, LOOKUP, MAINTENANCE, INCIDENT;
52      }
53  
54      public static enum ControlType {
55          CHECKBOX, CHECKBOXGROUP, FILE, GROUP, HIDDEN, RADIOGROUP, SELECT,
56          TEXTAREA, TEXT, USER
57      }
58  
59      public static enum WorkflowAction {
60          SAVE, ROUTE, BLANKETAPPROVE, APPROVE, DISAPPROVE, CANCEL, FYI, ACKNOWLEDGE
61      }
62  
63      public static class MethodToCallNames {
64          public static final String NAVIGATE = "navigate";
65          public static final String START = "start";
66          public static final String SAVE = "save";
67          public static final String SEARCH = "search";
68          public static final String CLOSE = "close";
69          public static final String ADD_LINE = "addLine";
70          public static final String DELETE_LINE = "deleteLine";
71          public static final String REFRESH = "refresh";
72          public static final String CANCEL = "cancel";
73          public static final String UPDATE_COMP = "updateComponent";
74          public static final String TOGGLE_INACTIVE = "toggleInactiveRecordDisplay";
75      }
76  
77      public static class ActionEvents {
78          public static final String ADD_LINE = "addLine";
79      }
80  
81      public static class LayoutComponentOptions {
82          public static final String COLUMN_SPAN = "colSpan";
83          public static final String ROW_SPAN = "rowSpan";
84      }
85  
86      public static class IdSuffixes {
87          public static final String ADD_LINE = "_add";
88          public static final String ATTRIBUTE = "_attribute";
89          public static final String COMPARE = "_comp";
90          public static final String CONSTRAINT = "_constraint";
91          public static final String DIRECT_INQUIRY = "_directinquiry";
92          public static final String DIV = "_div";
93          public static final String ERRORS = "_errors";
94          public static final String INSTRUCTIONAL = "_instructional";
95          public static final String LINE = "_line";
96          public static final String LABEL = "_label";
97          public static final String SUB = "_sub";
98          public static final String SUGGEST = "_suggest";
99          public static final String QUICK_FINDER = "_quickfinder";
100     }
101 
102     public static class ViewPhases {
103         public static final String INITIALIZE = "INITIALIZE";
104         public static final String APPLY_MODEL = "APPLY_MODEL";
105         public static final String FINALIZE = "FINALIZE";
106     }
107 
108     public static class ViewStatus {
109         public static final String CREATED = "C";
110         public static final String INITIALIZED = "I";
111         public static final String FINAL = "F";
112     }
113 
114     public static final String EL_PLACEHOLDER_PREFIX = "@{";
115     public static final String EL_PLACEHOLDER_SUFFIX = "}";
116     public static final String NO_BIND_ADJUST_PREFIX = "form.";
117     public static final String DATA_OBJECT_BIND_ADJUST_PREFIX = "do.";
118 
119     public static class ContextVariableNames {
120         public static final String COLLECTION_GROUP = "collectionGroup";
121         public static final String CONFIG_PROPERTIES = "ConfigProperties";
122         public static final String COMPONENT = "component";
123         public static final String CONSTANTS = "Constants";
124         public static final String DOCUMENT_ENTRY = "DocumentEntry";
125         public static final String INDEX = "index";
126         public static final String IS_ADD_LINE = "isAddLine";
127         public static final String LINE = "line";
128         public static final String MANAGER = "manager";
129         public static final String NODE = "node";
130         public static final String PARENT = "parent";
131         public static final String VIEW = "view";
132         public static final String VIEW_HELPER = "ViewHelper";
133     }
134 
135     public static class TableToolsKeys {
136         public static final String AASORTING = "aaSorting";
137         public static final String BAUTO_TYPE = "bAutoType";
138         public static final String SDOM = "sDom";
139         public static final String LANGUAGE = "oLanguage";
140         public static final String EMPTY_TABLE = "sEmptyTable";
141         public static final String AO_COLUMNS = "aoColumns";
142         public static final String SORT_SKIP_ROWS = "aiSortingSkipRows";
143         public static final String SORT_DATA_TYPE = "sSortDataType";
144         public static final String SORTABLE = "bSortable";
145         public static final String SORT_TYPE = "sType";
146         public static final String TABLE_SORT = "bSort";
147     }
148 
149     public static class TableToolsValues {
150         public static final String DOM_TEXT = "dom-text";
151         public static final String DOM_SELECT = "dom-select";
152         public static final String DOM_CHECK = "dom-checkbox";
153         public static final String DOM_RADIO = "dom-radio";
154         public static final String NUMERIC = "numeric";
155         public static final String STRING = "string";
156         public static final String DATE = "kuali_date";
157         public static final String PERCENT = "kuali_percent";
158         public static final String CURRENCY = "kuali_currency";
159         public static final String TIMESTAMP = "kuali_timestamp";
160 
161         public static final int ADD_ROW_DEFAULT_INDEX = 0;
162     }
163 
164     public static class TitleAppendTypes {
165         public static final String DASH = "dash";
166         public static final String PARENTHESIS = "parenthesis";
167         public static final String REPLACE = "replace";
168         public static final String NONE = "none";
169     }
170 
171     public static class UrlParams {
172         public static final String ACTION_EVENT = "actionEvent";
173         public static final String SHOW_HISTORY = "showHistory";
174         public static final String SHOW_HOME = "showHome";
175         public static final String FORM_KEY = "formKey";
176         public static final String PAGE_ID = "pageId";
177         public static final String HISTORY = "history";
178     }
179 
180     public static class Messages {
181         public static final String VALIDATION_MSG_KEY_PREFIX = "validation.";
182     }
183 
184     public static class MessageKeys {
185         public static final String QUERY_DATA_NOT_FOUND = "query.dataNotFound";
186     }
187 
188     public static class ClientSideVariables {
189         public static final String KRAD_IMAGE_LOCATION = "kradImageLocation";
190     }
191 
192     public static class RefreshCallerTypes {
193         public static final String LOOKUP = "LOOKUP";
194         public static final String MULTI_VALUE_LOOKUP = "MULTI_VALUE_LOOKUP";
195         public static final String QUESTION = "QUESTION";
196     }
197 }