com.sas.taglib.servlet.tbeans.models
Class ItemTag

com.sas.taglib.servlet.tbeans.models.ItemTag

All Implemented Interfaces:

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

public class ItemTag

ItemTag is the tag handler class for the sasads:Item custom tag. ItemTag is invoked by the JSP page to evaluate the sasads:Item 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.

ItemTag is used to populate items in a DualListSelector and ListBox custom tags. An items can have a value and description.

If you need to extend or modify the functionality of the sasads:ItemTag 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 www.sas.com/rnd/appdev/. Refer to the Custom Tag Library Reference for usage information on the sas:Item 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:

BaseDualSelector, BaseListBox, Serialized Form

Field Summary

static java.lang.String

RB_KEY

Fields inherited from class com.sas.taglib.BaseTag

APPLICATION, PAGE, REQUEST, SESSION

Constructor Summary

ItemTag()

Method Summary

protected void	applyAttributes() Sets the attributes (value, text) on the underlying Item object.
int	doEndTag() Process the end tag.
int	doStartTag() Processes the start tag for this instance.
java.lang.String	getDescription() Gets the description property (String)
java.lang.String	getOnBlur() Gets the onBlur value.
java.lang.String	getOnChange() Gets the onChange value.
java.lang.String	getOnClick() Gets the onClick value.
java.lang.String	getOnFocus() Gets the onFocus value.
java.lang.String	getOnKeyDown() Gets the onKeyDown value associated with the PushButton
java.lang.String	getOnKeyPress() Gets the onKeyPress value associated with the PushButton
java.lang.String	getOnKeyUp() Gets the onKeyUp value associated with the PushButton
java.lang.String	getOnMouseDown() Gets the onMouseDown value associated with the PushButton
java.lang.String	getOnMouseOut() Gets the onMouseOut value.
java.lang.String	getOnMouseOver() Gets the onMouseOver value.
java.lang.String	getOnMouseUp() Gets the onMouseUp value associated with the PushButton
java.lang.String	getText() Gets the text property (String)
java.lang.String	getValue() Gets the value property (String)
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
boolean	isSelected() Gets the selected property of the ItemTag.
void	setDescription(java.lang.String value) Sets the description property (String) The description of item
void	setOnBlur(java.lang.String value) Sets the onBlur event value.
void	setOnChange(java.lang.String value) Sets the onChange event value.
void	setOnClick(java.lang.String value) Sets the onClick event value.
void	setOnFocus(java.lang.String value) Sets the onFocus event value.
void	setOnKeyDown(java.lang.String value) Sets the onKeyDown event associated with the PushButton
void	setOnKeyPress(java.lang.String value) Sets the onKeyPress event associated with the PushButton
void	setOnKeyUp(java.lang.String value) Sets the onKeyUp event associated with the PushButton
void	setOnMouseDown(java.lang.String value) Sets the onMouseDown event associated with the PushButton
void	setOnMouseOut(java.lang.String value) Sets the onMouseOut event value.
void	setOnMouseOver(java.lang.String value) Sets the onMouseOver event value.
void	setOnMouseUp(java.lang.String value) Sets the onMouseUp event associated with the PushButton
void	setSelected(boolean value) Sets the selected property (boolean).
void	setText(java.lang.String value) Sets the text property (String) The text of item
void	setValue(java.lang.String value) Sets the value property (String) The value of item

Methods inherited from class com.sas.taglib.BaseTag

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

Field Detail

RB_KEY

public static final java.lang.String RB_KEY

See Also:

Constant Field Values

Constructor Detail

ItemTag

public ItemTag()

Method Detail

initialize

protected void initialize(boolean includeAttributes)

Initializes attributes and variables for this tag handler.

Overrides:

initialize in class BaseTag

Parameters:

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

setValue

public void setValue(java.lang.String value)

Sets the value property (String) The value of item

Parameters:

value - the value String

getValue

public java.lang.String getValue()

Gets the value property (String)

Returns:

value The value of this item

setDescription

public void setDescription(java.lang.String value)

Sets the description property (String) The description of item

Parameters:

value - the description String

getDescription

public java.lang.String getDescription()

Gets the description property (String)

Returns:

value The description of this item.

setText

public void setText(java.lang.String value)

Sets the text property (String) The text of item

Parameters:

value - the text String

getText

public java.lang.String getText()

Gets the text property (String)

Returns:

value The text of this item.

setSelected

public void setSelected(boolean value)

Sets the selected property (boolean). The selected String specifies whether or not the item in the listbox is selected. Valid values are: true or false.

Parameters:

selected - Specifies whether or not the item is selected in the Listbox.

isSelected

public boolean isSelected()

Gets the selected property of the ItemTag.

Returns:

The selected attribute of the ItemTag

setOnBlur

public void setOnBlur(java.lang.String value)

Sets the onBlur event value.

Parameters:

value - The onBlur value

getOnBlur

public java.lang.String getOnBlur()

Gets the onBlur value.

Returns:

onBlur value The onBlur

setOnChange

public void setOnChange(java.lang.String value)

Sets the onChange event value.

Parameters:

value - The onChange value

getOnChange

public java.lang.String getOnChange()

Gets the onChange value.

Returns:

onChange value The onChange

setOnClick

public void setOnClick(java.lang.String value)

Sets the onClick event value.

Parameters:

value - The onClick value

getOnClick

public java.lang.String getOnClick()

Gets the onClick value.

Returns:

onClick value The onClick

setOnFocus

public void setOnFocus(java.lang.String value)

Sets the onFocus event value.

Parameters:

value - The onFocus value

getOnFocus

public java.lang.String getOnFocus()

Gets the onFocus value.

Returns:

onFocus value The onFocus

setOnMouseOut

public void setOnMouseOut(java.lang.String value)

Sets the onMouseOut event value.

Parameters:

value - The onMouseOut value

getOnMouseOut

public java.lang.String getOnMouseOut()

Gets the onMouseOut value.

Returns:

onMouseOut value The onMouseOut

setOnMouseOver

public void setOnMouseOver(java.lang.String value)

Sets the onMouseOver event value.

Parameters:

value - The onMouseOver value

getOnMouseOver

public java.lang.String getOnMouseOver()

Gets the onMouseOver value.

Returns:

onMouseOver value The onMouseOver

setOnMouseDown

public void setOnMouseDown(java.lang.String value)

Sets the onMouseDown event associated with the PushButton

Parameters:

value - The onMouseDown

getOnMouseDown

public java.lang.String getOnMouseDown()

Gets the onMouseDown value associated with the PushButton

Returns:

The onMouseDown value

setOnMouseUp

public void setOnMouseUp(java.lang.String value)

Sets the onMouseUp event associated with the PushButton

Parameters:

value - The onMouseUp

getOnMouseUp

public java.lang.String getOnMouseUp()

Gets the onMouseUp value associated with the PushButton

Returns:

The onMouseUp value

setOnKeyDown

public void setOnKeyDown(java.lang.String value)

Sets the onKeyDown event associated with the PushButton

Parameters:

value - The onKeyDown

getOnKeyDown

public java.lang.String getOnKeyDown()

Gets the onKeyDown value associated with the PushButton

Returns:

The onKeyDown value

setOnKeyPress

public void setOnKeyPress(java.lang.String value)

Sets the onKeyPress event associated with the PushButton

Parameters:

value - The onKeyPress

getOnKeyPress

public java.lang.String getOnKeyPress()

Gets the onKeyPress value associated with the PushButton

Returns:

The onKeyPress value

setOnKeyUp

public void setOnKeyUp(java.lang.String value)

Sets the onKeyUp event associated with the PushButton

Parameters:

value - The onKeyUp

getOnKeyUp

public java.lang.String getOnKeyUp()

Gets the onKeyUp value associated with the PushButton

Returns:

The onKeyUp value

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 BaseTag

Returns:

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

Throws:

javax.servlet.jsp.JspException - Thrown if a JspException occurs.

See Also:

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

applyAttributes

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

Sets the attributes (value, text) on the underlying Item object.

Overrides:

applyAttributes in class BaseTag

Throws:

javax.servlet.jsp.JspException - Thrown if a JspException 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 javax.servlet.jsp.tagext.TagSupport

Returns:

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

Throws:

javax.servlet.jsp.JspException