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