1 /**
2 * Copyright 2005-2012 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.apache.commons.lang.StringUtils;
19 import org.kuali.rice.krad.uif.field.InputField;
20 import org.kuali.rice.krad.uif.view.View;
21 import org.kuali.rice.krad.uif.component.Component;
22
23 /**
24 * Represents a HTML TextArea control. Generally used for values that are very
25 * large (such as a description)
26 *
27 * @author Kuali Rice Team (rice.collab@kuali.org)
28 */
29 public class TextAreaControl extends ControlBase {
30 private static final long serialVersionUID = -4664558047325456844L;
31
32 private int rows;
33 private int cols;
34 private Integer maxLength;
35 private Integer minLength;
36
37 private boolean textExpand;
38 private String watermarkText = StringUtils.EMPTY;
39
40 public TextAreaControl() {
41 super();
42 }
43
44 /**
45 * The following actions are performed:
46 *
47 * <ul>
48 * <li>Defaults maxLength, minLength (if not set) to maxLength of parent field</li>
49 * </ul>
50 *
51 * @see org.kuali.rice.krad.uif.component.ComponentBase#performFinalize(org.kuali.rice.krad.uif.view.View,
52 * java.lang.Object, org.kuali.rice.krad.uif.component.Component)
53 */
54 @Override
55 public void performFinalize(View view, Object model, Component parent) {
56 super.performFinalize(view, model, parent);
57
58 if (parent instanceof InputField) {
59 InputField field = (InputField) parent;
60 if (getMaxLength() == null) {
61 setMaxLength(field.getMaxLength());
62 }
63
64 if (getMinLength() == null) {
65 setMinLength(field.getMinLength());
66 }
67 }
68 }
69
70 /**
71 * Number of rows the control should span (horizontal length)
72 *
73 * @return int number of rows
74 */
75 public int getRows() {
76 return this.rows;
77 }
78
79 /**
80 * Setter for the number of rows the control should span (horizontal length)
81 *
82 * @param rows
83 */
84 public void setRows(int rows) {
85 this.rows = rows;
86 }
87
88 /**
89 * Number of columns the control should span (vertical length)
90 *
91 * @return int number of columns
92 */
93 public int getCols() {
94 return this.cols;
95 }
96
97 /**
98 * Setter for the number of columns the control should span (vertical length)
99 *
100 * @param cols
101 */
102 public void setCols(int cols) {
103 this.cols = cols;
104 }
105
106 /**
107 * Maximum number of characters that can be inputted
108 *
109 * <p>If not set on control, max length of field will be used</p>
110 *
111 * @return int max number of characters
112 */
113 public Integer getMaxLength() {
114 return maxLength;
115 }
116
117 /**
118 * Setter for the max number of input characters
119 *
120 * @param maxLength
121 */
122 public void setMaxLength(Integer maxLength) {
123 this.maxLength = maxLength;
124 }
125
126 /**
127 * Minimum number of characters that can be inputted
128 *
129 * <p>If not set on control, min length of field will be used</p>
130 *
131 * @return int max number of characters
132 */
133 public Integer getMinLength() {
134 return minLength;
135 }
136
137 /**
138 * Setter for the min number of input characters
139 *
140 * @param minLength
141 */
142 public void setMinLength(Integer minLength) {
143 this.minLength = minLength;
144 }
145
146 /**
147 * @return the watermarkText
148 */
149 public String getWatermarkText() {
150 return this.watermarkText;
151 }
152
153 /**
154 * @param watermarkText the watermarkText to set
155 */
156 public void setWatermarkText(String watermarkText) {
157 //to avoid users from putting in the same value as the watermark adding some spaces here
158 //see watermark troubleshooting for more info
159 if (StringUtils.isNotEmpty(watermarkText)) {
160 watermarkText = watermarkText + " ";
161 }
162 this.watermarkText = watermarkText;
163 }
164
165 /**
166 * If set to true, this control will have a button which can be clicked to expand the text area through
167 * a popup window so the user has more space to type and see the data they are entering in this text field
168 *
169 * @return the textExpand
170 */
171 public boolean isTextExpand() {
172 return this.textExpand;
173 }
174
175 /**
176 * Setter for the text expand flag
177 *
178 * @param textExpand the textExpand to set
179 */
180 public void setTextExpand(boolean textExpand) {
181 this.textExpand = textExpand;
182 }
183 }