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

com.sas.taglib.servlet.tbeans.ipage.IMenuTag

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 IMenuTag

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

If you need to extend or modify the functionality of the sas:IMenu 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:IMenu 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, IMenu, IMenuItemTag, Serialized Form

Field Summary

static java.lang.String

RB_KEY

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS

Constructor Summary

IMenuTag()

Method Summary

protected void	applyAttributes() Sets the attributes on the underlying IMenu object.
int	doEndTag() Process the end tag.
int	doStartTag() Process the start tag for this instance.
java.util.Vector	getBodyDescriptions() Gets the body description Vector for this menu.
java.util.Vector	getBodyURLs() Gets the body URL Vector for this menu.
int	getEndIndex() Gets the endIndex property (String).
int	getMaxItemsDisplayed() Gets the maxItemsDisplayed property (String).
java.lang.String	getModel() Gets the model property (String).
java.lang.String	getmoreURL() Gets the moreURL property (String).
java.lang.String	getPostMenuText() Gets the postMenuText property (String).
java.lang.String	getPreMenuText() Gets the preMenuText property (String).
int	getStartIndex() Gets the startIndex property (String).
java.lang.String	getURLFormat() Gets the URLFormat property (String).
java.lang.String	getURLModel() Gets the URLModel property (String).
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
void	setEndIndex(int endIndex) Sets the endIndex property (int).
void	setMaxItemsDisplayed(int maxItemsDisplayed) Sets the maxItemsDisplayed property (int).
void	setModel(java.lang.String model) Sets the model property (String).
void	setMoreURL(java.lang.String moreURL) Sets the moreURL property (String).
void	setPostMenuText(java.lang.String postMenuText) Sets the postMenuText property (String).
void	setPreMenuText(java.lang.String preMenuText) Sets the preMenuText property (String).
void	setStartIndex(int startIndex) Sets the startIndex property (int).
void	setURLFormat(java.lang.String URLFormat) Sets the URLFormat property (String).
void	setURLModel(java.lang.String URLModel) Sets the URLModel property (String).

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

See Also:

Constant Field Values

Constructor Detail

IMenuTag

public IMenuTag()

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.

setPreMenuText

public void setPreMenuText(java.lang.String preMenuText)

Sets the preMenuText property (String). The preMenuText String is used to set the preMenuText of the Menu. This text is written before the menu is written.

Parameters:

preMenuText - The text to be displayed before the menu.

getPreMenuText

public java.lang.String getPreMenuText()

Gets the preMenuText property (String).

Returns:

the preMenuText String

setPostMenuText

public void setPostMenuText(java.lang.String postMenuText)

Sets the postMenuText property (String). The postMenuText String is used to set the postMenuText of the Menu. This text is written after the menu is written.

Parameters:

postMenuText - The text to be displayed after the menu.

getPostMenuText

public java.lang.String getPostMenuText()

Gets the postMenuText property (String).

Returns:

the postMenuText String

setURLFormat

public void setURLFormat(java.lang.String URLFormat)

Sets the URLFormat property (String). The URLFormat String is used to set the URLFormat of the Menu. When this format is set, this URL format String is used for every menu item. The String DEFAULT_MENU_MARKER, "##", is replaced with the corresponding values from the model.

Parameters:

URLFormat - When used this String will be used for every menu item. "##" is replaced with model values.

getURLFormat

public java.lang.String getURLFormat()

Gets the URLFormat property (String).

Returns:

the URLFormat String

setStartIndex

public void setStartIndex(int startIndex)

Sets the startIndex property (int). The startIndex String is used to select the start index item of the model to be written in the menu. The default is 0 (first item). The startIndex String should be an integer value.

Parameters:

startIndex - The starting index in the menu

getStartIndex

public int getStartIndex()

Gets the startIndex property (String).

Returns:

the startIndex String

setEndIndex

public void setEndIndex(int endIndex)

Sets the endIndex property (int). The endIndex String is used to select the end index item of the model to be written in the menu. The default is -1 (last item). The endIndex String should be an integer value.

Parameters:

endIndex - The ending index in the menu

getEndIndex

public int getEndIndex()

Gets the endIndex property (String).

Returns:

the endIndex String

setMaxItemsDisplayed

public void setMaxItemsDisplayed(int maxItemsDisplayed)

Sets the maxItemsDisplayed property (int). The maxItemsDisplayed String is used to select the maximum number of items displayed in the menu. For card based markup languages (WML,HDML), the menu will create a link to the next card of maxitemsdisplayed items. The maxItemsDisplayed String should be an integer value.

Parameters:

maxItemsDisplayed - The maximum number of items displayed at a time in the menu.

getMaxItemsDisplayed

public int getMaxItemsDisplayed()

Gets the maxItemsDisplayed property (String).

Returns:

the maxItemsDisplayed String

setModel

public void setModel(java.lang.String model)

Sets the model property (String). The model String is used to find the model (with in the specified scope) to create the Custom Tag against.

Parameters:

model - The model to be used for the menu items names.

getModel

public java.lang.String getModel()

Gets the model property (String).

Returns:

the model String

setURLModel

public void setURLModel(java.lang.String URLModel)

Sets the URLModel property (String). The URLModel String is used to find the URLModel (within the specified scope) to create the Custom Tag against.

Parameters:

URLModel - The URL model (destinations) to be used for the menu.

getURLModel

public java.lang.String getURLModel()

Gets the URLModel property (String).

Returns:

the URLModel String

setMoreURL

public void setMoreURL(java.lang.String moreURL)

Sets the moreURL property (String). The moreURL sets the URL when there are multiple pages.

Parameters:

moreURL - The URL for the next page

getmoreURL

public java.lang.String getmoreURL()

Gets the moreURL property (String).

Returns:

the moreURL String

getBodyURLs

public java.util.Vector getBodyURLs()

Gets the body URL Vector for this menu. Each element in the URL Vector corresponds to an element in the description Vector.

Returns:

the Vector of body URL

getBodyDescriptions

public java.util.Vector getBodyDescriptions()

Gets the body description Vector for this menu. Each element in the description Vector corresponds to an element in the URL Vector.

Returns:

the Vector of body descriptions

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