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

com.sas.taglib.servlet.tbeans.form.CheckBoxTag

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:

CellContentsCheckBoxEditorTag

public class CheckBoxTag

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

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

BaseCheckBox, 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

CheckBoxTag()

Method Summary

protected void	applyAttributes() Sets the attributes (value, text, selected, model ) on the underlying CheckBox object.
int	doStartTag() Process the start tag for this instance.
boolean	getEnabled() Gets the enabled attribute of the CheckBoxTag.
boolean	getSelected() Gets the selected attribute of the CheckBoxTag.
java.lang.String	getText() Gets the text attribute of the CheckBoxTag.
java.lang.String	getValue() Gets the value attribute of the CheckBoxTag.
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
boolean	isLabelBolding() Gets the labelBolding attribute of the CheckBoxTag.
void	setEnabled(boolean enabled) Sets the enabled attribute (boolean) of the CheckBoxTag.
void	setLabelBolding(boolean labelBolding) Sets the labelBolding attribute (boolean) of the CheckBoxTag.
void	setSelected(boolean selected) Sets the selected attribute (boolean) of the CheckBoxTag.
void	setText(java.lang.String text) Sets the text attribute (String) of the CheckBoxTag.
void	setValue(java.lang.String value) Sets the value attribute (String) of the CheckBoxTag.

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

doEndTag, 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

CheckBoxTag

public CheckBoxTag()

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.

setSelected

public void setSelected(boolean selected)

Sets the selected attribute (boolean) of the CheckBoxTag. Valid values are: true, false.

Parameters:

selected - The state of the FORM element; "true" results in a selected check box.

setText

public void setText(java.lang.String text)

Sets the text attribute (String) of the CheckBoxTag.

Parameters:

text - Text string that is displayed adjacent to the check box (that is, its label).

setValue

public void setValue(java.lang.String value)

Sets the value attribute (String) of the CheckBoxTag.

Parameters:

value - String value that is assigned to the checkbox FORM element when it selected (or "checked").

setEnabled

public void setEnabled(boolean enabled)

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

Overrides:

setEnabled in class BaseFormElementBodyTag

Parameters:

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

See Also:

BaseFormElementBodyTag.isEnabled()

setLabelBolding

public void setLabelBolding(boolean labelBolding)

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

Parameters:

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

getValue

public java.lang.String getValue()

Gets the value attribute of the CheckBoxTag.

Returns:

the value attribute of the CheckBoxTag

getText

public java.lang.String getText()

Gets the text attribute of the CheckBoxTag.

Returns:

the text attribute of the CheckBoxTag

getSelected

public boolean getSelected()

Gets the selected attribute of the CheckBoxTag.

Returns:

true if the checkbox is selected

getEnabled

public boolean getEnabled()

Gets the enabled attribute of the CheckBoxTag.

Returns:

true if the checkbox is enabled

isLabelBolding

public boolean isLabelBolding()

Gets the labelBolding attribute of the CheckBoxTag.

Returns:

true to bold the label when the checkbox is selected

doStartTag

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

Process 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 (value, text, selected, model ) on the underlying CheckBox object.

Overrides:

applyAttributes in class BaseFormElementBodyTag

Throws:

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