src.com.ibm.as400.util.html.TextFormInput Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jt400-jdk9 Show documentation
The Open Source version of the IBM Toolbox for Java
There is a newer version: 11.1
///////////////////////////////////////////////////////////////////////////////
//                                                                             
// JTOpen (IBM Toolbox for Java - OSS version)                                 
//                                                                             
// Filename: TextFormInput.java
//                                                                             
// The source code contained herein is licensed under the IBM Public License   
// Version 1.0, which has been approved by the Open Source Initiative.         
// Copyright (C) 1997-2001 International Business Machines Corporation and     
// others. All rights reserved.                                                
//                                                                             
///////////////////////////////////////////////////////////////////////////////

package com.ibm.as400.util.html;

import com.ibm.as400.access.Trace;
import com.ibm.as400.access.ExtendedIllegalStateException;
import com.ibm.as400.access.ExtendedIllegalArgumentException;

import java.beans.PropertyVetoException;

/**
*  The TextFormInput class represents a single line text input type in 
*  an HTML form.  The trailing slash "/" on the TextFormInput tag 
*  allows it to conform to the XHTML specification.
*  
*  Here is an example of a TextFormInput tag:

*  <input type="text" name="userID" size="40" />
*
*  
TextFormInput objects generate the following events:
*  

*  PropertyChangeEvent
*  
VetoableChangeEvent
*  
**/
public class TextFormInput extends FormInput
{
  private static final String copyright = "Copyright (C) 1997-2001 International Business Machines Corporation and others.";
  static final long serialVersionUID = 2550648845459385938L;

    private int maxLength_;    // The maximum length of the text field.


    /**
    *  Constructs a default TextFormInput object.  There is no initial
    *  limit on the maximum number of characters permitted in the text 
    *  field.
    **/
    public TextFormInput()
    {
        super();
        maxLength_ = -1;             // no limit

    }

    /**
    *  Constructs a TextFormInput object with the specified control name.
    *  There is no initial limit on the maximum number of characters 
    *  permitted in the text field.
    *
    *  @param name The control name of the input field.
    **/
    public TextFormInput(String name)
    {
        super(name);
        maxLength_ = -1;            // no limit
    }

    /**
    *  Constructs a TextFormInput object with the specified control name and
    *  initial input value.  There is no initial limit on the maximum number of 
    *  characters permitted in the text field.
    *
    *  @param name The control name of the input field.
    *  @param value The initial value of the input field.
    **/
    public TextFormInput(String name, String value)
    {
        super(name, value);
        maxLength_ = -1;            // no limit
    }

    /**
    *  Returns the maximum number of characters permitted in the text field.
    *  A value of -1 indicates that there is no limit.
    *  @return The maximum length.
    **/
    public int getMaxLength()
    {
        return maxLength_;
    }

    /**
    *  Returns the max length attribute tag.
    *  @return The tag.
    **/
    String getMaxLengthAttributeTag()
    {
        if (maxLength_ > 0)
            return " maxlength=\"" + maxLength_ + "\"";
        else
            return "";
    }

    /**
    *  Returns a comment tag.
    *  This method should not be called.  There is no XSL-FO support for this class.
    *  @return The comment tag.
    **/
    public String getFOTag()                                                //@D1A
    {
        Trace.log(Trace.ERROR, "Attempting to getFOTag() for an object that doesn't support it.");
        return "";
    }

    /**
    *  Returns the tag for the text form input type.
    *  @return The tag.
    **/
    public String getTag()
    {
        //@C1D

        if (getName() == null)
        {
            Trace.log(Trace.ERROR, "Attempting to get tag before setting name.");
            throw new ExtendedIllegalStateException(
                                                   "name", ExtendedIllegalStateException.PROPERTY_NOT_SET );
        }

        StringBuffer s = new StringBuffer("");

        return s.toString();
    }


    /**
    *  Sets the maximum number of characters permitted in the text field.
    *  @param length The maximum length.
    *
    *  @exception PropertyVetoException If a change is vetoed.
    **/
    public void setMaxLength(int length)
    throws PropertyVetoException
    {
        if (length < 0)
            throw new ExtendedIllegalArgumentException("maxLength", ExtendedIllegalArgumentException.RANGE_NOT_VALID);

        int old = maxLength_;
        if (vetos_ != null) vetos_.fireVetoableChange("maxLength", new Integer(old), new Integer(length) ); //@CRS

        maxLength_ = length;

        if (changes_ != null) changes_.firePropertyChange("maxLength", new Integer(old), new Integer(length) ); //@CRS
    }
}