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

com.sas.taglib.servlet.tbeans.ipage.IFormTag

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 IFormTag

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

If you need to extend or modify the functionality of the sas:IForm 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:IForm 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, IForm, IFormTextEntryTag, IFormPasswordTag, IFormRadioTag, IFormListBoxTag, IFormHiddenTag, Serialized Form

Field Summary

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS

Constructor Summary

IFormTag()

Method Summary

protected void	applyAttributes() Sets the attributes on the custom tag
int	doEndTag() Process the end tag.
int	doStartTag() Process the start tag for this instance.
java.lang.String	getAction() Gets the URL which is used to post forms
java.lang.String	getActionLabel() Gets the URL label which is used to post forms
java.lang.String	getMethod() Gets the HTTP method to be used when sending the form contents
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
void	setAction(java.lang.String action) Sets the URL which is used to post forms via email or a server-side form handler (such as a servlet or JSP page) via HTTP.
void	setActionLabel(java.lang.String actionLabel) Sets the URL label which is used to post forms.
void	setMethod(java.lang.String method) Sets the HTTP method to be used when sending the form contents to the server.

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

Constructor Detail

IFormTag

public IFormTag()

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.

setMethod

public void setMethod(java.lang.String method)

Sets the HTTP method to be used when sending the form contents to the server. Valid values are "get" and "post". The default value is "get"

Parameters:

method - The HTTP method. Valid values are "get"(default) or "post".

getMethod

public java.lang.String getMethod()

Gets the HTTP method to be used when sending the form contents

Returns:

The HTTP method

setAction

public void setAction(java.lang.String action)

Sets the URL which is used to post forms via email or a server-side form handler (such as a servlet or JSP page) via HTTP.

Parameters:

action - The action URL to post forms.

getAction

public java.lang.String getAction()

Gets the URL which is used to post forms

Returns:

The action URL

setActionLabel

public void setActionLabel(java.lang.String actionLabel)

Sets the URL label which is used to post forms. The default is "Submit" for HTML and "OK" for phones.

Parameters:

actionLabel - The action URL to post forms.

getActionLabel

public java.lang.String getActionLabel()

Gets the URL label which is used to post forms

Returns:

The action URL label

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 custom tag

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)