com.sas.servlet.beans
Interface ChoiceboxInterface

All Known Implementing Classes:
BaseChoicebox

public interface ChoiceboxInterface
extends TransformationInterface, ComponentInterface

Transformation bean definition for creating a Choicebox. A Choicebox element is a drop-down combobox that allows a single selection.


Method Summary
 StaticOrderedCollectionInterface getDescriptionModel()
          Gets the model to be used for the decriptions of the choice entry.
 int getSelectedIndex()
          Gets the index of single item to be marked as selected.
 String getSelectedItem()
          Gets the value of a single item to be marked as selected.
 void setDescriptionModel(StaticOrderedCollectionInterface model)
          Sets the model to be used for the decriptions of the choice entry.
 void setSelectedIndex(int value)
          Sets the index of single item to be marked as selected.
 void setSelectedItem(String value)
          Sets the value of a single item to be marked as selected.
 
Methods inherited from interface com.sas.servlet.beans.TransformationInterface
getCustomAttributes, getDescription, getName, getParent, getRequest, getResponse, setCustomAttributes, setDescription, setName, setParent, setRequest, setResponse, write, write, write, write
 

Method Detail

setSelectedIndex

public void setSelectedIndex(int value)
                      throws IOException
Sets the index of single item to be marked as selected. Setting the index will set the corresponding selectedItem.
Parameters:
index - The 0-based index of the item to be selected, or -1 for none

getSelectedIndex

public int getSelectedIndex()
Gets the index of single item to be marked as selected. If more than one index has been set this will return a -1.
Returns:
The array of 0-based values, or null for none

setSelectedItem

public void setSelectedItem(String value)
                     throws IOException
Sets the value of a single item to be marked as selected. Setting the value will set the corresponding selectedIndex.
Parameters:
value - The value of the item to be selected

getSelectedItem

public String getSelectedItem()
Gets the value of a single item to be marked as selected. If more than one value has been set this will return a blank string
Returns:
The collection of selected values, or null for none

setDescriptionModel

public void setDescriptionModel(StaticOrderedCollectionInterface model)
Sets the model to be used for the decriptions of the choice entry. The default is to use the model specified in setModelInterface, which will cause the value of the choice to be the same as the text.
Parameters:
model - The collection to use for the descriptions

getDescriptionModel

public StaticOrderedCollectionInterface getDescriptionModel()
Gets the model to be used for the decriptions of the choice entry. The default is to use the model specified in setModelInterface.
Returns:
The collection to use for the descriptions


Version: 1.2.20000317.001 Formatted: 2000/07/06 15:57:33PM