|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.swing.tree.DefaultTreeModel
A simple tree data model that uses TreeNodes. For further information and examples that use DefaultTreeModel, see How to Use Trees in The Java Tutorial.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. A future release of Swing will provide support for long term persistence.
Field Summary | |
protected boolean |
asksAllowsChildren
Determines how the isLeaf method figures
out if a node is a leaf node. |
protected EventListenerList |
listenerList
Listeners. |
protected TreeNode |
root
Root of the tree. |
Constructor Summary | |
DefaultTreeModel(TreeNode root)
Creates a tree in which any node can have children. |
|
DefaultTreeModel(TreeNode root,
boolean asksAllowsChildren)
Creates a tree specifying whether any node can have children, or whether only certain nodes can have children. |
Method Summary | |
void |
addTreeModelListener(TreeModelListener l)
Adds a listener for the TreeModelEvent posted after the tree changes. |
boolean |
asksAllowsChildren()
Tells how leaf nodes are determined. |
protected void |
fireTreeNodesChanged(Object source,
Object[] path,
int[] childIndices,
Object[] children)
|
protected void |
fireTreeNodesInserted(Object source,
Object[] path,
int[] childIndices,
Object[] children)
|
protected void |
fireTreeNodesRemoved(Object source,
Object[] path,
int[] childIndices,
Object[] children)
|
protected void |
fireTreeStructureChanged(Object source,
Object[] path,
int[] childIndices,
Object[] children)
|
Object |
getChild(Object parent,
int index)
Returns the child of parent at index index in the parent's child array. |
int |
getChildCount(Object parent)
Returns the number of children of parent. |
int |
getIndexOfChild(Object parent,
Object child)
Returns the index of child in parent. |
EventListener[] |
getListeners(Class listenerType)
Return an array of all the listeners of the given type that were added to this model. |
TreeNode[] |
getPathToRoot(TreeNode aNode)
Builds the parents of node up to and including the root node, where the original node is the last element in the returned array. |
protected TreeNode[] |
getPathToRoot(TreeNode aNode,
int depth)
Builds the parents of node up to and including the root node, where the original node is the last element in the returned array. |
Object |
getRoot()
Returns the root of the tree. |
void |
insertNodeInto(MutableTreeNode newChild,
MutableTreeNode parent,
int index)
Invoked this to insert newChild at location index in parents children. |
boolean |
isLeaf(Object node)
Returns whether the specified node is a leaf node. |
void |
nodeChanged(TreeNode node)
Invoke this method after you've changed how node is to be represented in the tree. |
void |
nodesChanged(TreeNode node,
int[] childIndices)
Invoke this method after you've changed how the children identified by childIndicies are to be represented in the tree. |
void |
nodeStructureChanged(TreeNode node)
Invoke this method if you've totally changed the children of node and its childrens children... |
void |
nodesWereInserted(TreeNode node,
int[] childIndices)
Invoke this method after you've inserted some TreeNodes into node. |
void |
nodesWereRemoved(TreeNode node,
int[] childIndices,
Object[] removedChildren)
Invoke this method after you've removed some TreeNodes from node. |
void |
reload()
Invoke this method if you've modified the TreeNodes upon which this model depends. |
void |
reload(TreeNode node)
Invoke this method if you've modified the TreeNodes upon which this model depends. |
void |
removeNodeFromParent(MutableTreeNode node)
Message this to remove node from its parent. |
void |
removeTreeModelListener(TreeModelListener l)
Removes a listener previously added with addTreeModelListener(). |
void |
setAsksAllowsChildren(boolean newValue)
Sets whether or not to test leafness by asking getAllowsChildren() or isLeaf() to the TreeNodes. |
void |
setRoot(TreeNode root)
Sets the root to root . |
void |
valueForPathChanged(TreePath path,
Object newValue)
This sets the user object of the TreeNode identified by path and posts a node changed. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected TreeNode root
protected EventListenerList listenerList
protected boolean asksAllowsChildren
isLeaf
method figures
out if a node is a leaf node. If true, a node is a leaf
node if it does not allow children. (If it allows
children, it is not a leaf node, even if no children
are present.) That lets you distinguish between folder
nodes and file nodes in a file system, for example.
If this value is false, then any node which has no children is a leaf node, and any node may acquire children.
TreeNode.getAllowsChildren()
,
TreeModel.isLeaf(java.lang.Object)
,
setAsksAllowsChildren(boolean)
Constructor Detail |
public DefaultTreeModel(TreeNode root)
root
- a TreeNode object that is the root of the treeDefaultTreeModel(TreeNode, boolean)
public DefaultTreeModel(TreeNode root, boolean asksAllowsChildren)
root
- a TreeNode object that is the root of the treeaskAllowsChildren
- a boolean, false if any node can
have children, true if each node is asked to see if
it can have childrenasksAllowsChildren
Method Detail |
public void setAsksAllowsChildren(boolean newValue)
public boolean asksAllowsChildren()
asksAllowsChildren
public void setRoot(TreeNode root)
root
. This will throw an
IllegalArgumentException if root
is null.public Object getRoot()
getRoot
in interface TreeModel
public int getIndexOfChild(Object parent, Object child)
getIndexOfChild
in interface TreeModel
public Object getChild(Object parent, int index)
getChild
in interface TreeModel
parent
- a node in the tree, obtained from this data sourcepublic int getChildCount(Object parent)
getChildCount
in interface TreeModel
parent
- a node in the tree, obtained from this data sourcepublic boolean isLeaf(Object node)
askAllowsChildren
setting.isLeaf
in interface TreeModel
node
- the node to checkasksAllowsChildren
,
TreeModel.isLeaf(java.lang.Object)
public void reload()
public void valueForPathChanged(TreePath path, Object newValue)
valueForPathChanged
in interface TreeModel
javax.swing.tree.TreeModel
path
- path to the node that the user has altered.newValue
- the new value from the TreeCellEditor.public void insertNodeInto(MutableTreeNode newChild, MutableTreeNode parent, int index)
public void removeNodeFromParent(MutableTreeNode node)
public void nodeChanged(TreeNode node)
public void reload(TreeNode node)
node
(PENDING).public void nodesWereInserted(TreeNode node, int[] childIndices)
public void nodesWereRemoved(TreeNode node, int[] childIndices, Object[] removedChildren)
public void nodesChanged(TreeNode node, int[] childIndices)
public void nodeStructureChanged(TreeNode node)
public TreeNode[] getPathToRoot(TreeNode aNode)
aNode
- the TreeNode to get the path foran
- array of TreeNodes giving the path from the root to the
specified node.protected TreeNode[] getPathToRoot(TreeNode aNode, int depth)
aNode
- the TreeNode to get the path fordepth
- an int giving the number of steps already taken towards
the root (on recursive calls), used to size the returned arraypublic void addTreeModelListener(TreeModelListener l)
addTreeModelListener
in interface TreeModel
l
- the listener to addremoveTreeModelListener(javax.swing.event.TreeModelListener)
public void removeTreeModelListener(TreeModelListener l)
removeTreeModelListener
in interface TreeModel
l
- the listener to removeaddTreeModelListener(javax.swing.event.TreeModelListener)
protected void fireTreeNodesChanged(Object source, Object[] path, int[] childIndices, Object[] children)
protected void fireTreeNodesInserted(Object source, Object[] path, int[] childIndices, Object[] children)
protected void fireTreeNodesRemoved(Object source, Object[] path, int[] childIndices, Object[] children)
protected void fireTreeStructureChanged(Object source, Object[] path, int[] childIndices, Object[] children)
public EventListener[] getListeners(Class listenerType)
|
JavaTM 2 Platform Std. Ed. v1.3 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.