BaseTreeNode (Revolution Systems Open Library TRUNK-SNAPSHOT API)

java.lang.Object
- com.revolsys.swing.tree.node.BaseTreeNode

All Implemented Interfaces:

PropertyChangeListener, Iterable<BaseTreeNode>, EventListener, TreeNode

Direct Known Subclasses:

LazyLoadTreeNode, ListTreeNode, LoadingTreeNode, RecordStoreTableTreeNode
```
public class BaseTreeNode
extends Object
implements TreeNode, Iterable<BaseTreeNode>, PropertyChangeListener
```

Field Summary

Fields
Modifier and Type Field and Description

static EnableCheck NODE_EXISTS

Fields
Modifier and Type	Field and Description
`static EnableCheck`	`NODE_EXISTS`

Constructor Summary

Constructors
Constructor and Description

BaseTreeNode(boolean allowsChildren)

BaseTreeNode(Object userObject)

BaseTreeNode(Object userObject, boolean allowsChildren)

Constructors
Constructor and Description
`BaseTreeNode(boolean allowsChildren)`
`BaseTreeNode(Object userObject)`
`BaseTreeNode(Object userObject, boolean allowsChildren)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`addChild(int index, Object child)`
`protected int`	`addChild(Object child)`
`Enumeration`	`children()`
`void`	`collapse()`
`void`	`collapseChildren()`
`void`	`delete()`
`protected void`	`delete(List<BaseTreeNode> children)`
`boolean`	`dndImportData(TransferHandler.TransferSupport support, int index)`
`protected void`	`doClose()`
`protected void`	`doPropertyChange(PropertyChangeEvent e)`
`boolean`	`equals(Object object)`
`void`	`expand()`
`void`	`expand(List<?> path)`
`void`	`expand(TreePath treePath)`
`void`	`expandChildren()`
`protected void`	`finalize()`
`boolean`	`getAllowsChildren()`
`BaseTreeNode`	`getChild(Object item)`
`BaseTreeNode`	`getChildAt(int index)`
`protected List<Class<?>>`	`getChildClasses()`
`int`	`getChildCount()`
`List<BaseTreeNode>`	`getChildren()`
`Icon`	`getIcon()`
`int`	`getIndex(TreeNode node)`
`protected int`	`getIndexOfChild(BaseTreeNode abstractTreeNode, Object child)`
`MenuFactory`	`getMenu()`
`String`	`getName()`
`Icon`	`getOpenIcon()`
`BaseTreeNode`	`getParent()`
`<V extends BaseTreeNode> V`	`getParentNode()`
`<V extends JTree> V`	`getTree()`
`Component`	`getTreeCellRendererComponent(Component renderer, JTree tree, Object value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus)`
`<V extends TreeModel> V`	`getTreeModel()`
`TreePath`	`getTreePath()`
`TreePath`	`getTreePath(List<?> path)`
`TreePath`	`getTreePath(Object item)`
`String`	`getType()`
`<V> V`	`getUserData()`
`static <V> V`	`getUserData(TreePath path)`
`Object`	`getUserObject()`
`int`	`hashCode()`
`protected int`	`importData(TransferHandler.TransferSupport support, TreePathListTransferable pathTransferable, int index, TreePath sourcePath)`
`boolean`	`isAllowsChildren()`
`boolean`	`isChildrenInitialized()`
`boolean`	`isCopySupported()`
`boolean`	`isCopySupported(Object child)`
`boolean`	`isDndCanImport(TreePath dropPath, TransferHandler.TransferSupport support)`
`boolean`	`isDndDropSupported(TransferHandler.TransferSupport support, TreePath dropPath, TreePath sourcePath)`
`protected boolean`	`isDndDropSupported(TransferHandler.TransferSupport support, TreePath dropPath, TreePath childPath, Object child)`
`boolean`	`isExists()`
`boolean`	`isLeaf()`
`boolean`	`isUserObjectInitialized()`
`boolean`	`isVisible()`
`Iterator<BaseTreeNode>`	`iterator()`
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)`
`void`	`nodeChanged()`
`void`	`nodeCollapsed(BaseTreeNode treeNode)`
`protected void`	`nodeRemoved(int index, Object child)`
`protected void`	`nodesChanged(int... indicies)`
`protected void`	`nodesInserted(int... indicies)`
`protected void`	`nodesRemoved(int[] indicies, Object... children)`
`void`	`propertyChange(PropertyChangeEvent e)`
`boolean`	`removeChild(Object child)`
`boolean`	`removeChild(TreePath path)`
`void`	`setAllowsChildren(boolean allowsChildren)`
`protected void`	`setIcon(Icon icon)`
`void`	`setName(String name)`
`void`	`setParent(BaseTreeNode parent)`
`void`	`setTree(JTree tree)`
`void`	`setType(String type)`
`void`	`setUserObject(Object userObject)`
`void`	`setUserObjectInitialized(boolean userObjectInitialized)`
`void`	`setVisible(boolean visible)`
`String`	`toString()`

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

Field Detail

NODE_EXISTS

public static final EnableCheck NODE_EXISTS

Constructor Detail

BaseTreeNode

public BaseTreeNode(boolean allowsChildren)

BaseTreeNode

public BaseTreeNode(Object userObject)

BaseTreeNode

public BaseTreeNode(Object userObject,
            boolean allowsChildren)

Method Detail

getUserData

public static <V> V getUserData(TreePath path)

addChild

protected int addChild(int index,
           Object child)

addChild
```
protected int addChild(Object child)
```

children
```
public Enumeration children()
```
Specified by:

children in interface TreeNode

collapse
```
public void collapse()
```

collapseChildren
```
public void collapseChildren()
```

delete
```
public void delete()
```

delete

protected void delete(List<BaseTreeNode> children)

dndImportData

public boolean dndImportData(TransferHandler.TransferSupport support,
                    int index)
                      throws IOException,
                             UnsupportedFlavorException

Throws:: IOException; UnsupportedFlavorException

doClose
```
protected void doClose()
```

doPropertyChange

protected void doPropertyChange(PropertyChangeEvent e)

equals
```
public boolean equals(Object object)
```
Overrides:

equals in class Object

expand
```
public void expand()
```

expand
```
public void expand(List<?> path)
```

expand

public void expand(TreePath treePath)

expandChildren
```
public void expandChildren()
```

finalize

protected void finalize()
                 throws Throwable

Overrides:: finalize in class Object
Throws:: Throwable

getAllowsChildren
```
public boolean getAllowsChildren()
```
Specified by:

getAllowsChildren in interface TreeNode

getChild

public BaseTreeNode getChild(Object item)

getChildAt
```
public BaseTreeNode getChildAt(int index)
```
Specified by:

getChildAt in interface TreeNode

getChildClasses

protected List<Class<?>> getChildClasses()

getChildCount
```
public int getChildCount()
```
Specified by:

getChildCount in interface TreeNode

getChildren

public List<BaseTreeNode> getChildren()

getIcon
```
public Icon getIcon()
```

getIndex
```
public int getIndex(TreeNode node)
```
Specified by:

getIndex in interface TreeNode

getIndexOfChild

protected int getIndexOfChild(BaseTreeNode abstractTreeNode,
                  Object child)

getMenu
```
public MenuFactory getMenu()
```

getName
```
public String getName()
```

getOpenIcon
```
public Icon getOpenIcon()
```

getParent
```
public BaseTreeNode getParent()
```
Specified by:

getParent in interface TreeNode

getParentNode

public <V extends BaseTreeNode> V getParentNode()

getTree
```
public <V extends JTree> V getTree()
```

getTreeCellRendererComponent

public Component getTreeCellRendererComponent(Component renderer,
                                     JTree tree,
                                     Object value,
                                     boolean selected,
                                     boolean expanded,
                                     boolean leaf,
                                     int row,
                                     boolean hasFocus)

getTreeModel

public <V extends TreeModel> V getTreeModel()

getTreePath
```
public TreePath getTreePath()
```

getTreePath

public TreePath getTreePath(List<?> path)

getTreePath

public TreePath getTreePath(Object item)

getType
```
public String getType()
```

getUserData
```
public <V> V getUserData()
```

getUserObject
```
public Object getUserObject()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

importData

protected int importData(TransferHandler.TransferSupport support,
             TreePathListTransferable pathTransferable,
             int index,
             TreePath sourcePath)

isAllowsChildren
```
public boolean isAllowsChildren()
```

isChildrenInitialized

public boolean isChildrenInitialized()

isCopySupported
```
public boolean isCopySupported()
```

isCopySupported

public boolean isCopySupported(Object child)

isDndCanImport

public boolean isDndCanImport(TreePath dropPath,
                     TransferHandler.TransferSupport support)

isDndDropSupported

public boolean isDndDropSupported(TransferHandler.TransferSupport support,
                         TreePath dropPath,
                         TreePath sourcePath)

isDndDropSupported

protected boolean isDndDropSupported(TransferHandler.TransferSupport support,
                         TreePath dropPath,
                         TreePath childPath,
                         Object child)

isExists
```
public boolean isExists()
```

isLeaf
```
public boolean isLeaf()
```
Specified by:

isLeaf in interface TreeNode

isUserObjectInitialized

public boolean isUserObjectInitialized()

isVisible
```
public boolean isVisible()
```

iterator
```
public Iterator<BaseTreeNode> iterator()
```
Specified by:

iterator in interface Iterable<BaseTreeNode>

mouseClicked

public void mouseClicked(MouseEvent e)

mouseEntered

public void mouseEntered(MouseEvent e)

mouseExited

public void mouseExited(MouseEvent e)

mousePressed

public void mousePressed(MouseEvent e)

mouseReleased

public void mouseReleased(MouseEvent e)

nodeChanged
```
public void nodeChanged()
```

nodeCollapsed

public void nodeCollapsed(BaseTreeNode treeNode)

nodeRemoved

protected void nodeRemoved(int index,
               Object child)

nodesChanged

protected void nodesChanged(int... indicies)

nodesInserted

protected void nodesInserted(int... indicies)

nodesRemoved

protected void nodesRemoved(int[] indicies,
                Object... children)

propertyChange
```
public final void propertyChange(PropertyChangeEvent e)
```
Specified by:

propertyChange in interface PropertyChangeListener

removeChild

public boolean removeChild(Object child)

removeChild

public boolean removeChild(TreePath path)

setAllowsChildren

public void setAllowsChildren(boolean allowsChildren)

setIcon
```
protected void setIcon(Icon icon)
```

setName
```
public void setName(String name)
```

setParent

public void setParent(BaseTreeNode parent)

setTree
```
public void setTree(JTree tree)
```

setType
```
public void setType(String type)
```

setUserObject

public void setUserObject(Object userObject)

setUserObjectInitialized

public void setUserObjectInitialized(boolean userObjectInitialized)

setVisible

public void setVisible(boolean visible)

toString
```
public String toString()
```
Overrides:

toString in class Object

Class BaseTreeNode

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NODE_EXISTS

Constructor Detail

BaseTreeNode

BaseTreeNode

BaseTreeNode

Method Detail

getUserData

addChild

addChild

children

collapse

collapseChildren

delete

delete

dndImportData

doClose

doPropertyChange

equals

expand

expand

expand

expandChildren

finalize

getAllowsChildren

getChild

getChildAt

getChildClasses

getChildCount

getChildren

getIcon

getIndex

getIndexOfChild

getMenu

getName

getOpenIcon

getParent

getParentNode

getTree

getTreeCellRendererComponent

getTreeModel

getTreePath

getTreePath

getTreePath

getType

getUserData

getUserObject

hashCode

importData

isAllowsChildren

isChildrenInitialized

isCopySupported

isCopySupported

isDndCanImport

isDndDropSupported

isDndDropSupported

isExists

isLeaf

isUserObjectInitialized

isVisible

iterator

mouseClicked

mouseEntered

mouseExited

mousePressed

mouseReleased

nodeChanged

nodeCollapsed

nodeRemoved

nodesChanged

nodesInserted

nodesRemoved

propertyChange

removeChild

removeChild