objectivehtml.htmlwidget
Class HtmlRadioButtonGroup

java.lang.Object
  |
  +--objectivehtml.oms.OMSObject
        |
        +--objectivehtml.htmlwidget.HtmlRadioButtonGroup

public class HtmlRadioButtonGroup
extends OMSObject

This class holds all the radio buttons of a radio button group. Through this class you can access all the other radio buttons of the same group.

Radio buttons can be synchronized/unsynchronized. If synchronized (default) then when one object is selected then all other objects become unchecked. If unsychronized then all objects operate in isolation.


Constructor Summary
protected HtmlRadioButtonGroup(java.lang.String sGroupName)
          Constructs a HtmlRadioButtonGroup with the specified group name sGroupName.
 
Method Summary
protected  void addRadioButton(HtmlRadioButton objRadioButton)
          Adds a new HtmlRadioButton to the group.
 java.lang.String getGroupName()
          Returns the group name.
 java.util.Collection getRadioButtons()
          Returns a shallow copy of the list of radio buttons that belong in this group.
 int getRadioButtonsCount()
          Returns the number of radio buttons in the group.
 boolean isSynchronized()
          Returns whether the radio buttons should be sychronized.
protected  void removeRadioButton(HtmlRadioButton objRadioButton)
          Removes a new HtmlRadioButton to the group.
 void setSynchronized(boolean bSynchronized)
          Sets whether the radio buttons should be sychronized.
 
Methods inherited from class objectivehtml.oms.OMSObject
compareClasses, connect, disconnect, emit, isAlive, setAlive, signal, slot, slot
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HtmlRadioButtonGroup

protected HtmlRadioButtonGroup(java.lang.String sGroupName)
Constructs a HtmlRadioButtonGroup with the specified group name sGroupName.
Parameters:
objParent - the parent of this widget, the parent must be a container widget otherwise an E_USER_ERROR will be raised.
Method Detail

getGroupName

public java.lang.String getGroupName()
Returns the group name.
Returns:
the group name

isSynchronized

public boolean isSynchronized()
Returns whether the radio buttons should be sychronized.
Returns:
true if synchronized, false otherwise
See Also:
setSynchronized(boolean)

setSynchronized

public void setSynchronized(boolean bSynchronized)
Sets whether the radio buttons should be sychronized. When synchronized if a radio button has the method setSelected(boolean) called then all other radio buttons in the group become deselected. If not synchronized then calling setSelected(boolean) will have no effect on the other radio buttons in the group.
Parameters:
bSynchronized - true if sychronized, false otherwise
See Also:
isSynchronized()

getRadioButtonsCount

public int getRadioButtonsCount()
Returns the number of radio buttons in the group.
Returns:
the number of radio buttons in the group

getRadioButtons

public java.util.Collection getRadioButtons()
Returns a shallow copy of the list of radio buttons that belong in this group.
Returns:
a collection of the radio buttons in the group

addRadioButton

protected void addRadioButton(HtmlRadioButton objRadioButton)
Adds a new HtmlRadioButton to the group.
Parameters:
objRadioButton - the new radio button to add

removeRadioButton

protected void removeRadioButton(HtmlRadioButton objRadioButton)
Removes a new HtmlRadioButton to the group.
Parameters:
objRadioButton - the new radio button to remove