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.uif.control;
17
18 import org.kuali.rice.krad.uif.widget.DatePicker;
19
20 /**
21 * Interface representing a text input control component.
22 *
23 * @author Kuali Rice Team (rice.collab@kuali.org)
24 */
25 public interface TextControl extends Control {
26
27 /**
28 * Gets the date picker widget, if applicable.
29 *
30 * @return date picker, null if not a date input field
31 */
32 DatePicker getDatePicker();
33
34 /**
35 * Gets the size of the text input.
36 *
37 * @return text input size
38 */
39 int getSize();
40
41 /**
42 * Gets the min length of the text input.
43 *
44 * @return min length
45 */
46 Integer getMinLength();
47
48 /**
49 * Gets the max length of the text input.
50 *
51 * @return max length
52 */
53 Integer getMaxLength();
54
55 /**
56 * Indicates if the text expand popup should be used.
57 *
58 * @return true if the text expand popup should be used
59 */
60 boolean isTextExpand();
61
62 /**
63 * Gets the watermark text.
64 *
65 * @return watermark text
66 */
67 String getWatermarkText();
68
69 /**
70 * Setter for {@link #getMaxLength()}
71 *
72 * @param maxLength property value
73 */
74 void setMaxLength(Integer maxLength);
75
76 /**
77 * Setter for {@link #getSize()}
78 *
79 * @param size property value
80 */
81 void setSize(int size);
82
83 /**
84 * Setter for {@link #isTextExpand()}
85 *
86 * @param b property value
87 */
88 void setTextExpand(boolean b);
89
90 /**
91 * Setter for {@link #getMinLength()}
92 *
93 * @param minLength property value
94 */
95 void setMinLength(Integer minLength);
96
97 /**
98 * Setter for {@link #getWatermarkText()}
99 *
100 * @param watermark property value
101 */
102 void setWatermarkText(String watermark);
103
104 }