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

com.sas.taglib.servlet.tbeans.ipage.ITextTag

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

public class ITextTag

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

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

BaseIPage, IText, Serialized Form

Field Summary

static java.lang.String

RB_KEY ResourceBundle key

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS

Constructor Summary

ITextTag()

Method Summary

protected void	applyAttributes() Sets the attributes on the underlying IText object.
int	doEndTag() Process the end tag.
int	doStartTag() Process the start tag for this instance.
java.lang.String	getAcceptLabel() Get the acceptLabel String
java.lang.String	getAcceptURL() Get the acceptURL String
java.lang.String	getAlignment() Gets the alignment.
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
void	setAcceptLabel(java.lang.String acceptLabel) Set the acceptLabel String.
void	setAcceptURL(java.lang.String acceptURL) Set the acceptURL String to an href.
void	setAlignment(java.lang.String alignment) Sets the alignment.

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

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

RB_KEY

public static final java.lang.String RB_KEY

ResourceBundle key

See Also:

Constant Field Values

Constructor Detail

ITextTag

public ITextTag()

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.

setAcceptURL

public void setAcceptURL(java.lang.String acceptURL)

Set the acceptURL String to an href. On phones, this corresponds to a softkey whose destination is defined by the acceptURL parameter. In HTML, a link is used. To set the label associated with the URL, call setAcceptLabel. If no label is set, then the default label is used for most devices while the URL istself is used in HTML as the link description.

Parameters:

acceptURL - The acceptURL href String

setAcceptLabel

public void setAcceptLabel(java.lang.String acceptLabel)

Set the acceptLabel String. On phones, this corresponds to a softkey whose destination is defined by the acceptURL parameter and has a label specified by the acceptLabel String. setAcceptURL must be called with this method for a label to be shown.

Parameters:

acceptLabel - The label of the softkey button or link.

getAcceptURL

public java.lang.String getAcceptURL()

Get the acceptURL String

Returns:

String The acceptURL href String

getAcceptLabel

public java.lang.String getAcceptLabel()

Get the acceptLabel String

Returns:

String The acceptLabel for the accept String

setAlignment

public void setAlignment(java.lang.String alignment)

Sets the alignment. Valid values are "Left", "Right", and "Center" . The default value is "Left".

Parameters:

alignment - The horizontal alignment of the text ("Left"(default), "Right", or "Center").

getAlignment

public java.lang.String getAlignment()

Gets the alignment. Valid values are "Left", "Right", and "Center" . The default value is "Left".

Returns:

the horizontal alignment of the text.

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 a JspException occurs.

See Also:

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

applyAttributes

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

Sets the attributes on the underlying IText object.

Overrides:

applyAttributes in class BaseIPageTag

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 BaseTransformationBodyTag

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:

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