001 /**
002 * Copyright 2005-2013 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package org.kuali.rice.krad.uif;
017
018 /**
019 * General constants used within the User Interface Framework
020 *
021 * @author Kuali Rice Team (rice.collab@kuali.org)
022 */
023 public class UifConstants {
024 public static final String CONTROLLER_METHOD_DISPATCH_PARAMETER_NAME = "methodToCall";
025 public static final String DEFAULT_MODEL_NAME = "KualiForm";
026 public static final String COMPONENT_MODEL_NAME = "Component";
027 public static final String DEFAULT_VIEW_NAME = "default";
028 public static final String COMPONENT_ID_PREFIX = "u";
029
030 public static final String DEFAULT_THEMES_DIRECTORY = "/themes";
031 public static final String DEFAULT_IMAGES_DIRECTORY = "images";
032 public static final String DEFAULT_SCRIPTS_DIRECTORY = "scripts";
033 public static final String DEFAULT_STYLESHEETS_DIRECTORY = "stylesheets";
034 public static final String THEME_DERIVED_PROPERTY_FILE = "theme-derived.properties";
035 public static final String THEME_CSS_FILES = "themeCssFiles";
036 public static final String THEME_JS_FILES = "themeJsFiles";
037
038 // uncomment for freemarker testing
039 public static final String SPRING_VIEW_ID = "/krad/WEB-INF/ftl/uifRender";
040 public static final String SPRING_REDIRECT_ID = "/krad/WEB-INF/ftl/redirect";
041 public static final String REDIRECT_PREFIX = "redirect:";
042
043 public static final String EL_PLACEHOLDER_PREFIX = "@{";
044 public static final String EL_PLACEHOLDER_SUFFIX = "}";
045 public static final String NO_BIND_ADJUST_PREFIX = "#form.";
046 public static final String DEFAULT_PATH_BIND_ADJUST_PREFIX = "#dp.";
047 public static final String FIELD_PATH_BIND_ADJUST_PREFIX = "#fp.";
048 public static final String LINE_PATH_BIND_ADJUST_PREFIX = "#lp.";
049 public static final String NODE_PATH_BIND_ADJUST_PREFIX = "#np.";
050 public static final String STRING_TEMPLATE_PARAMETER_PLACEHOLDER = "@";
051
052 public static final String SPACE = " ";
053
054 public static final String REQUEST_FORM = "requestForm";
055
056 public static final String BLOCKUI_NAVOPTS = "navigation";
057 public static final String BLOCKUI_REFRESHOPTS = "refresh";
058
059 public static final String VALIDATE_VIEWS_ONBUILD = "validate.views.onbuild";
060
061 public static final String MESSAGE_VIEW_ID = "Uif-MessageView";
062 public static final String SESSION_TIMEOUT_VIEW_ID = "Uif-SessionTimeoutView";
063 public static final String LOGGED_OUT_VIEW_ID = "Uif-LoggedOutView";
064 public static final String GROUP_VALIDATION_DEFAULTS_MAP_ID = "Uif-GroupValidationMessages-DataDefaults";
065 public static final String FIELD_VALIDATION_DEFAULTS_MAP_ID = "Uif-FieldValidationMessages-DataDefaults";
066 public static final String REFERER = "Referer";
067 public static final String NO_RETURN = "NO_RETURN";
068
069 public static enum ReadOnlyListTypes {
070 DELIMITED, BREAK, OL, UL
071 }
072
073 public static enum Position {
074 BOTTOM, LEFT, RIGHT, TOP
075 }
076
077 public static enum Order {
078 FIRST, LINE_FIRST, NEXT_INPUT, SELF
079 }
080
081 public static enum NavigationType {
082 VERTICAL_MENU, HORIZONTAL_TABS
083 }
084
085 public static enum Orientation {
086 HORIZONTAL, VERTICAL
087 }
088
089 public static enum ViewType {
090 DEFAULT, DOCUMENT, INQUIRY, LOOKUP, MAINTENANCE, INCIDENT, TRANSACTIONAL;
091 }
092
093 public static enum ControlType {
094 CHECKBOX, CHECKBOXGROUP, FILE, GROUP, HIDDEN, RADIOGROUP, SELECT,
095 TEXTAREA, TEXT, USER
096 }
097
098 public static enum WorkflowAction {
099 SAVE, ROUTE, BLANKETAPPROVE, APPROVE, DISAPPROVE, CANCEL, FYI, ACKNOWLEDGE, COMPLETE, SENDADHOCREQUESTS
100 }
101
102 /**
103 * Enum of return types. Used to return the type of response being sent by the server to the client.
104 */
105 public enum AjaxReturnTypes {
106 UPDATEPAGE("update-page"), UPDATECOMPONENT("update-component"), REDIRECT("redirect"),
107 UPDATEVIEW("update-view"), UPDATECOLLECTION("update-collection"),
108 UPDATENONE("update-none"), DISPLAYLIGHTBOX("display-lightbox"),
109 UPDATEDIALOG("update-dialog");
110
111 private String key;
112
113 AjaxReturnTypes(String key) {
114 this.key = key;
115 }
116
117 public String getKey() {
118 return key;
119 }
120
121 public void setKey(String key) {
122 this.key = key;
123 }
124 }
125
126 public static class MethodToCallNames {
127 public static final String NAVIGATE = "navigate";
128 public static final String START = "start";
129 public static final String SAVE = "save";
130 public static final String SEARCH = "search";
131 public static final String CLOSE = "close";
132 public static final String ADD_LINE = "addLine";
133 public static final String DELETE_LINE = "deleteLine";
134 public static final String REFRESH = "refresh";
135 public static final String CANCEL = "cancel";
136 public static final String SESSION_TIMEOUT = "sessionTimeout";
137 public static final String TABLE_JSON = "tableJsonRetrieval";
138 public static final String TABLE_DATA = "tableDataRetrieval";
139 }
140
141 public static class ActionEvents {
142 public static final String ADD_LINE = "addLine";
143 public static final String ADD_BLANK_LINE = "addBlankLine";
144 }
145
146 public static class LayoutComponentOptions {
147 public static final String COLUMN_SPAN = "colSpan";
148 public static final String ROW_SPAN = "rowSpan";
149 }
150
151 public static class RowSelection {
152 public static final String ALL = "all";
153 public static final String ODD = "odd";
154 public static final String EVEN = "even";
155 }
156
157 public static class IdSuffixes {
158 public static final String ADD_LINE = "_add";
159 public static final String CONTROL = "_control";
160 public static final String ATTRIBUTE = "_attribute";
161 public static final String COMPARE = "_comp";
162 public static final String CONSTRAINT = "_constraint";
163 public static final String DIRECT_INQUIRY = "_directinquiry";
164 public static final String ERRORS = "_errors";
165 public static final String INSTRUCTIONAL = "_instructional";
166 public static final String LINE = "_line";
167 public static final String LABEL = "_label";
168 public static final String FIELDSET = "_fieldset";
169 public static final String SUB = "_sub";
170 public static final String SUGGEST = "_suggest";
171 public static final String QUICK_FINDER = "_quickfinder";
172 public static final String SPAN = "_span";
173 public static final String TAB = "_tab";
174 }
175
176 public static class ViewPhases {
177 public static final String INITIALIZE = "INITIALIZE";
178 public static final String APPLY_MODEL = "APPLY_MODEL";
179 public static final String FINALIZE = "FINALIZE";
180 }
181
182 public static class ViewStatus {
183 public static final String CREATED = "C";
184 public static final String INITIALIZED = "I";
185 public static final String FINAL = "F";
186 }
187
188 public static class ContextVariableNames {
189 public static final String COLLECTION_GROUP = "collectionGroup";
190 public static final String CONFIG_PROPERTIES = "ConfigProperties";
191 public static final String COMPONENT = "component";
192 public static final String CONSTANTS = "Constants";
193 public static final String DOCUMENT_ENTRY = "DocumentEntry";
194 public static final String INDEX = "index";
195 public static final String IS_ADD_LINE = "isAddLine";
196 public static final String LINE = "line";
197 public static final String LINE_SUFFIX = "lineSuffix";
198 public static final String READONLY_LINE = "readOnlyLine";
199 public static final String MANAGER = "manager";
200 public static final String NODE = "node";
201 public static final String NODE_PATH = "nodePath";
202 public static final String PARENT = "parent";
203 public static final String THEME_IMAGES = "ThemeImages";
204 public static final String UIF_CONSTANTS = "UifConstants";
205 public static final String VIEW = "view";
206 public static final String VIEW_HELPER = "ViewHelper";
207 public static final String PARENT_LINE = "parentLine";
208 }
209
210 public static class TableToolsKeys {
211 public static final String AASORTING = "aaSorting";
212 public static final String BAUTO_TYPE = "bAutoType";
213 public static final String SDOM = "sDom";
214 public static final String CELL_CLASS = "sClass";
215 public static final String MDATA = "mDataProp";
216 public static final String LANGUAGE = "oLanguage";
217 public static final String EMPTY_TABLE = "sEmptyTable";
218 public static final String AO_COLUMNS = "aoColumns";
219 public static final String AO_COLUMN_DEFS = "aoColumnDefs";
220 public static final String SORT_SKIP_ROWS = "aiSortingSkipRows";
221 public static final String SORT_DATA_TYPE = "sSortDataType";
222 public static final String SORTABLE = "bSortable";
223 public static final String TARGETS = "aTargets";
224 public static final String VISIBLE = "bVisible";
225 public static final String SORT_TYPE = "sType";
226 public static final String TABLE_SORT = "bSort";
227 public static final String SAJAX_SOURCE = "sAjaxSource";
228 public static final String FOOTER_CALLBACK = "fnFooterCallback";
229 public static final String AA_DATA = "aaData";
230 public static final String DEFER_RENDER = "bDeferRender";
231 public static final String SDOWNLOAD_SOURCE = "sDownloadSource";
232 }
233
234 public static class TableToolsValues {
235 public static final String DOM_TEXT = "dom-text";
236 public static final String DOM_SELECT = "dom-select";
237 public static final String DOM_CHECK = "dom-checkbox";
238 public static final String DOM_RADIO = "dom-radio";
239 public static final String NUMERIC = "numeric";
240 public static final String STRING = "string";
241 public static final String DATE = "kuali_date";
242 public static final String PERCENT = "kuali_percent";
243 public static final String CURRENCY = "kuali_currency";
244 public static final String TIMESTAMP = "kuali_timestamp";
245 public static final String FALSE = "false";
246 public static final String TRUE = "true";
247
248 public static final int ADD_ROW_DEFAULT_INDEX = 0;
249 }
250
251 public static class TableLayoutValues {
252 public static final int ACTIONS_COLUMN_LEFT_INDEX = 1;
253 public static final int ACTIONS_COLUMN_RIGHT_INDEX = -1;
254 }
255
256 public static class TabOptionKeys {
257 public static final String ACTIVE = "active";
258 }
259
260 public static class TitleAppendTypes {
261 public static final String DASH = "dash";
262 public static final String PARENTHESIS = "parenthesis";
263 public static final String REPLACE = "replace";
264 public static final String NONE = "none";
265 }
266
267 public static class ComponentProperties {
268 public static final String HEADER_TEXT = "headerText";
269 }
270
271 public static class UrlParams {
272 public static final String ACTION_EVENT = "actionEvent";
273 public static final String FORM_KEY = "formKey";
274 public static final String VIEW_ID = "viewId";
275 public static final String PAGE_ID = "pageId";
276 public static final String HISTORY = "history";
277 public static final String LAST_FORM_KEY = "lastFormKey";
278 public static final String LOGIN_USER = "__login_user";
279 }
280
281 public static class Messages {
282 public static final String VALIDATION_MSG_KEY_PREFIX = "validation.";
283 public static final String STATE_PREFIX = "validation.statePrefix";
284 }
285
286 public static class MessageKeys {
287 public static final String QUERY_DATA_NOT_FOUND = "query.dataNotFound";
288 public static final String OPTION_ALL = "option.all";
289 }
290
291 public static class ClientSideVariables {
292 public static final String KRAD_IMAGE_LOCATION = "kradImageLocation";
293 public static final String KRAD_URL = "kradUrl";
294 public static final String APPLICATION_URL = "applicationUrl";
295 }
296
297 public static class RefreshCallerTypes {
298 public static final String LOOKUP = "LOOKUP";
299 public static final String MULTI_VALUE_LOOKUP = "MULTI_VALUE_LOOKUP";
300 public static final String QUESTION = "QUESTION";
301 }
302
303 public static final class HistoryFlow {
304 public static final String HISTORY_MANAGER = "historyManager";
305 public static final String FLOW = "flow";
306 public static final String START = "start";
307 public static final String RETURN_TO_START = "returnToStart";
308 public static final String SEPARATOR = "@@";
309 }
310
311 public static final class RoleTypes {
312 public static final String CONTROL = "Control";
313 public static final String INPUT_FIELD = "InputField";
314 }
315
316 public static final class DataAttributes {
317 public static final String TYPE = "type";
318 public static final String ROLE = "role";
319 public static final String ONCLICK = "onclick";
320 public static final String SUBMIT_DATA = "submit_data";
321 public static final String HAS_MESSAGES = "has_messages";
322 public static final String SERVER_MESSAGES = "server_messages";
323 public static final String VALIDATION_MESSAGES = "validation_messages";
324 public static final String GROUP_VALIDATION_DEFAULTS = "group_validation_defaults";
325 public static final String FIELD_VALIDATION_DEFAULTS = "field_validation_defaults";
326 public static final String MESSAGES_FOR = "messages_for";
327 public static final String PARENT = "parent";
328 public static final String SUMMARIZE = "summarize";
329 public static final String DISPLAY_MESSAGES = "displayMessages";
330 public static final String COLLAPSE_FIELD_MESSAGES = "collapseFieldMessages";
331 public static final String DISPLAY_LABEL = "displayLabel";
332 public static final String SHOW_PAGE_SUMMARY_HEADER = "showPageSummaryHeader";
333 public static final String DISPLAY_HEADER_SUMMARY = "displayHeaderSummary";
334 public static final String IS_TABLE_COLLECTION = "isTableCollection";
335 public static final String HAS_OWN_MESSAGES = "hasOwnMessages";
336 public static final String PAGE_LEVEL = "pageLevel";
337 public static final String FORCE_SHOW = "forceShow";
338 public static final String SECTIONS = "sections";
339 public static final String ORDER = "order";
340 public static final String SERVER_ERRORS = "serverErrors";
341 public static final String SERVER_WARNINGS = "serverWarnings";
342 public static final String SERVER_INFO = "serverInfo";
343 public static final String VIGNORE = "vignore";
344 public static final String TOTAL = "total";
345 public static final String SKIP_TOTAL = "skip_total";
346 public static final String LABEL = "label";
347 public static final String GROUP = "group";
348 public static final String LABEL_FOR = "label_for";
349 public static final String CONTROL_FOR = "control_for";
350 public static final String ADD_CONTROLS = "add_controls";
351 public static final String HEADER_FOR = "header_for";
352 public static final String STICKY_FOOTER = "sticky_footer";
353 public static final String DETAILS_DEFAULT_OPEN = "details_default_open";
354 public static final String TAB_FOR = "tabfor";
355 }
356
357 public static final class CaseConstraintOperators {
358 public static final String HAS_VALUE = "has_value";
359 public static final String EQUALS = "equals";
360 public static final String GREATER_THAN_EQUAL = "greater_than_equal";
361 public static final String LESS_THAN_EQUAL = "less_than_equal";
362 public static final String NOT_EQUAL = "not_equal";
363 public static final String NOT_EQUALS = "not_equals";
364 public static final String GREATER_THAN = "greater_than";
365 public static final String LESS_THAN = "less_than";
366 }
367
368 public static final class JsFunctions {
369 public static final String INITIALIZE_VIEW_STATE = "initializeViewState";
370 public static final String INITIALIZE_SESSION_TIMERS = "initializeSessionTimers";
371 public static final String SET_CONFIG_PARM = "setConfigParam";
372 }
373
374 public static final String EVENT_NAMESPACE = "uif";
375
376 public static final class JsEvents {
377 public static final String DIALOG_RESPONSE = "dialogresponse." + EVENT_NAMESPACE;
378 public static final String SHOW_DIALOG = "showdialog." + EVENT_NAMESPACE;
379 }
380
381 public static final class ConfigProperties {
382 public static final String KRAD_IMAGES_URL = "krad.externalizable.images.url";
383 public static final String KRAD_URL = "krad.url";
384 }
385
386 public static final class FileExtensions {
387 public static final String CSS = ".css";
388 public static final String JS = ".js";
389 public static final String MIN = ".min";
390 }
391
392 }