com.sas.taglib.servlet.tbeans.form
Class ChoiceBoxTag

com.sas.taglib.servlet.tbeans.form.ChoiceBoxTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally

Direct Known Subclasses:

CellContentsChoiceBoxEditorTag

public class ChoiceBoxTag

ChoiceBoxTag is the tag handler class for the sas:ChoiceBox custom tag . ChoiceBoxTag is invoked by the JSP page to evaluate the sas:ChoiceBox custom tag during the execution of the page. Tag handler methods are called by the JSP page implementation class at various points during the evaluation of the tag. The tag handler methods in turn call methods on the underlying Transformation Bean object, ChoiceBox, to execute the methods.

If you need to extend or modify the functionality of the sas:ChoiceBox custom tag, you can subclass this tag handler class.

For More Information:

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Refer to the Custom Tag Library Reference for usage information on the sas:ChoiceBox 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:

BaseChoiceBox, Serialized Form

Field Summary

Fields inherited from class com.sas.taglib.servlet.tbeans.form.BaseFormElementBodyTag

accessKey, onBlur, onChange, onClick, onDblClick, onFocus, onKeyDown, onKeyPress, onKeyUp, onMouseDown, onMouseMove, onMouseOut, onMouseOver, onMouseUp, onSelect, styleClassPrefix, tabIndex

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS

Constructor Summary

ChoiceBoxTag()

Method Summary

protected void	applyAttributes() Sets the attributes on the underlying ChoiceBox object.
int	doEndTag() Process the end tag.
int	doStartTag() Processes the start tag for this instance.
java.lang.String	getDescriptionModel() Gets the descriptionmodel property of the ChoiceBoxTag.
boolean	getEnabled() Gets the enabled attribute of the ChoiceBoxTag.
java.lang.String	getModel() Gets the model property of the ChoiceBoxTag.
int	getSelectedIndex() Gets the selectedindex property of the ChoiceBoxTag.
java.lang.String	getSelectedItem() Gets the selecteditem property of the ChoiceBoxTag.
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
void	setDescriptionModel(java.lang.String descriptionmodel) Sets the descriptionmodel property (String).
void	setEnabled(boolean enabled) Sets the enabled attribute (boolean) of the ChoiceBoxTag.
void	setModel(java.lang.String model) Sets the model property (String).
void	setSelectedIndex(int selectedindex) Sets the selectedindex property (int).
void	setSelectedItem(java.lang.String selecteditem) Sets the selecteditem property (String).

Methods inherited from class com.sas.taglib.servlet.tbeans.form.BaseFormElementBodyTag

getAccessKey, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyleClassPrefix, getTabIndex, isEnabled, setAccessKey, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setStyleClassPrefix, setTabIndex

Methods inherited from class com.sas.taglib.servlet.tbeans.BaseTransformationBodyTag

getCustomAttributes, getEpilog, getLocale, getName, getObjectDataProperty, getProlog, getRender, getRenderType, setCustomAttributes, setEpilog, setLocale, setName, setObjectDataProperty, setProlog, setRender, setRenderType

Methods inherited from class com.sas.taglib.BaseBodyTag

doCatch, doFinally, getApplyAttributes, getBodyStrings, getCompositeComponentKey, getInstantiate, getPageContext, getRef, getScope, getTagScope, getWrappedClassName, getWrappedObject, getWrappedObject, loadBeanInstance, newInstance, release, removeFromScope, searchContext, setApplyAttributes, setCompositeComponentKey, setInstantiate, setRef, setScope, setTagScope, setVariableWithinScope, setWrappedClassName, setWrappedObject, validate

Constructor Detail

ChoiceBoxTag

public ChoiceBoxTag()

Method Detail

initialize

protected void initialize(boolean includeAttributes)

Initializes attributes and variables for this tag handler.

Overrides:

initialize in class BaseFormElementBodyTag

Parameters:

includeAttributes - Set to true if attributes are to be set to default values.

setModel

public void setModel(java.lang.String model)

Sets the model property (String). The model String is used to find the model (with in the specified scope) to create the Custom Tag against.

Parameters:

model - The model of the ChoiceBox.

getModel

public java.lang.String getModel()

Gets the model property of the ChoiceBoxTag.

Returns:

the model attribute of the ChoiceBoxTag

setDescriptionModel

public void setDescriptionModel(java.lang.String descriptionmodel)

Sets the descriptionmodel property (String). The descriptionmodel String is used to find the descriptionmodel (with in the specified scope) to create the Custom Tag against.

Parameters:

descriptionmodel - Alternate display name for items in the model at run-time.

getDescriptionModel

public java.lang.String getDescriptionModel()

Gets the descriptionmodel property of the ChoiceBoxTag.

Returns:

the descriptionmodel attribute of the ChoiceBoxTag

setSelectedItem

public void setSelectedItem(java.lang.String selecteditem)

Sets the selecteditem property (String). The selecteditem String is used to find and select the item specified in the ChoiceBox model.

Parameters:

selecteditem - The selected item specified in the ChoiceBox.

getSelectedItem

public java.lang.String getSelectedItem()

Gets the selecteditem property of the ChoiceBoxTag.

Returns:

the selecteditem attribute of the ChoiceBoxTag

setSelectedIndex

public void setSelectedIndex(int selectedindex)

Sets the selectedindex property (int). The selectedindex String is used to select the item located at the specified index. The selectedindex String should be an integer value.

Parameters:

selectedindex - The selected index of an item in the ChoiceBox.

getSelectedIndex

public int getSelectedIndex()

Gets the selectedindex property of the ChoiceBoxTag.

Returns:

the selectedindex attribute of the ChoiceBoxTag

setEnabled

public void setEnabled(boolean enabled)

Sets the enabled attribute (boolean) of the ChoiceBoxTag. Valid values are: true, false.

Overrides:

setEnabled in class BaseFormElementBodyTag

Parameters:

enabled - The state of the ChoiceBox element; "false" results in a disabled choice box.

See Also:

BaseFormElementBodyTag.isEnabled()

getEnabled

public boolean getEnabled()

Gets the enabled attribute of the ChoiceBoxTag.

Returns:

true if the choicebox is enabled

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

Processes the start tag for this instance. The doStartTag() method assumes that all setter methods have been invoked before. When this method is invoked, the body has not yet been invoked.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class BaseTransformationBodyTag

Returns:

int designating the next course of action for the tag/jsp page.

Throws:

javax.servlet.jsp.JspException - Thrown if some type of JSP error occurs

See Also:

BaseBodyTag.setInstantiate(boolean), TagSupport.doStartTag()

applyAttributes

protected void applyAttributes()
                        throws javax.servlet.jsp.JspException

Sets the attributes on the underlying ChoiceBox object.

Overrides:

applyAttributes in class BaseFormElementBodyTag

Throws:

javax.servlet.jsp.JspException - Thrown if some type of JSP error occurs

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Process the end tag. This method will be called on all Tag objects.

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class BaseTransformationBodyTag

Returns:

int designating the next course of action for the tag/jsp page.

Throws:

javax.servlet.jsp.JspException - Thrown if some type of JSP error occurs

See Also:

TagSupport.doEndTag(), BaseBodyTag.setInstantiate(boolean)