Tree Class

com.bea.wlw.netui.tags.html
Tree Class

public class Tree

    extends DataSourceTag

Netui tag that renders a tree control represented by a set of TreeNode objects.

Attribute Descriptions
AttributeRequiredRuntime Expression EvaluationData Bindable
actionYesNoNo
Hyperlink to which expand/contract actions should be sent.
imageHandleDownLastNoNoNo
The image name for an open non-leaf node with no line below it.
imageHandleDownMiddleNoNoNo
The image name for an open non-leaf node with a line below it.
imageHandleRightLastNoNoNo
The image name for a closed non-leaf node with no line below it.
imageHandleRightMiddleNoNoNo
The image name for a closed non-leaf node with a line below it.
imageLineLastNoNoNo
The image name for a blank area of the tree.
imageLineMiddleNoNoNo
The image name for an area with a line through it.
imageLineVerticalNoNoNo
The image name for an area with a line through it.
imageRootNoNoNo
The name of the directory containing the images for our icons, relative to the page including this tag.
styleNoNoNo
CSS style class to be applied to be applied to the entire rendered output of the tree control.
styleSelectedNoNoNo
CSS style class to be applied to the text of any element that is currently selected.
styleUnselectedNoNoNo
CSS style class to be applied to the text of any element that is not currently selected.
treeYesNoRead/Write
Attribute name in the session or expression under which the root TreeNode of the tree we are rendering is stored.

Related Topics

<netui:tree> Tag Sample
Node
TreeNode


Hierarchy
Object
  TagSupport
    BodyTagSupport
      AbstractBaseTag
        DataSourceTag
          Tree
All Implemented Interfaces

BodyTag, IterationTag, Serializable, Tag

Field Summary

protected String
action
The hyperlink to be used for submitting requests to expand and contract tree nodes.
protected String
imageHandleDownLast
String
protected String
imageHandleDownMiddle
String
protected String
imageHandleRightLast
String
protected String
imageHandleRightMiddle
String
protected String
imageLineLast
String
protected String
imageLineMiddle
String
protected String
imageLineVertical
String
protected String
imageRoot
The name of the directory containing the images for our icons, relative to the page including this tag.
protected TreeNode
rootNode
TreeNode
protected String
style
The CSS style class to be applied to the entire tree.
protected String
styleSelected
The CSS style class to be applied to the text of selected nodes.
protected String
styleUnselected
The CSS style class to be applied to the text of unselected nodes.
protected String
tree
The name of the attribute (in the specified scope) under which our TreeControl instance is stored.
   
Fields from  com.bea.wlw.netui.tags.AbstractBaseTag
ATTR_GENERAL, ATTR_GENERAL_EXPRESSION, ATTR_JAVASCRIPT, ATTR_STYLE, CLASS, ID, JAVASCRIPT_STATUS, NAME, NETUI_UNIQUE_CNT, ONCLICK, ONDBLCLICK, ONKEYDOWN, ONKEYPRESS, ONKEYUP, ONMOUSEDOWN, ONMOUSEMOVE, ONMOUSEOUT, ONMOUSEOVER, ONMOUSEUP, STYLE, TABINDEX
 
Fields from  javax.servlet.jsp.tagext.BodyTagSupport
bodyContent
 
Fields from  javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields from interface javax.servlet.jsp.tagext.BodyTag
EVAL_BODY_BUFFERED, EVAL_BODY_TAG
 
Fields from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 

Constructor Summary

Tree()

 

Method Summary

public int
doEndTag()
Render this Tree control.
public int
doStartTag()
Prepare the Tree for rendering.
public String
getAction()
Gets the action used for expanding and contracting tree nodes.
public String
getImageHandleDownLast()
Gets the image name for an open non-leaf node with no line below it.
public String
getImageHandleDownMiddle()
Gets the image name for an open non-leaf node with a line below it.
public String
getImageHandleRightLast()
Gets the image name for a closed non-leaf node with no line below it.
public String
getImageHandleRightMiddle()
Gets the image name for a closed non-leaf node with a line below it.
public String
getImageLineLast()
Gets the image name for a blank area of the tree.
public String
getImageLineMiddle()
Gets the image name for an area with a line through it.
public String
getImageLineVertical()
Gets the image name for an area with a line through it.
public String
getImageRoot()
Gets the name of the directory containing the images for our icons, relative to the page including this tag.
public TreeNode
getRootNode()
Gets the root TreeNode of this tree.
public String
getStyle()
Gets the CSS style class to be applied to the entire tree.
public String
getStyleSelected()
Gets the CSS style class to be applied to the text of selected nodes.
public String
getStyleUnselected()
Gets the CSS style class to be applied to the text of unselected nodes.
public String
getTagName()
Return the name of the Tag.
public String
getTree()
Gets the name of the attribute (in the session), or expression, under which the root TreeNode instance is stored.
protected void
localRelease()
Release all state information set by this tag.
public void
setAction(String action)
Sets the action used for expanding and contracting tree nodes.
public void
setImageHandleDownLast(String imageHandleDownLast)
Sets the image name for an open non-leaf node with no line below it.
public void
setImageHandleDownMiddle(String imageHandleDownMiddle)
Sets the image name for an open non-leaf node with a line below it.
public void
setImageHandleRightLast(String imageHandleRightLast)
Sets the image name for a closed non-leaf node with no line below it.
public void
setImageHandleRightMiddle(String imageHandleRightMiddle)
Sets the image name for a closed non-leaf node with a line below it.
public void
setImageLineLast(String imageLineLast)
Sets the image name for a blank area of the tree.
public void
setImageLineMiddle(String imageLineMiddle)
Sets the image name for an area with a line through it.
public void
setImageLineVertical(String imageLineVertical)
Sets the image name for an area with a line through it.
public void
setImageRoot(String imageRoot)
Sets the name of the directory containing the images for our icons, relative to the page including this tag.
public void
setRootNode(TreeNode rootNode)
Sets the root TreeNode of this tree.
public void
setStyle(String style)
Sets the CSS style class to be applied to the entire tree.
public void
setStyleSelected(String styleSelected)
Sets the CSS style class to be applied to the text of selected nodes.
public void
setStyleUnselected(String styleUnselected)
Sets the CSS style class to be applied to the text of unselected nodes.
public void
setTree(String tree)
Sets the name of the attribute (in the session), or expression, under which the root TreeNode instance is stored.
 
Methods from  com.bea.wlw.netui.tags.DataSourceTag
getDataSource, setDataSource
 
Methods from  com.bea.wlw.netui.tags.AbstractBaseTag
addTagIdMapping, evaluateAttributeToString, filter, filter, getJavaScriptUtils, getNearestForm, getScriptReporter, getUserLocale, localRelease, registerTagError, release, renderAttribute, rewriteName, write
 
Methods from  javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent
 
Methods from  javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface javax.servlet.jsp.tagext.BodyTag
doInitBody, setBodyContent
 
Methods from interface javax.servlet.jsp.tagext.IterationTag
doAfterBody
 
Methods from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, release, setPageContext, setParent
 

Field Detail

action

protected String action
The hyperlink to be used for submitting requests to expand and contract tree nodes. The placeholder "${name}" will be replaced by the name property of the current tree node.


imageHandleDownLast

protected String imageHandleDownLast


imageHandleDownMiddle

protected String imageHandleDownMiddle


imageHandleRightLast

protected String imageHandleRightLast


imageHandleRightMiddle

protected String imageHandleRightMiddle


imageLineLast

protected String imageLineLast


imageLineMiddle

protected String imageLineMiddle


imageLineVertical

protected String imageLineVertical


imageRoot

protected String imageRoot
The name of the directory containing the images for our icons, relative to the page including this tag.


rootNode

protected TreeNode rootNode


style

protected String style
The CSS style class to be applied to the entire tree.


styleSelected

protected String styleSelected
The CSS style class to be applied to the text of selected nodes.


styleUnselected

protected String styleUnselected
The CSS style class to be applied to the text of unselected nodes.


tree

protected String tree
The name of the attribute (in the specified scope) under which our TreeControl instance is stored.

 

Constructor Detail

Tree

public Tree()
 

Method Detail

doEndTag() Method

public int doEndTag()
throws JspException
Render this Tree control.

Overrides
BodyTagSupport.doEndTag()

Exceptions

JspException
if a processing error occurs

doStartTag() Method

public int doStartTag()
throws JspException
Prepare the Tree for rendering.

Overrides
BodyTagSupport.doStartTag()

Exceptions

JspException
if a JSP exception has occurred

getAction() Method

public String getAction()
Gets the action used for expanding and contracting tree nodes.

Returns

the action

getImageHandleDownLast() Method

public String getImageHandleDownLast()
Gets the image name for an open non-leaf node with no line below it.

Returns

the image name (including extension)

getImageHandleDownMiddle() Method

public String getImageHandleDownMiddle()
Gets the image name for an open non-leaf node with a line below it.

Returns

the image name (including extension)

getImageHandleRightLast() Method

public String getImageHandleRightLast()
Gets the image name for a closed non-leaf node with no line below it.

Returns

the image name (including extension)

getImageHandleRightMiddle() Method

public String getImageHandleRightMiddle()
Gets the image name for a closed non-leaf node with a line below it.

Returns

the image name (including extension)

getImageLineLast() Method

public String getImageLineLast()
Gets the image name for a blank area of the tree.

Returns

the image name (including extension)

getImageLineMiddle() Method

public String getImageLineMiddle()
Gets the image name for an area with a line through it.

Returns

the image name (including extension)

getImageLineVertical() Method

public String getImageLineVertical()
Gets the image name for an area with a line through it.

Returns

the image name (including extension)

getImageRoot() Method

public String getImageRoot()
Gets the name of the directory containing the images for our icons, relative to the page including this tag.

Returns

the directory name

getRootNode() Method

public TreeNode getRootNode()
Gets the root TreeNode of this tree.

Returns

the root TreeNode

getStyle() Method

public String getStyle()
Gets the CSS style class to be applied to the entire tree.

Returns

the style

getStyleSelected() Method

public String getStyleSelected()
Gets the CSS style class to be applied to the text of selected nodes.

Returns

the selected style

getStyleUnselected() Method

public String getStyleUnselected()
Gets the CSS style class to be applied to the text of unselected nodes.

Returns

the unselected style

getTagName() Method

public String getTagName()
Return the name of the Tag.

Overrides
AbstractBaseTag.getTagName()

getTree() Method

public String getTree()
Gets the name of the attribute (in the session), or expression, under which the root TreeNode instance is stored.

Returns

the tree attribute name

localRelease() Method

protected void localRelease()
Release all state information set by this tag.

Overrides
DataSourceTag.localRelease()

setAction(String) Method

public void setAction(String action)
Sets the action used for expanding and contracting tree nodes.

Parameters

action
- the action

setImageHandleDownLast(String) Method

public void setImageHandleDownLast(String imageHandleDownLast)
Sets the image name for an open non-leaf node with no line below it. (Defaults to "handledownlast.gif").

Parameters

imageHandleDownLast
- the image name (including extension)

setImageHandleDownMiddle(String) Method

public void setImageHandleDownMiddle(String imageHandleDownMiddle)
Sets the image name for an open non-leaf node with a line below it. (Defaults to "handledownmiddle.gif").

Parameters

imageHandleDownMiddle
- the image name (including extension)

setImageHandleRightLast(String) Method

public void setImageHandleRightLast(String imageHandleRightLast)
Sets the image name for a closed non-leaf node with no line below it. (Defaults to "handlerightlast.gif").

Parameters

imageHandleRightLast
- the image name (including extension)

setImageHandleRightMiddle(String) Method

public void setImageHandleRightMiddle(String imageHandleRightMiddle)
Sets the image name for a closed non-leaf node with a line below it. (Defaults to "handlerightmiddle.gif").

Parameters

imageHandleRightMiddle
- the image name (including extension)

setImageLineLast(String) Method

public void setImageLineLast(String imageLineLast)
Sets the image name for a blank area of the tree. (Defaults to "linelastnode.gif").

Parameters

imageLineLast
- the image name (including extension)

setImageLineMiddle(String) Method

public void setImageLineMiddle(String imageLineMiddle)
Sets the image name for an area with a line through it. (Defaults to "linemiddlenode.gif").

Parameters

imageLineMiddle
- the image name (including extension)

setImageLineVertical(String) Method

public void setImageLineVertical(String imageLineVertical)
Sets the image name for an area with a line through it. (Defaults to "linevertical.gif").

Parameters

imageLineVertical
- the image name (including extension)

setImageRoot(String) Method

public void setImageRoot(String imageRoot)
Sets the name of the directory containing the images for our icons, relative to the page including this tag.

Parameters

imageRoot
- the directory name

setRootNode(TreeNode) Method

public void setRootNode(TreeNode rootNode)
Sets the root TreeNode of this tree.

Parameters

rootNode
- the root treeNode

setStyle(String) Method

public void setStyle(String style)
Sets the CSS style class to be applied to the entire tree.

Parameters

style
- the style

setStyleSelected(String) Method

public void setStyleSelected(String styleSelected)
Sets the CSS style class to be applied to the text of selected nodes.

Parameters

styleSelected
- the selected style

setStyleUnselected(String) Method

public void setStyleUnselected(String styleUnselected)
Sets the CSS style class to be applied to the text of unselected nodes.

Parameters

styleUnselected
- the unselected style

setTree(String) Method

public void setTree(String tree)
Sets the name of the attribute (in the session), or expression, under which the root TreeNode instance is stored.

Parameters

tree
- the tree attribute name