/*

  * Copyright 2007 The Kuali Foundation

  *

  * Licensed under the Educational Community License, Version 1.0 (the "License");

  * you may not use this file except in compliance with the License.

  * You may obtain a copy of the License at

  *

  * http://www.opensource.org/licenses/ecl1.php

  *

  * Unless required by applicable law or agreed to in writing, software

  * distributed under the License is distributed on an "AS IS" BASIS,

  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  * See the License for the specific language governing permissions and

  * limitations under the License.

  */

 package org.kuali.rice.kns.uif.control;

 import java.util.List;

 import org.apache.commons.lang.StringUtils;

 import org.kuali.rice.kns.uif.container.View;

 import org.kuali.rice.kns.uif.core.Component;

 import org.kuali.rice.kns.uif.field.AttributeField;

 import org.kuali.rice.kns.uif.widget.DatePicker;

 /**

  * Represents a HTML Text control, generally rendered as a input field of type

  * 'text'. This can display and receive a single value

  * 

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 public class TextControl extends ControlBase {

         private static final long serialVersionUID = -8267606288443759880L;

         private int size;

     private Integer maxLength;

     private Integer minLength;

         private DatePicker datePicker;

         private String watermarkText = StringUtils.EMPTY;

         private boolean textExpand;

         public TextControl() {

                 super();

         }

         /**

          * @see org.kuali.rice.kns.uif.core.ComponentBase#getNestedComponents()

          */

         @Override

         public List<Component> getNestedComponents() {

                 List<Component> components = super.getNestedComponents();

                 components.add(datePicker);

                 return components;

         }

     /**

      * The following actions are performed:

      *

      * <ul>

      * <li>Defaults maxLength, minLength (if not set) to maxLength of parent field</li>

      * </ul>

      *

      * @see org.kuali.rice.kns.uif.core.ComponentBase#performFinalize(org.kuali.rice.kns.uif.container.View,

      *      java.lang.Object, org.kuali.rice.kns.uif.core.Component)

      */

     @Override

     public void performFinalize(View view, Object model, Component parent) {

         super.performFinalize(view, model, parent);

         if (parent instanceof AttributeField) {

             AttributeField field = (AttributeField) parent;

             if (getMaxLength() == null) {

                 setMaxLength(field.getMaxLength());

             }

             if (getMinLength() == null) {

                 setMinLength(field.getMinLength());

             }

         }

     }

     /**

          * Horizontal display size of the control (in number of characters)

          * 

          * @return int size

          */

         public int getSize() {

                 return this.size;

         }

     /**

      * Setter for the horizontal display size

      *

      * @param size

      */

     public void setSize(int size) {

         this.size = size;

     }

     /**

      * Maximum number of characters that can be inputted

      *

      * <p>If not set on control, max length of field will be used</p>

      *

      * @return int max number of characters

      */

     public Integer getMaxLength() {

         return maxLength;

     }

     /**

      * Setter for the max number of input characters

      *

      * @param maxLength

      */

     public void setMaxLength(Integer maxLength) {

         this.maxLength = maxLength;

     }

     /**

      * Minimum number of characters that can be inputted

      *

      * <p>If not set on control, min length of field will be used</p>

      *

      * @return int max number of characters

      */

     public Integer getMinLength() {

         return minLength;

     }

     /**

      * Setter for the min number of input characters

      *

      * @param maxLength

      */

     public void setMinLength(Integer minLength) {

         this.minLength = minLength;

     }

     /**

          * Renders a calendar that can be used to select a date value for the text

          * control. The <code>Calendar</code> instance contains configuration such

          * as the date format string

          * 

          * @return Calendar

          */

         public DatePicker getDatePicker() {

                 return this.datePicker;

         }

         public void setDatePicker(DatePicker datePicker) {

                 this.datePicker = datePicker;

         }

         /**

          * @return the watermarkText

          */

         public String getWatermarkText() {

                 return this.watermarkText;

         }

         /**

          * @param watermarkText the watermarkText to set

          */

         public void setWatermarkText(String watermarkText) {

                 //to avoid users from putting in the same value as the watermark adding some spaces here

                 //see watermark troubleshooting for more info

                 if (StringUtils.isNotEmpty(watermarkText)) {

                         watermarkText = watermarkText + "   ";

                 }

                 this.watermarkText = watermarkText;

         }

     /**

      * If set to true, this control will have a button which can be clicked to expand the text area through

      * a popup window so the user has more space to type and see the data they are entering in this text field

      *

      * @return the textExpand

      */

     public boolean isTextExpand() {

         return this.textExpand;

     }

     /**

      * @param textExpand the textExpand to set

      */

     public void setTextExpand(boolean textExpand) {

         this.textExpand = textExpand;

     }

 }