com.sas.taglib.servlet.tbeans
Class TreeNodeTag

com.sas.taglib.servlet.tbeans.TreeNodeTag

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 TreeNodeTag

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

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

TreeNode, Serialized Form

Field Summary

Fields inherited from class com.sas.taglib.BaseBodyTag

DELIMITERS

Constructor Summary

TreeNodeTag()

Method Summary

protected void	applyAttributes() Sets the attributes on the underlying TreeNode object.
int	doEndTag() Process the end tag.
int	doStartTag() Process the start tag for this instance.
java.lang.String	getAccessKey() getAccessKey returns the accesskey for URL accessability.
java.lang.String	getDefaultImage() Gets the defaultImage property (String).
java.lang.String	getDefaultImageAltText() getDefaultImageAltText reutrns the text which is to be used as alternate to an image.
java.lang.String	getDescription() Returns the description of this node.
java.lang.String	getExpandedImage() Gets the expandedImage property (String).
java.lang.String	getExpandedImageAltText() getExpandedImageAltText returns the alternate text to the expanded image.
java.lang.String	getName() Gets the name property (String).
int	getTabIndex() getTabIndex returns the tab order value of the node.
java.lang.String	getTarget() Returns the value of the target= argument used on the anchor tags generated.
java.lang.String	getText() Gets the text property (String).
java.lang.String	getTitle() getTitle returns the title to the URL link.
java.lang.String	getURL() Gets the URL property (String).
protected void	initialize(boolean includeAttributes) Initializes attributes and variables for this tag handler.
boolean	isExpanded() Returns the expandedState boolean value which determines if a node is initially set expanded when rendered.
void	setAccessKey(java.lang.String accessKey) setAccessKey sets the accesskey if a URL link is being used.
void	setDefaultImage(java.lang.String defaultImage) Sets the defaultImage property (String).
void	setDefaultImageAltText(java.lang.String defaultImageAltText) setDefaultImageAltText sets the text used to describe an image in the viewer.
void	setDescription(java.lang.String desc) Sets the description associated with this node.
void	setExpanded(boolean expanded) sets the expandedState of the node
void	setExpandedImage(java.lang.String expandedImage) Sets the expandedImage property (String).
void	setExpandedImageAltText(java.lang.String expandedImageAltText) setExpandedImageAltText sets the alternate text to the expanded image in the viewer.
void	setName(java.lang.String name) Sets the name property (String).
void	setTabIndex(int tabIndex) setTabIndex sets the tabbing order for access in viewer.
void	setTarget(java.lang.String target) Sets the value of the target= argument used on the anchor tags generated.
void	setText(java.lang.String text) Sets the text property (String).
void	setTitle(java.lang.String title) setTitle sets the title to the URL link in the viewer.
void	setURL(java.lang.String URL) Sets the URL property (String).

Methods inherited from class com.sas.taglib.BaseBodyTag

doCatch, doFinally, getApplyAttributes, getBodyStrings, getCompositeComponentKey, getInstantiate, getLocale, getPageContext, getRef, getScope, getTagScope, getWrappedClassName, getWrappedObject, getWrappedObject, loadBeanInstance, newInstance, release, removeFromScope, searchContext, setApplyAttributes, setCompositeComponentKey, setInstantiate, setLocale, setRef, setScope, setTagScope, setVariableWithinScope, setWrappedClassName, setWrappedObject, validate

Constructor Detail

TreeNodeTag

public TreeNodeTag()

Method Detail

initialize

protected void initialize(boolean includeAttributes)

Initializes attributes and variables for this tag handler.

Overrides:

initialize in class BaseBodyTag

Parameters:

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

setName

public void setName(java.lang.String name)

Sets the name property (String). The name String name of the node.

Parameters:

name - the name String

getName

public java.lang.String getName()

Gets the name property (String).

Returns:

the name String

setDefaultImage

public void setDefaultImage(java.lang.String defaultImage)

Sets the defaultImage property (String). The defaultImage String defaultImage of the node.

Parameters:

defaultImage - the defaultImage String

getDefaultImage

public java.lang.String getDefaultImage()

Gets the defaultImage property (String).

Returns:

the defaultImage String

setExpandedImage

public void setExpandedImage(java.lang.String expandedImage)

Sets the expandedImage property (String). The expandedImage String expandedImage of the node.

Parameters:

expandedImage - the expandedImage String

getExpandedImage

public java.lang.String getExpandedImage()

Gets the expandedImage property (String).

Returns:

the expandedImage String

setURL

public void setURL(java.lang.String URL)

Sets the URL property (String). The URL String URL link of the node.

Parameters:

URL - the URL String

getURL

public java.lang.String getURL()

Gets the URL property (String).

Returns:

the URL String

setText

public void setText(java.lang.String text)

Sets the text property (String). The URL String text of the node.

Parameters:

text - the text String

getText

public java.lang.String getText()

Gets the text property (String).

Returns:

the text String

setExpanded

public void setExpanded(boolean expanded)

sets the expandedState of the node

Parameters:

expanded - the expanded state of the node

isExpanded

public boolean isExpanded()

Returns the expandedState boolean value which determines if a node is initially set expanded when rendered.

Returns:

boolean value which determines the expanded state of the node.

setAccessKey

public void setAccessKey(java.lang.String accessKey)

setAccessKey sets the accesskey if a URL link is being used. This allows the user to access the link via the keyboard. For example, if the accesskey is set to "C", a user can use the Alt-C combination to go to the link text and press enter to activate the link.

Parameters:

accessKey - key entry used as access key for link.

getAccessKey

public java.lang.String getAccessKey()

getAccessKey returns the accesskey for URL accessability. This allows a user to access a link using the Alt-'key' comination to access a link.

Returns:

accessKey key entry used as access key for link.

setTabIndex

public void setTabIndex(int tabIndex)

setTabIndex sets the tabbing order for access in viewer. This is mainly used with the HTML TreeView TreeView.

Parameters:

tabIndex - the numeric order in which the tab key is used.

getTabIndex

public int getTabIndex()

getTabIndex returns the tab order value of the node. The tab order is the order in which the tab key will follow when tabbing in the viewer.

Returns:

tabIndex

setDefaultImageAltText

public void setDefaultImageAltText(java.lang.String defaultImageAltText)

setDefaultImageAltText sets the text used to describe an image in the viewer.

Parameters:

defaulImageAltText - alternate text for the image displayed in the viewer.

getDefaultImageAltText

public java.lang.String getDefaultImageAltText()

getDefaultImageAltText reutrns the text which is to be used as alternate to an image.

Returns:

defaultImageAltText text used as an alternative to the image.

setExpandedImageAltText

public void setExpandedImageAltText(java.lang.String expandedImageAltText)

setExpandedImageAltText sets the alternate text to the expanded image in the viewer.

Parameters:

expandedImageAltText -

getExpandedImageAltText

public java.lang.String getExpandedImageAltText()

getExpandedImageAltText returns the alternate text to the expanded image.

Returns:

expandedImageAltText

setTitle

public void setTitle(java.lang.String title)

setTitle sets the title to the URL link in the viewer. This title should be a short but descriptive title to where the URL link will take them.

Parameters:

title - descriptive title of the URL link.

getTitle

public java.lang.String getTitle()

getTitle returns the title to the URL link. This title is a short but descriptive title to where the URL link will take them.

Returns:

title descriptive title to the URL link

setDescription

public void setDescription(java.lang.String desc)

Sets the description associated with this node.

Parameters:

desc - The description of the node

getDescription

public java.lang.String getDescription()

Returns the description of this node.

Returns:

the description of the node

getTarget

public java.lang.String getTarget()

Returns the value of the target= argument used on the anchor tags generated. This value determines where/how the links associated with the nodes on the tree are displayed.

Returns:

target= argument of each folders anchor tag.

setTarget

public void setTarget(java.lang.String target)

Sets the value of the target= argument used on the anchor tags generated. This value determines where/how the links associated with the nodes on the tree are displayed.

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 BaseBodyTag

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 TreeNode object.

Overrides:

applyAttributes in class BaseBodyTag

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 javax.servlet.jsp.tagext.BodyTagSupport

Returns:

int designating the next course of action for the tag/jsp page.

Throws:

javax.servlet.jsp.JspException