| Methods Summary |
|---|
| public abstract java.awt.Rectangle | getBounds(javax.swing.tree.TreePath path, java.awt.Rectangle placeIn)Returns a rectangle giving the bounds needed to draw path.
|
| public abstract boolean | getExpandedState(javax.swing.tree.TreePath path)Returns true if the path is expanded, and visible.
|
| public javax.swing.tree.TreeModel | getModel()Returns the TreeModel that is providing the data.
return treeModel;
|
| public javax.swing.tree.AbstractLayoutCache$NodeDimensions | getNodeDimensions()Returns the object that renders nodes in the tree, and which is
responsible for calculating the dimensions of individual nodes.
return nodeDimensions;
|
| protected java.awt.Rectangle | getNodeDimensions(java.lang.Object value, int row, int depth, boolean expanded, java.awt.Rectangle placeIn)Returns, by reference in placeIn,
the size needed to represent value.
If inPlace is null, a newly created
Rectangle should be returned, otherwise the value
should be placed in inPlace and returned. This will
return null if there is no renderer.
NodeDimensions nd = getNodeDimensions();
if(nd != null) {
return nd.getNodeDimensions(value, row, depth, expanded, placeIn);
}
return null;
|
| public abstract javax.swing.tree.TreePath | getPathClosestTo(int x, int y)Returns the path to the node that is closest to x,y. If
there is nothing currently visible this will return null,
otherwise it'll always return a valid path.
If you need to test if the
returned object is exactly at x, y you should get the bounds for
the returned path and test x, y against that.
|
| public abstract javax.swing.tree.TreePath | getPathForRow(int row)Returns the path for passed in row. If row is not visible
null is returned.
|
| public int | getPreferredHeight()Returns the preferred height.
// Get the height
int rowCount = getRowCount();
if(rowCount > 0) {
Rectangle bounds = getBounds(getPathForRow(rowCount - 1),
null);
if(bounds != null)
return bounds.y + bounds.height;
}
return 0;
|
| public int | getPreferredWidth(java.awt.Rectangle bounds)Returns the preferred width for the passed in region.
The region is defined by the path closest to
(bounds.x, bounds.y) and
ends at bounds.height + bounds.y.
If bounds is null,
the preferred width for all the nodes
will be returned (and this may be a VERY expensive
computation).
int rowCount = getRowCount();
if(rowCount > 0) {
// Get the width
TreePath firstPath;
int endY;
if(bounds == null) {
firstPath = getPathForRow(0);
endY = Integer.MAX_VALUE;
}
else {
firstPath = getPathClosestTo(bounds.x, bounds.y);
endY = bounds.height + bounds.y;
}
Enumeration paths = getVisiblePathsFrom(firstPath);
if(paths != null && paths.hasMoreElements()) {
Rectangle pBounds = getBounds((TreePath)paths.nextElement(),
null);
int width;
if(pBounds != null) {
width = pBounds.x + pBounds.width;
if (pBounds.y >= endY) {
return width;
}
}
else
width = 0;
while (pBounds != null && paths.hasMoreElements()) {
pBounds = getBounds((TreePath)paths.nextElement(),
pBounds);
if (pBounds != null && pBounds.y < endY) {
width = Math.max(width, pBounds.x + pBounds.width);
}
else {
pBounds = null;
}
}
return width;
}
}
return 0;
|
| public abstract int | getRowCount()Number of rows being displayed.
|
| public abstract int | getRowForPath(javax.swing.tree.TreePath path)Returns the row that the last item identified in path is visible
at. Will return -1 if any of the elements in path are not
currently visible.
|
| public int | getRowHeight()Returns the height of each row. If the returned value is less than
or equal to 0 the height for each row is determined by the
renderer.
return rowHeight;
|
| public int[] | getRowsForPaths(javax.swing.tree.TreePath[] paths)Returns the rows that the TreePath instances in
path are being displayed at.
This method should return an array of the same length as that passed
in, and if one of the TreePaths
in path is not valid its entry in the array should
be set to -1.
if(paths == null)
return null;
int numPaths = paths.length;
int[] rows = new int[numPaths];
for(int counter = 0; counter < numPaths; counter++)
rows[counter] = getRowForPath(paths[counter]);
return rows;
|
| public javax.swing.tree.TreeSelectionModel | getSelectionModel()Returns the model used to maintain the selection.
return treeSelectionModel;
|
| public abstract int | getVisibleChildCount(javax.swing.tree.TreePath path)Returns the number of visible children for row.
|
| public abstract java.util.Enumeration | getVisiblePathsFrom(javax.swing.tree.TreePath path)Returns an Enumerator that increments over the visible
paths starting at the passed in location. The ordering of the
enumeration is based on how the paths are displayed.
The first element of the returned enumeration will be path,
unless it isn't visible,
in which case null will be returned.
|
| public abstract void | invalidatePathBounds(javax.swing.tree.TreePath path)Instructs the LayoutCache that the bounds for
path are invalid, and need to be updated.
|
| public abstract void | invalidateSizes()Informs the TreeState that it needs to recalculate
all the sizes it is referencing.
|
| public abstract boolean | isExpanded(javax.swing.tree.TreePath path)Returns true if the value identified by row is currently expanded.
|
| protected boolean | isFixedRowHeight()Returns true if the height of each row is a fixed size.
return (rowHeight > 0);
|
| public boolean | isRootVisible()Returns true if the root node of the tree is displayed.
return rootVisible;
|
| public abstract void | setExpandedState(javax.swing.tree.TreePath path, boolean isExpanded)Marks the path path expanded state to
isExpanded.
|
| public void | setModel(javax.swing.tree.TreeModel newModel)Sets the TreeModel that will provide the data.
treeModel = newModel;
|
| public void | setNodeDimensions(javax.swing.tree.AbstractLayoutCache$NodeDimensions nd)Sets the renderer that is responsible for drawing nodes in the tree
and which is threfore responsible for calculating the dimensions of
individual nodes.
this.nodeDimensions = nd;
|
| public void | setRootVisible(boolean rootVisible)Determines whether or not the root node from
the TreeModel is visible.
this.rootVisible = rootVisible;
|
| public void | setRowHeight(int rowHeight)Sets the height of each cell. If the specified value
is less than or equal to zero the current cell renderer is
queried for each row's height.
this.rowHeight = rowHeight;
|
| public void | setSelectionModel(javax.swing.tree.TreeSelectionModel newLSM)Sets the TreeSelectionModel used to manage the
selection to new LSM.
if(treeSelectionModel != null)
treeSelectionModel.setRowMapper(null);
treeSelectionModel = newLSM;
if(treeSelectionModel != null)
treeSelectionModel.setRowMapper(this);
|
| public abstract void | treeNodesChanged(javax.swing.event.TreeModelEvent e)
Invoked after a node (or a set of siblings) has changed in some
way. The node(s) have not changed locations in the tree or
altered their children arrays, but other attributes have
changed and may affect presentation. Example: the name of a
file has changed, but it is in the same location in the file
system.
e.path() returns the path the parent of the changed node(s).
e.childIndices() returns the index(es) of the changed node(s).
|
| public abstract void | treeNodesInserted(javax.swing.event.TreeModelEvent e)Invoked after nodes have been inserted into the tree.
e.path() returns the parent of the new nodes
e.childIndices() returns the indices of the new nodes in
ascending order.
|
| public abstract void | treeNodesRemoved(javax.swing.event.TreeModelEvent e)Invoked after nodes have been removed from the tree. Note that
if a subtree is removed from the tree, this method may only be
invoked once for the root of the removed subtree, not once for
each individual set of siblings removed.
e.path() returns the former parent of the deleted nodes.
e.childIndices() returns the indices the nodes had before they were deleted in ascending order.
|
| public abstract void | treeStructureChanged(javax.swing.event.TreeModelEvent e)Invoked after the tree has drastically changed structure from a
given node down. If the path returned by e.getPath()
is of length one and the first element does not identify the
current root node the first element should become the new root
of the tree.
e.path() holds the path to the node.
e.childIndices() returns null.
|
