| java.lang.Object
 org.apache.webapp.admin.TreeControlNode
| TreeControlNode | | public class TreeControlNode implements Serializable(Code) | | An individual node of a tree control represented by an instance of
TreeControl, and rendered by an instance of
TreeControlTag.
author:
Jazmin Jonson
author:
Craig R. McClanahan
version:
$Revision: 516448 $ $Date: 2007-03-09 17:25:47 +0100 (Fri, 09 Mar 2007) $ |
| Field Summary | |
| protected String | CSSClass
| | protected String | action
The hyperlink to which control will be directed if this node
is selected by the user. | | protected ArrayList | children
The set of child TreeControlNodes for this node, in the
order that they should be displayed. | | protected String | domain
The domain of this node. | | protected boolean | expandWhenClicked
| | protected boolean | expanded
| | protected String | icon
The pathname to the icon file displayed when this node is visible,
relative to the image directory for our images. | | protected String | label
The label that will be displayed when this node is visible. | | protected boolean | last
| | protected boolean | lazy
| | protected boolean | leaf
Is this a "leaf" node (i.e. | | protected boolean | loaded
| | protected String | name
The unique (within the entire tree) name of this node. | | protected TreeControlNode | parent
The parent node of this node, or null if this
is the root node. | | protected boolean | selected
| | protected String | target
The window target for the hyperlink identified by the
action property, if this node is selected
by the user. | | protected String | title
The label that will be displayed when this node is visible. | | protected TreeControl | tree
The TreeControl instance representing the
entire tree. | | protected int | width
The display width necessary to display this item (if it is visible). |
| Constructor Summary | |
| public | TreeControlNode(String name, String icon, String label, String action, String target, boolean expanded, String domain)
Construct a new TreeControlNode with the specified parameters. | | public | TreeControlNode(String name, String icon, String label, String action, String target, boolean expanded, String domain, String CSSClass)
Construct a new TreeControlNode with the specified parameters. | | public | TreeControlNode(String name, String icon, String label, String action, String target, boolean expanded, String domain, String CSSClass, boolean lazy)
Construct a new TreeControlNode with the specified parameters. |
| action | | protected String action(Code) | | The hyperlink to which control will be directed if this node
is selected by the user.
|
| children | | protected ArrayList children(Code) | | The set of child TreeControlNodes for this node, in the
order that they should be displayed.
|
| domain | | protected String domain(Code) | | The domain of this node.
|
| expandWhenClicked | | protected boolean expandWhenClicked(Code) | | |
| expanded | | protected boolean expanded(Code) | | Is this node currently expanded?
|
| icon | | protected String icon(Code) | | The pathname to the icon file displayed when this node is visible,
relative to the image directory for our images.
|
| label | | protected String label(Code) | | The label that will be displayed when this node is visible.
|
| last | | protected boolean last(Code) | | Is this the last node in the set of children for our parent node?
|
| lazy | | protected boolean lazy(Code) | | |
| leaf | | protected boolean leaf(Code) | | Is this a "leaf" node (i.e. one with no children)?
|
| loaded | | protected boolean loaded(Code) | | |
| name | | protected String name(Code) | | The unique (within the entire tree) name of this node.
|
| parent | | protected TreeControlNode parent(Code) | | The parent node of this node, or null if this
is the root node.
|
| selected | | protected boolean selected(Code) | | Is this node currently selected?
|
| target | | protected String target(Code) | | The window target for the hyperlink identified by the
action property, if this node is selected
by the user.
|
| title | | protected String title(Code) | | The label that will be displayed when this node is visible.
|
| tree | | protected TreeControl tree(Code) | | The TreeControl instance representing the
entire tree.
|
| width | | protected int width(Code) | | The display width necessary to display this item (if it is visible).
If this item is not visible, the calculated width will be that of our
most immediately visible parent.
|
| TreeControlNode | | public TreeControlNode(String name, String icon, String label, String action, String target, boolean expanded, String domain)(Code) | | Construct a new TreeControlNode with the specified parameters.
Parameters:
name - Internal name of this node (must be unique withinthe entire tree)
Parameters:
icon - Pathname of the image file for the icon to be displayedwhen this node is visible, relative to the image directoryfor our images
Parameters:
label - The label that will be displayed to the user ifthis node is visible
Parameters:
action - The hyperlink to be selected if the userselects this node, or null if this node's label shouldnot be a hyperlink
Parameters:
target - The window target in which the actionhyperlink's results will be displayed, or null forthe current window
Parameters:
expanded - Should this node be expanded?
Parameters:
domain - Identifier for the kind of node. |
| TreeControlNode | | public TreeControlNode(String name, String icon, String label, String action, String target, boolean expanded, String domain, String CSSClass)(Code) | | Construct a new TreeControlNode with the specified parameters.
Parameters:
name - Internal name of this node (must be unique withinthe entire tree)
Parameters:
icon - Pathname of the image file for the icon to be displayedwhen this node is visible, relative to the image directoryfor our images
Parameters:
label - The label that will be displayed to the user ifthis node is visible
Parameters:
action - The hyperlink to be selected if the userselects this node, or null if this node's label shouldnot be a hyperlink
Parameters:
target - The window target in which the actionhyperlink's results will be displayed, or null forthe current window
Parameters:
expanded - Should this node be expanded?
Parameters:
domain - Identifier for the kind of node.
Parameters:
CSSClass - The css class to apply to the node |
| TreeControlNode | | public TreeControlNode(String name, String icon, String label, String action, String target, boolean expanded, String domain, String CSSClass, boolean lazy)(Code) | | Construct a new TreeControlNode with the specified parameters.
Parameters:
name - Internal name of this node (must be unique withinthe entire tree)
Parameters:
icon - Pathname of the image file for the icon to be displayedwhen this node is visible, relative to the image directoryfor our images
Parameters:
label - The label that will be displayed to the user ifthis node is visible
Parameters:
action - The hyperlink to be selected if the userselects this node, or null if this node's label shouldnot be a hyperlink
Parameters:
target - The window target in which the actionhyperlink's results will be displayed, or null forthe current window
Parameters:
expanded - Should this node be expanded?
Parameters:
domain - Identifier for the kind of node.
Parameters:
CSSClass - The css class to apply to the node
Parameters:
lazy - Is this node's children lazy loaded? |
| addChild | | public void addChild(int offset, TreeControlNode child) throws IllegalArgumentException(Code) | | Add a new child node at the specified position in the child list.
Parameters:
offset - Zero-relative offset at which the new nodeshould be inserted
Parameters:
child - The new child node
exception:
IllegalArgumentException - if the name of the new childnode is not unique |
| getCSSClass | | public String getCSSClass()(Code) | | Returns the cSSClass. |
| getWidth | | public int getWidth()(Code) | | |
| isExpandWhenClicked | | public boolean isExpandWhenClicked()(Code) | | |
| isExpanded | | public boolean isExpanded()(Code) | | |
| isLast | | public boolean isLast()(Code) | | |
| isLazy | | public boolean isLazy()(Code) | | |
| isLeaf | | public boolean isLeaf()(Code) | | |
| isLoaded | | public boolean isLoaded()(Code) | | |
| isSelected | | public boolean isSelected()(Code) | | |
| remove | | public void remove()(Code) | | Remove this node from the tree.
|
| removeChild | | public void removeChild(int offset)(Code) | | Remove the child node (and all children of that child) at the
specified position in the child list.
Parameters:
offset - Zero-relative offset at which the existingnode should be removed |
| removeChild | | void removeChild(TreeControlNode child)(Code) | | Remove the specified child node. It is assumed that all of the
children of this child node have already been removed.
Parameters:
child - Child node to be removed |
| setCSSClass | | public void setCSSClass(String CSSClass)(Code) | |
Parameters:
class1 - The cSSClass to set. |
| setExpandWhenClicked | | public void setExpandWhenClicked(boolean expandWhenClicked)(Code) | | |
| setExpanded | | public void setExpanded(boolean expanded)(Code) | | |
| setLast | | void setLast(boolean last)(Code) | | |
| setLeaf | | public void setLeaf(boolean leaf)(Code) | | |
| setLoaded | | public void setLoaded(boolean loaded)(Code) | | |
| setSelected | | public void setSelected(boolean selected)(Code) | | |
|
|