com.ibm.as400.util.html
Class RadioFormInputGroup
- java.lang.Object
-
- com.ibm.as400.util.html.HTMLTagAttributes
-
- com.ibm.as400.util.html.RadioFormInputGroup
-
- All Implemented Interfaces:
- HTMLTagElement, java.io.Serializable
public class RadioFormInputGroup extends HTMLTagAttributes implements java.io.Serializable
The RadioFormInputGroup class represents a group of RadioFormInput objects. Only one RadioFormInput object can be checked in the group. The trailing slash "/" on the RadioFormInputGroup tag allows it to conform to the XHTML specification.This example creates a radio button group and prints out the tag.
// Create some radio buttons. RadioFormInput radio0 = new RadioFormInput("age", "kid", "0-12", true); RadioFormInput radio1 = new RadioFormInput("age", "teen", "13-19", false); RadioFormInput radio2 = new RadioFormInput("age", "twentysomething", "20-29", false); RadioFormInput radio3 = new RadioFormInput("age", "thirtysomething", "30-39", false); // Create a radio button group and add the radio buttons. RadioFormInputGroup ageGroup = new RadioFormInputGroup("age"); ageGroup.add(radio0); ageGroup.add(radio1); ageGroup.add(radio2); ageGroup.add(radio3); System.out.println(ageGroup.getTag());
Here is the output of the RadioFormInputGroup tag:
<input type="radio" name="age" value="kid" checked="checked" /> 0-12 <input type="radio" name="age" value="teen" /> 13-19 <input type="radio" name="age" value="twentysomething" /> 20-29 <input type="radio" name="age" value="thirtysomething" /> 30-39
RadioFormInputGroup objects generate the following events:
- ElementEvent - The events fired are:
- elementAdded
- elementRemoved
- PropertyChangeEvent
- VetoableChangeEvent
- See Also:
RadioFormInput
, Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description RadioFormInputGroup()
Constructs a default RadioFormInputGroup object.RadioFormInputGroup(java.lang.String name)
Constructs a RadioFormInputGroup object with the specified control name.
-
Method Summary
Methods Modifier and Type Method and Description void
add(RadioFormInput radioButton)
Adds a radio button to the group.RadioFormInput
add(java.lang.String name, java.lang.String value, java.lang.String label, boolean checked)
Adds a radio button to the group.void
addElementListener(ElementListener listener)
Adds an addElementListener.void
addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds the VetoableChangeListener.java.lang.String
getFOTag()
Returns a comment tag.java.lang.String
getName()
Returns the control name of the radio group.java.lang.String
getTag()
Returns the radio button group tag.boolean
isAlignmentVertical()
Indicates if the radio group alignment is vertical.void
remove(RadioFormInput radioButton)
Removes a radio button from the group.void
removeElementListener(ElementListener listener)
Removes this ElementListener from the internal list.void
removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes the VetoableChangeListener from the internal list.void
setName(java.lang.String name)
Sets the control name of the radio group.void
setVerticalAlignment(boolean verticalAlignment)
Sets the alignment of the radio group to vertical.-
Methods inherited from class com.ibm.as400.util.html.HTMLTagAttributes
addPropertyChangeListener, getAttributes, getAttributeString, removePropertyChangeListener, setAttributes
-
-
-
-
Constructor Detail
-
RadioFormInputGroup
public RadioFormInputGroup()
Constructs a default RadioFormInputGroup object.
-
RadioFormInputGroup
public RadioFormInputGroup(java.lang.String name)
Constructs a RadioFormInputGroup object with the specified control name.- Parameters:
name
- The group control name.
-
-
Method Detail
-
add
public void add(RadioFormInput radioButton)
Adds a radio button to the group. If the group does not have a name, the name of the first radio button added will also be the group name.- Parameters:
radioButton
- The radio button.
-
add
public RadioFormInput add(java.lang.String name, java.lang.String value, java.lang.String label, boolean checked)
Adds a radio button to the group. If the group does not have a name, the name of the first radio button added will also be the group name.- 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 radio button initializes to checked.- Returns:
- A RadioFormInput object.
-
addElementListener
public void addElementListener(ElementListener listener)
Adds an addElementListener. The specified addElementListeners elementAdded method will be called each time a RadioFormInput is added to the group. The addElementListener object is added to a list of addElementListeners managed by this RadioFormInputGroup. It can be removed with removeElementListener.- Parameters:
listener
- The ElementListener.- See Also:
removeElementListener(com.ibm.as400.util.html.ElementListener)
-
addVetoableChangeListener
public void addVetoableChangeListener(java.beans.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)
-
getName
public java.lang.String getName()
Returns the control name of the radio group.- Returns:
- The group control name.
-
getFOTag
public java.lang.String getFOTag()
Returns a comment tag. This method should not be called. There is no XSL-FO support for this class.- Specified by:
getFOTag
in interfaceHTMLTagElement
- Returns:
- The comment tag.
-
getTag
public java.lang.String getTag()
Returns the radio button group tag.- Specified by:
getTag
in interfaceHTMLTagElement
- Returns:
- The tag.
-
isAlignmentVertical
public boolean isAlignmentVertical()
Indicates if the radio group alignment is vertical. The default value is false.- Returns:
- true if vertical; horizontal otherwise.
-
remove
public void remove(RadioFormInput radioButton)
Removes a radio button from the group.- Parameters:
radioButton
- The radio button.
-
removeElementListener
public void removeElementListener(ElementListener listener)
Removes this ElementListener from the internal list. If the ElementListener is not on the list, nothing is done.- Parameters:
listener
- The ElementListener.- See Also:
addElementListener(com.ibm.as400.util.html.ElementListener)
-
removeVetoableChangeListener
public void removeVetoableChangeListener(java.beans.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)
-
setName
public void setName(java.lang.String name) throws java.beans.PropertyVetoException
Sets the control name of the radio group.- Parameters:
name
- The group control name.- Throws:
java.beans.PropertyVetoException
- If a change is vetoed.
-
setVerticalAlignment
public void setVerticalAlignment(boolean verticalAlignment) throws java.beans.PropertyVetoException
Sets the alignment of the radio group to vertical. The default is false.- Parameters:
verticalAlignment
- true if alignment is vertical; false if horizontal.- Throws:
java.beans.PropertyVetoException
- If a change is vetoed.
-
-