1 /**
2 * Copyright 2005-2014 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.datadictionary.control;
17
18 import org.kuali.rice.krad.datadictionary.DataDictionaryDefinition;
19
20 /**
21 * ControlDefinition
22 *
23 *
24 */
25 @Deprecated
26 public interface ControlDefinition extends DataDictionaryDefinition {
27
28 public boolean isDatePicker();
29 public void setDatePicker(boolean datePicker);
30
31 public boolean isExpandedTextArea();
32 public void setExpandedTextArea(boolean eTextArea);
33
34 /**
35 * @return true if this ControlDefinition instance represents an HTML checkbox control
36 */
37 public boolean isCheckbox();
38
39 /**
40 * @return true if this ControlDefinition instance represents an HTML hidden control
41 */
42 public boolean isHidden();
43
44 /**
45 * @return true if this ControlDefinition instance represents an HTML radiobutton control
46 */
47 public boolean isRadio();
48
49 /**
50 * @return true if this ControlDefinition instance represents an HTML select control
51 */
52 public boolean isSelect();
53
54 /**
55 * @return true if this ControlDefinition instance represents an HTML select control
56 */
57 public boolean isMultiselect();
58
59 /**
60 * @return true if this ControlDefinition instance represents an HTML text control
61 */
62 public boolean isText();
63
64 /**
65 * @return true if this ControlDefinition instance represents an HTML textarea control
66 */
67 public boolean isTextarea();
68
69 /**
70 *
71 * @return any Script associated with this control
72 */
73 public String getScript();
74
75 /**
76 * @return true if the ControlDefinition instance represents a currency control
77 */
78 public boolean isCurrency();
79
80 /**
81 *
82 * @return true if the ControlDefinition instance represents a kualiUser control
83 */
84 public boolean isKualiUser();
85
86 /**
87 * @return true if the ControlDefinition instance represents a workflow workgroup control
88 */
89 public boolean isWorkflowWorkgroup();
90
91 /**
92 * @return true if this ControlDefinition instance represents an HTML File control
93 */
94 public boolean isFile();
95
96 /**
97 * @return true if the ControlDefinition instance represents a lookupHidden control
98 */
99 public boolean isLookupHidden();
100
101 /**
102 * @return true if the ControlDefinition instance represents a lookupReadonly control
103 */
104 public boolean isLookupReadonly();
105
106 /**
107 * @return true if the ControlDefinition instance represents a button control
108 */
109 public boolean isButton();
110
111 /**
112 * @return true if the ControlDefinition instance represents a link control
113 */
114 public boolean isLink();
115
116 /**
117 * @return true if the ControlDefinition instance represents a ranged (will render from and to fields) date control
118 */
119 public boolean isRanged();
120
121 /**
122 * Sets the Class used to retrieve the complete range of values for radiobutton and select controls.
123 *
124 * @param valuesFinderClass
125 */
126 public void setValuesFinderClass(String valuesFinderClass);
127
128 /**
129 * Sets the BO Class used for the KeyLabelBusinessObjectValueFinder to retrieve the complete range of values for radiobutton and select controls.
130 *
131 * @param businessObjectClass
132 */
133 public void setBusinessObjectClass(String businessObjectClass);
134
135
136 /**
137 * Sets the keyAttribute used for building radiobutton and select controls.
138 *
139 * @param keyAttribute
140 */
141 public void setKeyAttribute(String keyAttribute);
142
143 /**
144 * Sets the labelAttribute used for building radiobutton and select controls.
145 *
146 * @param labelAttribute
147 */
148 public void setLabelAttribute(String labelAttribute);
149
150 public void setIncludeBlankRow(Boolean includeBlankRow);
151
152 /**
153 * @param includeKeyInLabel whether to include the key with the label to be displayed or not.
154 */
155 public void setIncludeKeyInLabel(Boolean includeKeyInLabel);
156
157 /**
158 * Sets the Script
159 *
160 * @param script
161 */
162 public void setScript(String script);
163
164 /**
165 * @return Class used to retrieve the complete range of values for radiobutton and select controls.
166 */
167 public String getValuesFinderClass();
168
169 /**
170 * @return BO Class used for the KeyLabelBusinessObjectValueFinder to retrieve the complete range of values for radiobutton and select controls.
171 */
172 public String getBusinessObjectClass();
173
174 /**
175 * @return the keyAttribute used for radiobutton and select controls.
176 */
177 public String getKeyAttribute();
178
179 /**
180 * @return the labelAttribute used for radiobutton and select controls.
181 */
182 public String getLabelAttribute();
183
184 public Boolean getIncludeBlankRow();
185
186 /**
187 * Gets the flag that indicates if the labels the ValuesFinder class returns should include the key.
188 *
189 * @param includeKeyInLabel
190 */
191 public Boolean getIncludeKeyInLabel();
192
193 /**
194 * Sets the size parameter for text controls.
195 *
196 * @param size
197 */
198 public void setSize(Integer size);
199
200 /**
201 * @return size parameters for text controls
202 */
203 public Integer getSize();
204
205 /**
206 * Sets the rows parameter for textarea controls.
207 *
208 * @param rows
209 */
210 public void setRows(Integer rows);
211
212 /**
213 * @return rows parameters for textarea controls
214 */
215 public Integer getRows();
216
217 /**
218 * Sets the cols parameter for textarea controls.
219 *
220 * @param cols
221 */
222 public void setCols(Integer cols);
223
224 /**
225 * @return cols parameter for textarea controls.
226 */
227 public Integer getCols();
228
229 }