SimpleNode

Documentation of 'jas2.util.tree.SimpleNode' Java class SimpleNode

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- jas2.util.tree.SimpleNode

Direct Known Subclasses:

JobFolder, OrderedNode
```
public class SimpleNode
extends java.lang.Object
```
A simple node represents a node in a tree. Each node has a number of properties:

Constructor Summary

Constructors
Constructor and Description
`SimpleNode()` Create a root node, with no name, type or flag
`SimpleNode(SimpleNode parent, java.lang.String name, java.lang.String type, int flags, java.lang.Object object)` Create a node
`SimpleNode(java.lang.String name, java.lang.String type, int flags, java.lang.Object object)` Create a root node

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SimpleNode`	`add(TreeItem item)` Add a node specified by a TreeItem.
`SimpleNode`	`add(TreeItem item, java.lang.Object object)` Add a node specified by a TreeItem, with an associated object.
`void`	`addNodeListener(SimpleNodeListener l)`
`java.util.Enumeration`	`children()`
`void`	`clearFlags(int mask)`
`void`	`destroy()` Destroy a node (remove it from its parents list of children) No further use of a node or its chilren should be made after it has been destroyed
`java.util.Enumeration`	`elements()` Returns an enumeration of the objects associated with the child nodes.
`SimpleNode`	`find(TreeItem item)` Find a node specified by a TreeItem.
`SimpleNode`	`findChild(java.lang.String name)` Find a child node with a given name
`SimpleNode`	`getChild(int index)`
`int`	`getChildCount()`
`int`	`getFlags()`
`int`	`getIndexOfChild(java.lang.Object child)`
`java.lang.String`	`getName()`
`java.lang.Object`	`getObject()` Get the associated object.
`SimpleNode`	`getParent()`
`TreeItem`	`getTreeItem(SimpleNode base)` Get a TreeItem describing this node, relative to a base node
`java.lang.String`	`getType()`
`boolean`	`isAncestorOf(SimpleNode root)`
`void`	`remove(TreeItem item)` Remove a node specified by a TreeItem.
`void`	`removeNodeListener(SimpleNodeListener l)`
`void`	`setFlags(int mask)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SimpleNode
```
public SimpleNode()
```
    Create a root node, with no name, type or flag
  - SimpleNode
```
public SimpleNode(java.lang.String name,
                  java.lang.String type,
                  int flags,
                  java.lang.Object object)
```
    Create a root node
    
    Parameters:
    
    name - The name of the node
    
    type - The type of the node
    
    object - The Object associated with the node
  - SimpleNode
```
public SimpleNode(SimpleNode parent,
                  java.lang.String name,
                  java.lang.String type,
                  int flags,
                  java.lang.Object object)
```
    Create a node
    
    Parameters:
    
    parent - The parent of this node
    
    name - The name of the node
    
    type - The type of the node
    
    object - The Object associated with the node
- Method Detail
  - getTreeItem
```
public TreeItem getTreeItem(SimpleNode base)
```
    Get a TreeItem describing this node, relative to a base node
    
    Parameters:
    
    base - The base node
    
    Returns:
    
    The TreeItem describing the relative path
  - findChild
```
public SimpleNode findChild(java.lang.String name)
```
    Find a child node with a given name
    
    Parameters:
    
    name - The name to search for
    
    Returns:
    
    The child node, or null of no node was found by the given name
  - destroy
```
public void destroy()
```
    Destroy a node (remove it from its parents list of children) No further use of a node or its chilren should be made after it has been destroyed
  - add
```
public SimpleNode add(TreeItem item)
```
    Add a node specified by a TreeItem. The path in the TreeItem is interpreted as relavive to the current node, and any intervening nodes specified by the path are created automatically as needed.
    
    Parameters:
    
    item - The subnode to add
    
    Returns:
    
    The leaf node created
  - add
```
public SimpleNode add(TreeItem item,
                      java.lang.Object object)
```
    Add a node specified by a TreeItem, with an associated object. The path in the TreeItem is interpreted as relavive to the current node, and any intervening nodes specified by the path are created automatically as needed.
    
    Parameters:
    
    item - The subnode to add
    
    object - The associated object
    
    Returns:
    
    The leaf node created
  - remove
```
public void remove(TreeItem item)
```
    Remove a node specified by a TreeItem. Intervening nodes are not removed, but the leaf node is destroyed, as are its children.
    
    Parameters:
    
    item - The subnode to remove
  - find
```
public SimpleNode find(TreeItem item)
```
    Find a node specified by a TreeItem.
    
    Parameters:
    
    item - The subnode to remove
    
    Returns:
    
    The found node, or null if the node was not found
  - getChildCount
```
public int getChildCount()
```
  - getChild
```
public SimpleNode getChild(int index)
```
  - getIndexOfChild
```
public int getIndexOfChild(java.lang.Object child)
```
  - children
```
public java.util.Enumeration children()
```
  - elements
```
public java.util.Enumeration elements()
```
    Returns an enumeration of the objects associated with the child nodes.
  - getObject
```
public java.lang.Object getObject()
```
    Get the associated object. Note if the object is currently null, we will traverse up towards the root of the tree looking for a node whose associated object is a TreeObjectSource and if we find one we will use it to locate the object.
    
    Returns:
    
    the Object, or null if there is no associated object.
  - setFlags
```
public void setFlags(int mask)
```
  - clearFlags
```
public void clearFlags(int mask)
```
  - isAncestorOf
```
public boolean isAncestorOf(SimpleNode root)
```
  - getType
```
public java.lang.String getType()
```
  - getFlags
```
public int getFlags()
```
  - getName
```
public java.lang.String getName()
```
  - getParent
```
public SimpleNode getParent()
```
  - addNodeListener
```
public void addNodeListener(SimpleNodeListener l)
```
  - removeNodeListener
```
public void removeNodeListener(SimpleNodeListener l)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SimpleNode

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SimpleNode

SimpleNode

SimpleNode

Method Detail

getTreeItem

findChild

destroy

add

add

remove

find

getChildCount

getChild

getIndexOfChild

children

elements

getObject

setFlags

clearFlags

isAncestorOf

getType

getFlags

getName

getParent

addNodeListener

removeNodeListener

toString