com.sas.taglib.servlet.tbeans.ipage
Class BaseIFormElementTag

com.sas.taglib.servlet.tbeans.ipage.BaseIFormElementTag

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:

IFormListBoxTag, IFormPasswordTag, IFormRadioTag, IFormTextEntryTag

public class BaseIFormElementTag

BaseIFormElementTag is the base class for other IForm sub element custom tag handlers for elements that do not have a body. BaseIFormElementTag is invoked by a tag on the JSP page 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.

See Also:

BaseIFormElement, Serialized Form

Field Summary

protected IForm

form Underlying IForm object

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS, RB_KEY

Constructor Summary

BaseIFormElementTag()

Method Summary

protected void	applyAttributes() Sets the attributes on the underlying ipage object.
java.lang.String	getAcceptLabel() Get the acceptLabel String
java.lang.String	getPrompt() Gets the prompt of the element.
java.lang.String	getShortPrompt() Gets the shortPrompt of the element.
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
void	setAcceptLabel(java.lang.String acceptLabel) Set the acceptLabel String to an href.
void	setPrompt(java.lang.String prompt) Sets the prompt of this element.
void	setShortPrompt(java.lang.String shortPrompt) Sets the shortPrompt of this element.

Methods inherited from class com.sas.taglib.servlet.tbeans.ipage.BaseIPageTag

getCacheTimeToLive, getTitle, setCacheTimeToLive, setTitle

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

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

form

protected IForm form

Underlying IForm object

Constructor Detail

BaseIFormElementTag

public BaseIFormElementTag()

Method Detail

initialize

protected void initialize(boolean includeAttributes)

Initializes attributes and variables for this tag handler.

Overrides:

initialize in class BaseIPageTag

Parameters:

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

setPrompt

public void setPrompt(java.lang.String prompt)

Sets the prompt of this element. This String is written out before the element. If a different prompt is desired for WML or HDML devices, use setShortPrompt. If shortPrompt is not set, then prompt is used for all markup languages. HTML always uses prompt.

Parameters:

prompt - The prompt String

getPrompt

public java.lang.String getPrompt()

Gets the prompt of the element.

Returns:

The prompt String

setShortPrompt

public void setShortPrompt(java.lang.String shortPrompt)

Sets the shortPrompt of this element. This String is written out before the element. The shortPrompt is used for WML or HDML output as an alternative to prompt. If not set, then prompt is used for all markup languages. HTML always uses prompt.

Parameters:

shortPrompt - The shortPrompt String

getShortPrompt

public java.lang.String getShortPrompt()

Gets the shortPrompt of the element.

Returns:

The shortPrompt String

setAcceptLabel

public void setAcceptLabel(java.lang.String acceptLabel)

Set the acceptLabel String to an href. On phones, this corresponds to a softkey whose destination is defined by the acceptURL parameter. Uses the acceptLabel parameter as a label for the softkey. Calls to the add method on the IForm bean will setup the accept destination to be the next element that has been added. On phones, the last element uses the IForm's action and actionLabel rather than the elements acceptURL and acceptLabel. In HTML, nothing is written for acceptURL or acceptLabel since it is not a card/deck based markup language. To support a wide range of devices, this String should be a maximum of 5 characters.

Parameters:

acceptLabel - The accept label String

getAcceptLabel

public java.lang.String getAcceptLabel()

Get the acceptLabel String

Returns:

String The acceptLabel for the accept String

applyAttributes

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

Sets the attributes on the underlying ipage object.

Overrides:

applyAttributes in class BaseIPageTag

Throws:

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