com.sas.models
Interface TreeNodeV2Interface

All Superinterfaces:
NodeInterface, SimpleNodeInterface, TreeNodeInterface
All Known Implementing Classes:
LevelTreeNode, ProgressiveLevelTreeNode, TreeNode, TreeNodeAdaptor

public interface TreeNodeV2Interface
extends TreeNodeInterface

TreeNodeV2Interface is an interface for creating tree node.

See Also:
TreeNode

Method Summary
abstract  java.lang.String getAcessKey()
          getAccessKey returns the accesskey for URL accessability.
abstract  java.lang.String getDefaultImageAltText()
          getDefaultImageAltText reutrns the text which is to be used as alternate to an image.
abstract  java.lang.String getDescription()
          Returns the description of this node.
abstract  java.lang.String getExpandedImageAltText()
          getExpandedImageAltText returns the alternate text to the expanded image.
abstract  int getTabIndex()
          getTabIndex returns the tab order value of the node.
abstract  java.lang.String getTitle()
          getTitle returns the title to the URL link.
abstract  void setAccessKey(java.lang.String accessKey)
          setAccessKey sets the accesskey if a URL link is being used.
abstract  void setDefaultImageAltText(java.lang.String defaultImageAltText)
          setDefaultImageAltText sets the text used to describe an image in the viewer.
abstract  void setDescription(java.lang.String desc)
          Sets the description associated with this node.
abstract  void setExpandedImageAltText(java.lang.String expandedImageAltText)
          setExpandedImageAltText sets the alternate text to the expanded image in the viewer.
abstract  void setTabIndex(int tabIndex)
          setTabIndex sets the tabbing order for access in viewer.
abstract  void setTitle(java.lang.String title)
          setTitle sets the title to the URL link in the viewer.
 
Methods inherited from interface com.sas.models.TreeNodeInterface
getDefaultImage, getExpandedImage, getName, getText, getURL, isExpanded, isLastNode, setDefaultImage, setExpanded, setExpandedImage, setLastNode, setName, setText, setURL
 
Methods inherited from interface com.sas.models.NodeInterface
getNodeExpandedText, getNodeText, getNodeType
 
Methods inherited from interface com.sas.models.SimpleNodeInterface
countNodeChildren, getNodeChild, getNodeChildCount, getNodeChildren, isLeafNode
 

Method Detail

setAccessKey

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.

getAcessKey

java.lang.String getAcessKey()
getAccessKey returns the accesskey for URL accessability. This allows a user to access a link using the Alt-'key' comination to access a link.


setTabIndex

void setTabIndex(int tabIndex)
setTabIndex sets the tabbing order for access in viewer. This is mainly used with the HTML TreeView.

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

getTabIndex

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.


setDefaultImageAltText

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

java.lang.String getDefaultImageAltText()
getDefaultImageAltText reutrns the text which is to be used as alternate to an image.


setExpandedImageAltText

void setExpandedImageAltText(java.lang.String expandedImageAltText)
setExpandedImageAltText sets the alternate text to the expanded image in the viewer.

Parameters:
expandedImageAltText -

getExpandedImageAltText

java.lang.String getExpandedImageAltText()
getExpandedImageAltText returns the alternate text to the expanded image.


setTitle

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

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

void setDescription(java.lang.String desc)
Sets the description associated with this node.

Parameters:
desc - The description of the node

getDescription

java.lang.String getDescription()
Returns the description of this node.

Returns:
the description of the node



Copyright © 2009 SAS Institute Inc. All Rights Reserved.