View Javadoc

1   /*
2    * Copyright 2007 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 1.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/ecl1.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.kns.uif;
17  
18  
19  /**
20   * General constants used within the User Interface Framework
21   * 
22   * @author Kuali Rice Team (rice.collab@kuali.org)
23   */
24  public class UifConstants {
25  	private static final long serialVersionUID = 3935664282036793486L;
26  
27  	public static final String CONTROLLER_METHOD_DISPATCH_PARAMETER_NAME = "methodToCall";
28  
29  	public static final String DEFAULT_MODEL_NAME = "KualiForm";
30  	public static final String DEFAULT_VIEW_NAME = "default";
31  	public static final String SPRING_VIEW_ID = "ApplicationView";
32  
33  	public static class Position {
34  		public static final String BOTTOM = "BOTTOM";
35  		public static final String LEFT = "LEFT";
36  		public static final String RIGHT = "RIGHT";
37  		public static final String TOP = "TOP";
38  	}
39  	
40  	public static class Order {
41  	    public static final String FIRST = "FIRST";
42  	}
43  
44  	public static class NavigationType {
45  		public static final String VERTICAL_MENU = "VERTICAL_MENU";
46  		public static final String HORIZONTAL_TABS = "HORIZONTAL_TABS";
47  	}
48  
49  	public static class Orientation {
50  		public static final String HORIZONTAL = "HORIZONTAL";
51  		public static final String VERTICAL = "VERTICAL";
52  	}
53  
54  	public static class MessageType {
55  		public static final String NORMAL = "NORMAL";
56  		public static final String SUMMARY = "SUMMARY";
57  		public static final String CONSTRAINT = "CONSTRAINT";
58  		public static final String REQUIRED = "REQUIRED";
59  	}
60  
61  	public static class ViewType {
62  		public static final String DEFAULT = "DEFAULT";
63  		public static final String INQUIRY = "INQUIRY";
64  		public static final String LOOKUP = "LOOKUP";
65  		public static final String MAINTENANCE = "MAINTENANCE";
66  		public static final String TRANSACTIONAL = "TRANSACTIONAL";
67  	}
68  
69  	public static class MethodToCallNames {
70  		public static final String NAVIGATE = "navigate";
71  		public static final String START = "start";
72  		public static final String SAVE = "save";
73  		public static final String SEARCH = "search";
74  		public static final String CLOSE = "close";
75  		public static final String ADD_LINE = "addLine";
76  		public static final String DELETE_LINE = "deleteLine";
77  		public static final String REFRESH = "refresh";
78  		public static final String CANCEL = "cancel";
79  		public static final String UPDATE_COMP = "updateComponent";
80  	}
81  
82  	public static class LayoutComponentOptions {
83  		public static final String COLUMN_SPAN = "colSpan";
84  		public static final String ROW_SPAN = "rowSpan";
85  	}
86  
87  	public static class IdSuffixes {
88  		public static final String ADD_LINE = "_addLine";
89  		public static final String ATTRIBUTE = "_attribute";
90  		public static final String CONSTRAINT = "_constraint";
91  		public static final String DIV = "_div";
92  		public static final String ERRORS = "_errors";
93  		public static final String LABEL = "_label";
94  		public static final String SUMMARY = "_summary";
95  		public static final String QUICK_FINDER = "_quickfinder";
96  	}
97  
98  	public static class ViewPhases {
99  		public static final String INITIALIZE = "INITIALIZE";
100 		public static final String APPLY_MODEL = "APPLY_MODEL";
101 		public static final String FINALIZE = "FINALIZE";
102 	}
103 
104 	public static class ViewStatus {
105 		public static final String CREATED = "C";
106 		public static final String INITIALIZED = "I";
107 		public static final String FINAL = "F";
108 	}
109 
110 	public static final String EL_PLACEHOLDER_PREFIX = "@{";
111 	public static final String EL_PLACEHOLDER_SUFFIX = "}";
112 	public static final String EL_CONDITIONAL_PROPERTY_PREFIX = "conditional";
113     public static final String NO_BIND_ADJUST_PREFIX = "form:";
114 
115 	public static class ContextVariableNames {
116         public static final String COLLECTION_GROUP = "collectionGroup";
117 		public static final String CONFIG_PROPERTIES = "ConfigProperties";
118 		public static final String COMPONENT = "component";
119 		public static final String CONSTANTS = "Constants";
120 		public static final String DOCUMENT_ENTRY = "DocumentEntry";
121 		public static final String INDEX = "index";
122 		public static final String IS_ADD_LINE = "isAddLine";
123 		public static final String LINE = "line";
124 		public static final String MANAGER = "manager";
125         public static final String NODE = "node";
126 		public static final String PARENT = "parent";
127 		public static final String VIEW = "view";
128 	}
129 
130 	public static class TableToolsKeys{
131 		public static final String SDOM = "sDom";
132 		public static final String LANGUAGE = "oLanguage";
133 		public static final String EMPTY_TABLE = "sEmptyTable";
134 		public static final String AO_COLUMNS = "aoColumns";
135 		public static final String SORT_SKIP_ROWS = "aiSortingSkipRows";
136 		public static final String SORT_DATA_TYPE = "sSortDataType";
137 		public static final String SORTABLE = "bSortable";
138 		public static final String SORT_TYPE = "sType";
139 		public static final String TABLE_SORT = "bSort";
140 	}
141 	
142 	public static class TableToolsValues{
143 		public static final String DOM_TEXT = "dom-text";
144 		public static final String NUMERIC = "numeric";
145 		public static final String DATE = "kuali_date";
146 		public static final int ADD_ROW_DEFAULT_INDEX = 0;
147 	}
148 	
149 	public static class TitleAppendTypes{
150         public static final String DASH = "dash";
151         public static final String PARENTHESIS = "parenthesis";
152         public static final String REPLACE = "replace";
153         public static final String NONE = "none";
154     }
155 	
156     public static class UrlParams {
157         public static final String SHOW_HISTORY = "showHistory";
158         public static final String SHOW_HOME = "showHome";
159         public static final String FORM_KEY = "formKey";
160         public static final String PAGE_ID = "pageId";
161         public static final String HISTORY = "history";
162     }
163 
164     public static class MessageKeys {
165        public static final String QUERY_DATA_NOT_FOUND = "query.dataNotFound";
166     }
167 }