com.sas.taglib.servlet.tbeans.navigationbar
Class NavigationBarTag

com.sas.taglib.servlet.tbeans.navigationbar.NavigationBarTag

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:

TableColumnNavigationBarTag, TableRowNavigationBarTag

public class NavigationBarTag

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

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

NavigationBar, Serialized Form

Field Summary

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS, RB_KEY

Constructor Summary

NavigationBarTag()

Method Summary

protected void	applyAttributes() Apply TableView properties to the underlying NavigationBar object
int	doEndTag() This method processes the end tag for this instance.
int	doStartTag() Processes the start tag for this instance.
java.lang.String	getModel() Returns the model property of the NavigationBarTag.
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
void	setModel(java.lang.String model) Sets the model property of the NavigationBarTag.

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

getActionProvider, setActionProvider

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

getTemplate, getTemplateDictionary, getTemplateFile, getTemplateFileName, getTemplateLocation, setTemplate, setTemplateDictionary, setTemplateFile, setTemplateFileName, setTemplateLocation

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

NavigationBarTag

public NavigationBarTag()

Method Detail

initialize

protected void initialize(boolean includeAttributes)

Initializes attributes and variables for this tag handler.

Overrides:

initialize in class BaseActionCompositeTransformationBodyTag

Parameters:

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

setModel

public void setModel(java.lang.String model)

Sets the model property of the NavigationBarTag.

Parameters:

model - The model of the NavigationBar. It must implement com.sas.servlet.tbeans.navigationbar.BaseNavigationInterface.

getModel

public java.lang.String getModel()

Returns the model property of the NavigationBarTag.

Returns:

the String that represents the com.sas.servlet.tbeans.navigationbar.BaseNavigationInterface instance to use as the model

applyAttributes

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

Apply TableView properties to the underlying NavigationBar object

Overrides:

applyAttributes in class BaseActionCompositeTransformationBodyTag

Throws:

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

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 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()

doEndTag

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

This method processes the end tag for this instance. The doEndTag() method will render the underlying tbean unless it has a parent.

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)