com.iplanet.jato.view.html
Class ListBox

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.ListBox
All Implemented Interfaces:
DisplayField, HtmlDisplayField, SelectableGroup, View

public class ListBox
extends SelectableGroupImpl

The ListBox class encapsulates and implements the server-side representation of an HTML Select statement where the size is greater than one. A select statement with a size of one is rendered as a combo box

Version:
JATO/1.2.2 $Id: ListBox.java,v 1.12 2002/03/16 03:26:44 todd Exp $
See Also:
Option, OptionList, SelectableGroup, RadioButtonGroup, 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
ListBox(ContainerView parent, java.lang.String name, java.lang.Object value)
          Construct a display field with the specified properties.
ListBox(ContainerView parent, java.lang.String name, java.lang.Object value, OptionList options)
          Construct a display field with the specified properties.
ListBox(ContainerView parent, java.lang.String name, java.lang.String boundName, java.lang.Object value)
          Construct a display field with the specified properties.
ListBox(ContainerView parent, java.lang.String name, java.lang.String boundName, java.lang.Object value, OptionList options)
          Construct a display field with the specified properties.
ListBox(View parent, Model model, java.lang.String name, java.lang.Object value)
          Construct a display field with the specified properties
ListBox(View parent, Model model, java.lang.String name, java.lang.Object value, OptionList options)
          Construct a display field with the specified properties
ListBox(View parent, Model model, java.lang.String name, java.lang.String boundName, java.lang.Object value)
          Construct a display field with the specified properties
ListBox(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
ListBox(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(int size, boolean isMultiSelect)
          Returns the HTML code that will render the entire list.
 
Methods inherited from class com.iplanet.jato.view.html.SelectableGroupImpl
getLabelForNoneSelected, getNoneSelectedHtmlString, 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

ListBox

public ListBox(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.

ListBox

public ListBox(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.

ListBox

public ListBox(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.

ListBox

public ListBox(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.

ListBox

public ListBox(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.

ListBox

public ListBox(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.

ListBox

public ListBox(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.

ListBox

public ListBox(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.

ListBox

public ListBox(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

getHTML

public java.lang.String getHTML(int size,
                                boolean isMultiSelect)
Returns the HTML code that will render the entire list. Any option(s) which match the current display field value(s) will be pre-selected.

Parameters:
size - The number of rows that the list will show at one time (i.e. the viewport size)
isMultiSelect - Designates whether the list should support selection of multiple options
Returns:
a string of HTML representing the entire list.