TreeNode (JCMS API)

All Known Subinterfaces:

MenuInfo

All Known Implementing Classes:

AbstractCalendarEvent, AbstractDBTestType, AbstractEventResource, AbstractJPortal, AbstractMedia, AbstractPortalJspCollection, AbstractShortcut, AbstractTestType, AbstractWebPage, Category, CategoryMenuInfo, Content, DBFileDocument, FileDocument, Form, MailMessage, MockTreeNode, PDFieldNode, PDFieldTree, Portal, PortalElement, PortalRedirect, Portlet, PortletCollection, PortletParent, PortletSkinable, Publication, UserContent, Workspace
```
public interface TreeNode
```
Interface reprensenting an Object Tree with usefull generic method to collect Branch status, children ...

Since:

jcms-3.0.0

Version:

$Revision: 61677 $

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String REVISION

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.lang.String`	`getId()`	Returns id of the current node
`java.util.Collection<? extends TreeNode>`	`getTreeChildren()`	Returns a Collection of TreeNode children of the current node
`TreeNode`	`getTreeParent()`	Returns parent of the current node
`TreeNode`	`getTreeRoot()`	Returns the root of the current node
`boolean`	`isTreeLeaf()`	Returns boolean true if the TreeNode is a leaf
`boolean`	`isTreeNode()`	Returns boolean true if the TreeNode is a node

- Field Detail
  - REVISION
```
static final java.lang.String REVISION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getTreeChildren
```
java.util.Collection<? extends TreeNode> getTreeChildren()
```
    Returns a Collection of TreeNode children of the current node
    
    Returns:
    
    Collection of TreeNode
  - getId
```
java.lang.String getId()
```
    Returns id of the current node
    
    Returns:
    
    String Node id
  - getTreeParent
```
TreeNode getTreeParent()
```
    Returns parent of the current node
    
    Returns:
    
    TreeNode parent Node
  - isTreeLeaf
```
boolean isTreeLeaf()
```
    Returns boolean true if the TreeNode is a leaf
    
    Returns:
    
    boolean indicating if node is leaf or node
  - isTreeNode
```
boolean isTreeNode()
```
    Returns boolean true if the TreeNode is a node
    
    Returns:
    
    boolean indicating if node is leaf or node
  - getTreeRoot
```
TreeNode getTreeRoot()
```
    Returns the root of the current node
    
    Returns:
    
    TreeNode root Node