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

com.sas.taglib.servlet.tbeans.form.RadioTag

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:

CellContentsRadioEditorTag

public class RadioTag

RadioTag is the tag handler class for the sas:Radio custom tag . RadioTag is invoked by the JSP page to evaluate the sas:Radio 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, Radio, to execute the methods.

If you need to extend or modify the functionality of the sas:Radio 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:Radio 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:

BaseRadio, Serialized Form

Field Summary

protected java.util.Enumeration	bodyStrings Internal radio properties
protected java.lang.String	descriptionmodel Internal radio properties
protected boolean	horizontalvalue Internal radio properties
protected java.lang.String	labelOrientation Internal radio properties
protected java.lang.String	model Internal radio properties
protected java.lang.String	orientation Internal radio properties
protected BaseRadio	radio Internal radio used to set values
protected java.lang.String	selecteditem Internal radio properties

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

RadioTag()

Method Summary

protected void	applyAttributes() Sets the attributes on the underlying Radio 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 RadioTag.
java.lang.String	getLabelOrientation() Gets the labelOrientation property of the RadioTag.
java.lang.String	getModel() Gets the model property of the RadioTag.
java.lang.String	getOrientation() Gets the orientation property of the RadioTag.
int	getSelectedIndex() Gets the selectedindex property of the RadioTag.
java.lang.String	getSelectedItem() Gets the selecteditem property of the RadioTag.
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
boolean	isDisplayButtonText() Deprecated.
boolean	isHorizontal() Checks the horizontalvalue value of the RadioTag.
boolean	isLabelBolding() Gets the labelBolding attribute of the RadioTag.
boolean	isLabelVisible() Checks the labelVisible value of the RadioTag.
void	setDescriptionModel(java.lang.String descriptionmodel) Sets the descriptionmodel property (String).
void	setDisplayButtonText(boolean displaybuttontext) Deprecated.
void	setLabelBolding(boolean labelBolding) Sets the labelBolding attribute (boolean) of the RadioTag.
void	setLabelOrientation(java.lang.String orientation) Sets the labelOrientation property.
void	setLabelVisible(boolean labelVisible) Sets the labelVisible property.
void	setModel(java.lang.String model) Sets the model property (String).
void	setOrientation(java.lang.String orientation) Sets the orientation property.
void	setSelectedIndex(int si) 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, setEnabled, 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

Field Detail

radio

protected BaseRadio radio

Internal radio used to set values

model

protected java.lang.String model

Internal radio properties

descriptionmodel

protected java.lang.String descriptionmodel

Internal radio properties

selecteditem

protected java.lang.String selecteditem

Internal radio properties

horizontalvalue

protected boolean horizontalvalue

Internal radio properties

bodyStrings

protected java.util.Enumeration bodyStrings

Internal radio properties

orientation

protected java.lang.String orientation

Internal radio properties

labelOrientation

protected java.lang.String labelOrientation

Internal radio properties

Constructor Detail

RadioTag

public RadioTag()

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 Radio.

getModel

public java.lang.String getModel()

Gets the model property of the RadioTag.

Returns:

the model attribute of the RadioTag

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 RadioTag.

Returns:

the descriptionmodel attribute of the RadioTag

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 Radio model.

Parameters:

selecteditem - The selected item specified in the Radio.

getSelectedItem

public java.lang.String getSelectedItem()

Gets the selecteditem property of the RadioTag.

Returns:

the selecteditem attribute of the RadioTag

setSelectedIndex

public void setSelectedIndex(int si)

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

Parameters:

selectedindex - The index of an item in the Radio to make selected.

getSelectedIndex

public int getSelectedIndex()

Gets the selectedindex property of the RadioTag.

Returns:

the selectedindex attribute of the RadioTag

setOrientation

public void setOrientation(java.lang.String orientation)

Sets the orientation property. The orientation String is used to set the alignment of the radio buttons. The orientation String should be horizontal or vertical.

Parameters:

orientation - The alignment of the radio buttons.

getOrientation

public java.lang.String getOrientation()

Gets the orientation property of the RadioTag.

Returns:

the orientation attribute of the RadioTag

setLabelOrientation

public void setLabelOrientation(java.lang.String orientation)

Sets the labelOrientation property. The labelOrientation String is used to set the alignment of the label for the radio buttons. The labelOrientation String should be TOP, BOTTOM, LEFT, or RIGHT.

Parameters:

orientation - The alignment of the label for the radio buttons.

getLabelOrientation

public java.lang.String getLabelOrientation()

Gets the labelOrientation property of the RadioTag.

Returns:

the labelOrientation attribute of the RadioTag

isHorizontal

public boolean isHorizontal()

Checks the horizontalvalue value of the RadioTag.

Returns:

the horizontalvalue of the RadioTag

setDisplayButtonText

public void setDisplayButtonText(boolean displaybuttontext)

Deprecated.

Sets the displaybuttontext property. The displaybuttontext String is used to determine if the button text should be displayed. The displaybuttontext String should be an boolean value.

Parameters:

displaybuttontext - Determines whether or not the button text should be displayed.

isDisplayButtonText

public boolean isDisplayButtonText()

Deprecated.

Checks the displaybuttontext value of the RadioTag.

Returns:

the displaybuttontext value of the RadioTag

setLabelVisible

public void setLabelVisible(boolean labelVisible)

Sets the labelVisible property. The labelVisible String is used to determine if the button text should be displayed. The labelVisible String should be an boolean value.

Parameters:

labelVisible - Determines whether or not the button text should be displayed.

isLabelVisible

public boolean isLabelVisible()

Checks the labelVisible value of the RadioTag.

Returns:

the labelVisible value of the RadioTag

setLabelBolding

public void setLabelBolding(boolean labelBolding)

Sets the labelBolding attribute (boolean) of the RadioTag. Valid values are: true, false.

Parameters:

labelBolding - Sets whether the to bold the label when the radio button is selected: TRUE bold label Default value is FALSE.

isLabelBolding

public boolean isLabelBolding()

Gets the labelBolding attribute of the RadioTag.

Returns:

true to bold the label when the radio button is selected

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 Radio 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)