com.ibm.as400.util.html

Class FormInput

java.lang.Object

com.ibm.as400.util.html.HTMLTagAttributes

com.ibm.as400.util.html.FormInput

All Implemented Interfaces:

HTMLTagElement, Serializable

Direct Known Subclasses:

ButtonFormInput, FileFormInput, HiddenFormInput, ImageFormInput, ResetFormInput, SubmitFormInput, TextFormInput, ToggleFormInput

public abstract class FormInput
extends HTMLTagAttributes
implements Serializable

The FormInput class represents an input element in an HTML form.

FormInput objects generate the following events:

• PropertyChangeEvent
• VetoableChangeEvent

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FormInput() Constructs a default FormInput object.
FormInput(String name) Constructs a FormInput object with the specified control name.
FormInput(String name, String value) Constructs a FormInput object with the specified controal name and the initial input value.

Method Summary

Methods

Modifier and Type	Method and Description
void	addVetoableChangeListener(VetoableChangeListener listener) Adds the VetoableChangeListener.
String	getDirection() Returns the direction of the text interpretation.
String	getLanguage() Returns the language of the input element.
String	getName() Returns the control name of the input field.
int	getSize() Returns the size of the input field.
String	getValue() Returns the initial value of the input field.
void	removeVetoableChangeListener(VetoableChangeListener listener) Removes the VetoableChangeListener from the internal list.
void	setDirection(String dir) Sets the direction of the text interpretation.
void	setLanguage(String lang) Sets the language of the input tag.
void	setName(String name) Sets the control name of the input field.
void	setSize(int size) Sets the size of the input field.
void	setValue(String value) Sets the initial value of the input field.
String	toString() Returns a String representation for the form input tag.

Methods inherited from class com.ibm.as400.util.html.HTMLTagAttributes

addPropertyChangeListener, getAttributes, getAttributeString, removePropertyChangeListener, setAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.as400.util.html.HTMLTagElement

getFOTag, getTag

Constructor Detail

FormInput

public FormInput()

Constructs a default FormInput object.

FormInput

public FormInput(String name)

Constructs a FormInput object with the specified control name.

Parameters:

name - The control name of the input field.

FormInput

public FormInput(String name,
         String value)

Constructs a FormInput object with the specified controal name and the initial input value.

Parameters:

name - The control name of the input field.

value - The initial value of the input field.

Method Detail

addVetoableChangeListener

public void addVetoableChangeListener(VetoableChangeListener listener)

Adds the VetoableChangeListener. The specified VetoableChangeListener's vetoableChange method will be called each time the value of any constrained property is changed.

Parameters:

listener - The VetoableChangeListener.

See Also:

removeVetoableChangeListener(java.beans.VetoableChangeListener)

getDirection

public String getDirection()

Returns the direction of the text interpretation.

Returns:

The direction of the text.

getLanguage

public String getLanguage()

Returns the language of the input element.

Returns:

The language of the input element.

getName

public String getName()

Returns the control name of the input field.

Returns:

The control name of the input field.

getValue

public String getValue()

Returns the initial value of the input field.

Returns:

The initial value.

getSize

public int getSize()

Returns the size of the input field. The size refers to the width of the input field in pixels or characters.

Returns:

The field size.

removeVetoableChangeListener

public void removeVetoableChangeListener(VetoableChangeListener listener)

Removes the VetoableChangeListener from the internal list. If the VetoableChangeListener is not on the list, nothing is done.

Parameters:

listener - The VetoableChangeListener.

See Also:

addVetoableChangeListener(java.beans.VetoableChangeListener)

setDirection

public void setDirection(String dir)
                  throws PropertyVetoException

Sets the direction of the text interpretation.

Parameters:

dir - The direction. One of the following constants defined in HTMLConstants: LTR or RTL.

Throws:

PropertyVetoException - If a change is vetoed.

See Also:

HTMLConstants

setLanguage

public void setLanguage(String lang)
                 throws PropertyVetoException

Sets the language of the input tag.

Parameters:

lang - The language. Example language tags include: en and en-US.

Throws:

PropertyVetoException - If a change is vetoed.

setName

public void setName(String name)
             throws PropertyVetoException

Sets the control name of the input field.

Parameters:

name - The control name of the input field.

Throws:

PropertyVetoException - If a change is vetoed.

setSize

public void setSize(int size)
             throws PropertyVetoException

Sets the size of the input field. The size refers to the width of the input field in pixels or characters according to its type.

Parameters:

size - The field size.

Throws:

PropertyVetoException - If a change is vetoed.

setValue

public void setValue(String value)
              throws PropertyVetoException

Sets the initial value of the input field.

Parameters:

value - The initial input value.

Throws:

PropertyVetoException - If a change is vetoed.

toString

public String toString()

Returns a String representation for the form input tag.

Overrides:

toString in class Object

Returns:

The tag.