com.ibm.as400.util.html
Class CheckboxFormInput

java.lang.Object
  extended by com.ibm.as400.util.html.HTMLTagAttributes
      extended by com.ibm.as400.util.html.FormInput
          extended by com.ibm.as400.util.html.ToggleFormInput
              extended by com.ibm.as400.util.html.CheckboxFormInput
All Implemented Interfaces:
HTMLTagElement, Serializable

public class CheckboxFormInput
extends ToggleFormInput

The CheckboxFormInput class represents a checkbox input type in an HTML form where the checkbox represents an n-of-many choice field. The trailing slash "/" on the CheckboxFormInput tag allows it to conform to the XHTML specification.

Here is an example of a CheckboxFormInput tag:
<input type="checkbox" name="uscitizen" value="yes" checked="checked" /> textLabel

See Also:
Serialized Form

Constructor Summary
CheckboxFormInput()
          Constructs a default CheckboxFormInput object.
CheckboxFormInput(String label, boolean checked)
          Constructs a CheckboxFormInput object with the specified viewable text label and initial checked value.
CheckboxFormInput(String name, String value, String label, boolean checked)
          Constructs a CheckboxFormInput object with the specified control name, initial input value, viewable text label, and initial checked value.
 
Method Summary
 String getFOTag()
          Returns a comment tag.
 String getTag()
          Returns the tag for the checkbox form input type.
 
Methods inherited from class com.ibm.as400.util.html.ToggleFormInput
getLabel, isChecked, setChecked, setLabel
 
Methods inherited from class com.ibm.as400.util.html.FormInput
addVetoableChangeListener, getDirection, getLanguage, getName, getSize, getValue, removeVetoableChangeListener, setDirection, setLanguage, setName, setSize, setValue, toString
 
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
 

Constructor Detail

CheckboxFormInput

public CheckboxFormInput()
Constructs a default CheckboxFormInput object.


CheckboxFormInput

public CheckboxFormInput(String label,
                         boolean checked)
Constructs a CheckboxFormInput object with the specified viewable text label and initial checked value.

Parameters:
label - The viewable text label.
checked - If the checkbox initializes to checked.

CheckboxFormInput

public CheckboxFormInput(String name,
                         String value,
                         String label,
                         boolean checked)
Constructs a CheckboxFormInput object with the specified control name, initial input value, viewable text label, and initial checked value.

Parameters:
name - The control name of the input field.
value - The input value used when the field is submitted.
label - The viewable text label.
checked - If the checkbox initializes to checked.
Method Detail

getFOTag

public String getFOTag()
Returns a comment tag. This method should not be called. There is no XSL-FO support for this class.

Returns:
The comment tag.

getTag

public String getTag()
Returns the tag for the checkbox form input type.

Returns:
The tag.