com.iplanet.jato.view.html
Class RadioButtonGroup

java.lang.Object
  |
  +--com.iplanet.jato.view.ViewBase
        |
        +--com.iplanet.jato.view.DisplayFieldImpl
              |
              +--com.iplanet.jato.view.html.HtmlDisplayFieldBase
                    |
                    +--com.iplanet.jato.view.html.SelectableGroupImpl
                          |
                          +--com.iplanet.jato.view.html.RadioButtonGroup
All Implemented Interfaces:
DisplayField, HtmlDisplayField, SelectableGroup, View

public class RadioButtonGroup
extends SelectableGroupImpl

The RadioButtonGroup class encapsulates and implements the server-side representation of a collection of HTML radio fields

Version:
JATO/1.2.2 $Id: RadioButtonGroup.java,v 1.12 2002/03/16 03:26:44 todd Exp $
See Also:
Option, OptionList, SelectableGroup, ListBox, ComboBox

Fields inherited from interface com.iplanet.jato.view.html.SelectableGroup
VALUE_FOR_NONE_SELECTED
 
Fields inherited from interface com.iplanet.jato.view.html.HtmlDisplayField
QBE_CONTROL_NAME_SUFFIX
 
Fields inherited from interface com.iplanet.jato.view.View
QUALIFIED_VIEW_NAME_SEPARATOR
 
Constructor Summary
RadioButtonGroup(ContainerView parent, java.lang.String name, java.lang.Object value)
          Construct a display field with the specified properties.
RadioButtonGroup(ContainerView parent, java.lang.String name, java.lang.Object value, OptionList options)
          Construct a display field with the specified properties.
RadioButtonGroup(ContainerView parent, java.lang.String name, java.lang.String boundName, java.lang.Object value)
          Construct a display field with the specified properties.
RadioButtonGroup(ContainerView parent, java.lang.String name, java.lang.String boundName, java.lang.Object value, OptionList options)
          Construct a display field with the specified properties.
RadioButtonGroup(View parent, Model model, java.lang.String name, java.lang.Object value)
          Construct a display field with the specified properties
RadioButtonGroup(View parent, Model model, java.lang.String name, java.lang.Object value, OptionList options)
          Construct a display field with the specified properties
RadioButtonGroup(View parent, Model model, java.lang.String name, java.lang.String boundName, java.lang.Object value)
          Construct a display field with the specified properties
RadioButtonGroup(View parent, Model model, java.lang.String name, java.lang.String boundName, java.lang.Object value, DisplayFieldDescriptor descriptor)
          Construct a display field with the specified properties
RadioButtonGroup(View parent, Model model, java.lang.String name, java.lang.String boundName, java.lang.Object value, OptionList options, DisplayFieldDescriptor descriptor)
          Construct a display field with the specified properties
 
Method Summary
 java.lang.String getHTML()
          Returns the HTML code that will render the entire radio button group.
 java.lang.String getNoneSelectedHtmlString(boolean noneSelected)
          Returns the HTML string defining an Option consisting of the "Label for None Selected" label, and the predefined VALUE_FOR_NONE_SELECTED
 boolean isHorizontalLayout()
          Returns true if this radio button group has been designated for horizontal layout
 void setHorizontalLayout(boolean isHorizontalLayout)
          Sets the layout to be either horizontal or vertical
 
Methods inherited from class com.iplanet.jato.view.html.SelectableGroupImpl
getLabelForNoneSelected, getNumOptions, getOptions, isMultiSelect, isSelected, isSelected, setLabelForNoneSelected, setMultiSelect, setOptions
 
Methods inherited from class com.iplanet.jato.view.html.HtmlDisplayFieldBase
getExtraHtml, getQBEControlQualifiedName, setExtraHtml, urlEncodedValue
 
Methods inherited from class com.iplanet.jato.view.DisplayFieldImpl
getBoundName, getDescriptor, getModel, getValue, getValues, setBoundName, setDescriptor, setModel, setValue, setValue, setValues, setValues, stringValue
 
Methods inherited from class com.iplanet.jato.view.ViewBase
getName, getParent, getParentViewBean, getQualifiedName, getRootView, getRootView, setName, setParent
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.iplanet.jato.view.html.HtmlDisplayField
getExtraHtml
 
Methods inherited from interface com.iplanet.jato.view.DisplayField
getDescriptor, getValue, getValues, setValue, setValues, stringValue
 
Methods inherited from interface com.iplanet.jato.view.View
getName, getParent, getQualifiedName, setParent
 

Constructor Detail

RadioButtonGroup

public RadioButtonGroup(ContainerView parent,
                        java.lang.String name,
                        java.lang.Object value)
Construct a display field with the specified properties. The field will be bound to the parent's default model.
Parameters:
parent - The parent view of this object
name - This view's name and model field bound name
value - This DiplayField's initial value.

RadioButtonGroup

public RadioButtonGroup(ContainerView parent,
                        java.lang.String name,
                        java.lang.Object value,
                        OptionList options)
Construct a display field with the specified properties. The field will be bound to the parent's default model.
Parameters:
parent - The parent view of this object
name - This view's name and model field bound name
value - This DiplayField's initial value.

RadioButtonGroup

public RadioButtonGroup(ContainerView parent,
                        java.lang.String name,
                        java.lang.String boundName,
                        java.lang.Object value)
Construct a display field with the specified properties. The field will be bound to the parent's default model.
Parameters:
parent - The parent view of this object
name - This view's name
boundName - The name of the model field to which this DisplayField is bound
value - This DiplayField's initial value.

RadioButtonGroup

public RadioButtonGroup(ContainerView parent,
                        java.lang.String name,
                        java.lang.String boundName,
                        java.lang.Object value,
                        OptionList options)
Construct a display field with the specified properties. The field will be bound to the parent's default model.
Parameters:
parent - The parent view of this object
name - This view's name
boundName - The name of the model field to which this DisplayField is bound
value - This DiplayField's initial value.

RadioButtonGroup

public RadioButtonGroup(View parent,
                        Model model,
                        java.lang.String name,
                        java.lang.Object value)
Construct a display field with the specified properties
Parameters:
parent - The parent view of this object
model - The model to which this DisplayField is bound
name - This view's name and model field bound name
value - This DiplayField's initial value.

RadioButtonGroup

public RadioButtonGroup(View parent,
                        Model model,
                        java.lang.String name,
                        java.lang.Object value,
                        OptionList options)
Construct a display field with the specified properties
Parameters:
parent - The parent view of this object
model - The model to which this DisplayField is bound
name - This view's name and model field bound name
value - This DiplayField's initial value.

RadioButtonGroup

public RadioButtonGroup(View parent,
                        Model model,
                        java.lang.String name,
                        java.lang.String boundName,
                        java.lang.Object value)
Construct a display field with the specified properties
Parameters:
parent - The parent view of this object
model - The model to which this DisplayField is bound
name - This view's name.
boundName - The name of the model field to which this DisplayField is bound
value - This DiplayField's initial value.

RadioButtonGroup

public RadioButtonGroup(View parent,
                        Model model,
                        java.lang.String name,
                        java.lang.String boundName,
                        java.lang.Object value,
                        DisplayFieldDescriptor descriptor)
Construct a display field with the specified properties
Parameters:
parent - The parent view of this object
model - The model to which this DisplayField is bound
name - This view's name.
boundName - The name of the model field to which this DisplayField is bound
value - This DiplayField's initial value.
descriptor - This DisplayField's DisplayFieldDescriptor. May be null.

RadioButtonGroup

public RadioButtonGroup(View parent,
                        Model model,
                        java.lang.String name,
                        java.lang.String boundName,
                        java.lang.Object value,
                        OptionList options,
                        DisplayFieldDescriptor descriptor)
Construct a display field with the specified properties
Parameters:
parent - The parent view of this object
model - The model to which this DisplayField is bound
name - This view's name.
boundName - The name of the model field to which this DisplayField is bound
value - This DiplayField's initial value.
descriptor - This DisplayField's DisplayFieldDescriptor. May be null.
Method Detail

isHorizontalLayout

public boolean isHorizontalLayout()
Returns true if this radio button group has been designated for horizontal layout
Returns:
true if horizontal layout

setHorizontalLayout

public void setHorizontalLayout(boolean isHorizontalLayout)
Sets the layout to be either horizontal or vertical
Parameters:
isHorizontalLayout - if true, horizontal layout is enabled if false, vertical layout is enabled

getNoneSelectedHtmlString

public java.lang.String getNoneSelectedHtmlString(boolean noneSelected)
Returns the HTML string defining an Option consisting of the "Label for None Selected" label, and the predefined VALUE_FOR_NONE_SELECTED
Overrides:
getNoneSelectedHtmlString in class SelectableGroupImpl
Parameters:
noneSelected - if true, the "None Selected" option is selected
Returns:
the HTML string for a NoneSelected option

getHTML

public java.lang.String getHTML()
Returns the HTML code that will render the entire radio button group. Any option which matches the current display field value will be pre-selected.
Returns:
a string of HTML representing the entire list.