com.sas.servlet.tbeans.form
Class BaseListBoxView

com.sas.servlet.tbeans.form.BaseListBoxView

All Implemented Interfaces:

com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, FormElementModificationEventInterface, com.sas.servlet.tbeans.form.JavaScriptObjectCreationInterface, com.sas.servlet.tbeans.JavaScriptEventHandlerInterface, RenderableInterface, TransformationInterface, GenericValidatorInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable

Direct Known Subclasses:

ListBoxView

public abstract class BaseListBoxView

The BaseListBox is an abstract TransformationBean™ for creating a ListBoxView input field. A ListBoxView is a menu that allows either a single selection or multiple selections. The ListBoxView can contain text only, images only, or both text and images together.

The ListBoxView TransformationBean™ gathers the selections from a model via the ListModel. A model must implement the javax.swing.ListModel interface in order to be used. The model can only contain com.sas.servlet.tbeans.models.JavaScriptNode items.

Note that subclasses of this bean actually provide the markup rendering used in/with Servlet and JavaServer Pages technologies. If you need to add support for a markup language that is not explicitly provided with AppDev Studio, then you must extend this class.

For More Information:

JSP custom tags provide an alternative to using the TransformationBeans™. Visit the Custom Tag Library Reference for additional information on the sas:ListBoxView custom tag.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

See Also:

Serialized Form

Field Summary

Fields inherited from class com.sas.servlet.tbeans.form.BaseListBox

model, RB_KEY

Constructor Summary

BaseListBoxView()
Construct a new ListBox

Method Summary

java.lang.String	getDeselectNodeFunctionName() Gets the deselect node function name for when the node is deselected.
java.lang.String	getImageLocation() Gets the image location for the images in the ListBoxView.
java.lang.String	getListConstructorName() Gets the javascript function name that's used as the constructor for the ListBoxView.
java.lang.String	getOnMouseDown() Gets the onMouseDown event value.
java.lang.String	getSelectNodeFunctionName() Gets the select node function name for when the node is selected.
java.lang.String	getType() Gets the type of ListBoxView being displayed.
boolean	isImagesEnabled() Gets the imagesEnabled attribute
boolean	isImagesOnly() Determines if images only should be displayed.
void	setDeselectNodeFunctionName(java.lang.String value) Sets the name of the javascript function to use when node is deselected.
void	setImageLocation(java.lang.String value) Sets the image location for the images in the ListBoxView.
void	setImagesEnabled(boolean value) Sets the whether or not images are used in ListBoxView The default is true.
void	setImagesOnly(boolean value) Sets whether or not to display images only.
void	setListConstructorName(java.lang.String value) Sets the name of the javascript function to use as the constructor for this object.
void	setOnMouseDown(java.lang.String value) Sets the onMouseDown event value.
void	setSelectNodeFunctionName(java.lang.String value) Sets the name of the javascript function to use when node is selected.
void	setType(java.lang.String value) Sets the type of ListBoxView being displayed.

Methods inherited from class com.sas.servlet.tbeans.form.BaseListBox

getModel, getMultipleSelections, getSelectedIndex, getSelectedIndexes, getSelectedItem, getSelectedItems, getSize, isSelected, isSelected, isValidateSelection, setModel, setMultipleSelections, setSelectedIndex, setSelectedIndexes, setSelectedItem, setSelectedItem, setSelectedItems, setSelectedItems, setSize, setValidateSelection

Methods inherited from class com.sas.servlet.tbeans.form.BaseFormElement

getAccessKey, getErrorHandler, getModificationEventName, getName, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyleInfo, getTabIndex, getTitle, getValidationFunctions, getValidator, isEnabled, isValid, isValidationEnabled, setAccessKey, setEnabled, setErrorHandler, setId, setModificationEventName, setName, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setStyleInfo, setTabIndex, setTitle, setValidator, write, writeJavaScriptObject, writeJavaScriptObjectValidate, writeJavaScriptValidatorObject, writeValidationScript

Methods inherited from class com.sas.servlet.tbeans.BaseTransformation

addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setInputTransform, setLocale, setLocaleDependentProperties, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write

Constructor Detail

BaseListBoxView

public BaseListBoxView()

Construct a new ListBox

Method Detail

setOnMouseDown

public void setOnMouseDown(java.lang.String value)

Sets the onMouseDown event value.

Overrides:

setOnMouseDown in class BaseFormElement

Parameters:

value - The onMouseDown value

getOnMouseDown

public java.lang.String getOnMouseDown()

Gets the onMouseDown event value.

Overrides:

getOnMouseDown in class BaseFormElement

Returns:

onMouseDown value The onMouseDown

setImagesEnabled

public void setImagesEnabled(boolean value)

Sets the whether or not images are used in ListBoxView The default is true.

Parameters:

useImages - true if images are allowed

isImagesEnabled

public boolean isImagesEnabled()

Gets the imagesEnabled attribute

Returns:

true if images are allowed

setImageLocation

public void setImageLocation(java.lang.String value)

Sets the image location for the images in the ListBoxView.

Parameters:

value - The image location

getImageLocation

public java.lang.String getImageLocation()

Gets the image location for the images in the ListBoxView.

Returns:

The image location

setType

public void setType(java.lang.String value)

Sets the type of ListBoxView being displayed. Valid values currently are ListBoxView (default), CheckBoxList, and ComboBoxView.

Parameters:

value - The type

getType

public java.lang.String getType()

Gets the type of ListBoxView being displayed.

Returns:

type The type of ListBoxView displayed

setListConstructorName

public void setListConstructorName(java.lang.String value)

Sets the name of the javascript function to use as the constructor for this object.

Parameters:

value - The javascript function name used as for the constructor

getListConstructorName

public java.lang.String getListConstructorName()

Gets the javascript function name that's used as the constructor for the ListBoxView.

Returns:

The javascript function name used as for the constructor

setSelectNodeFunctionName

public void setSelectNodeFunctionName(java.lang.String value)

Sets the name of the javascript function to use when node is selected.

Parameters:

value - The select node function name

getSelectNodeFunctionName

public java.lang.String getSelectNodeFunctionName()

Gets the select node function name for when the node is selected.

Returns:

The select node function name

setDeselectNodeFunctionName

public void setDeselectNodeFunctionName(java.lang.String value)

Sets the name of the javascript function to use when node is deselected.

Parameters:

value - The deselect node function name

getDeselectNodeFunctionName

public java.lang.String getDeselectNodeFunctionName()

Gets the deselect node function name for when the node is deselected.

Returns:

The deselect node function name

setImagesOnly

public void setImagesOnly(boolean value)

Sets whether or not to display images only. By default if you only set image and value on a node, the display text is set to value. By setting this method to TRUE, the display text will NOT be set to value. FALSE by default.

Parameters:

value - TRUE to display images only.

isImagesOnly

public boolean isImagesOnly()

Determines if images only should be displayed.

Returns:

TRUE if images only are displayed.