001 /**
002 * Copyright 2005-2011 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 DEFAULT_VIEW_NAME = "default";
027 public static final String SPRING_VIEW_ID = "ApplicationView";
028 public static final String SPRING_REDIRECT_ID = "redirectURL";
029
030 public static enum Position {
031 BOTTOM, LEFT, RIGHT, TOP
032 }
033
034 public static enum Order {
035 FIRST
036 }
037
038 public static enum NavigationType {
039 VERTICAL_MENU, HORIZONTAL_TABS
040 }
041
042 public static enum Orientation {
043 HORIZONTAL, VERTICAL
044 }
045
046 public static enum MessageType {
047 NORMAL, INSTRUCTIONAL, CONSTRAINT, REQUIRED, HELP_SUMMARY, HELP_DESCRIPTION
048 }
049
050 public static enum ViewType {
051 DEFAULT, DOCUMENT, INQUIRY, LOOKUP, MAINTENANCE, INCIDENT;
052 }
053
054 public static enum ControlType {
055 CHECKBOX, CHECKBOXGROUP, FILE, GROUP, HIDDEN, RADIOGROUP, SELECT,
056 TEXTAREA, TEXT, USER
057 }
058
059 public static enum WorkflowAction {
060 SAVE, ROUTE, BLANKETAPPROVE, APPROVE, DISAPPROVE, CANCEL, FYI, ACKNOWLEDGE
061 }
062
063 public static class MethodToCallNames {
064 public static final String NAVIGATE = "navigate";
065 public static final String START = "start";
066 public static final String SAVE = "save";
067 public static final String SEARCH = "search";
068 public static final String CLOSE = "close";
069 public static final String ADD_LINE = "addLine";
070 public static final String DELETE_LINE = "deleteLine";
071 public static final String REFRESH = "refresh";
072 public static final String CANCEL = "cancel";
073 public static final String UPDATE_COMP = "updateComponent";
074 public static final String TOGGLE_INACTIVE = "toggleInactiveRecordDisplay";
075 }
076
077 public static class ActionEvents {
078 public static final String ADD_LINE = "addLine";
079 }
080
081 public static class LayoutComponentOptions {
082 public static final String COLUMN_SPAN = "colSpan";
083 public static final String ROW_SPAN = "rowSpan";
084 }
085
086 public static class IdSuffixes {
087 public static final String ADD_LINE = "_add";
088 public static final String ATTRIBUTE = "_attribute";
089 public static final String COMPARE = "_comp";
090 public static final String CONSTRAINT = "_constraint";
091 public static final String DIRECT_INQUIRY = "_directinquiry";
092 public static final String DIV = "_div";
093 public static final String ERRORS = "_errors";
094 public static final String INSTRUCTIONAL = "_instructional";
095 public static final String LINE = "_line";
096 public static final String LABEL = "_label";
097 public static final String SUB = "_sub";
098 public static final String SUGGEST = "_suggest";
099 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 }