AbstractLayoutCache JDK 1.6)

publicabstract Rectangle getBounds (TreePath path, Rectangle placeIn)

Returns a rectangle giving the bounds needed to draw path.

Returns a rectangle giving the bounds needed to draw path.
Returns: a Rectangle object specifying the space to be used
Parameters:
- path - a TreePath specifying a node
- placeIn - a Rectangle object giving the available space

publicabstract boolean getExpandedState (TreePath path)

Returns true if the path is expanded, and visible.

public TreeModel getModel ()

Returns the TreeModel that is providing the data.

Returns the TreeModel that is providing the data.
Returns: the TreeModel that is providing the data

public NodeDimensions getNodeDimensions ()

Returns the object that renders nodes in the tree, and which is responsible for calculating the dimensions of individual nodes.

Returns the object that renders nodes in the tree, and which is
responsible for calculating the dimensions of individual nodes.
Returns: the NodeDimensions object

protected Rectangle getNodeDimensions (Object value, int row, int depth, boolean expanded, Rectangle placeIn)

Returns, by reference in placeIn, the size needed to represent value.

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.
Returns: a Rectangle containing the node dimensions, or null if node has no dimension
Parameters:
- value - the value to be represented
- row - row being queried
- depth - the depth of the row
- expanded - true if row is expanded, false otherwise
- placeIn - a Rectangle containing the size needed to represent value

publicabstract TreePath getPathClosestTo (int x, int y)

Returns the path to the node that is closest to x,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.
Returns: the TreePath closest to the specified point
Parameters:
- x - the horizontal component of the desired location
- y - the vertical component of the desired location

publicabstract TreePath getPathForRow (int row)

Returns the path for passed in row.

Returns the path for passed in row. If row is not visible
null is returned.
Returns: the TreePath for the given row
Parameters:
- row - the row being queried

public int getPreferredHeight ()

Returns the preferred height.

public int getPreferredWidth (Rectangle bounds)

Returns the preferred width for the passed in region.

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).
Returns: the preferred width for the passed in region
Parameters:
- bounds - the region being queried

publicabstract int getRowCount ()

Number of rows being displayed.

publicabstract int getRowForPath (TreePath path)

Returns the row that the last item identified in path is visible at.

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.
Returns: the row where the last item in path is visible or -1 if any elements in path aren't currently visible
Parameters:
- path - the TreePath being queried

public int getRowHeight ()

Returns the height of each row.

public int getRowsForPaths (TreePath paths) [Specified in RowMapper]

Returns the rows that the TreePath instances in path are being displayed at.

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.
Returns: an array of the same length that is passed in containing the rows that each corresponding where each TreePath is displayed; if paths is null, null is returned
Parameters:
- paths - the array of TreePaths being queried

public TreeSelectionModel getSelectionModel ()

Returns the model used to maintain the selection.

Returns the model used to maintain the selection.
Returns: the treeSelectionModel

publicabstract int getVisibleChildCount (TreePath path)

Returns the number of visible children for row.

publicabstract Enumeration<TreePath> getVisiblePathsFrom (TreePath path)

Returns an Enumerator that increments over the visible paths starting at the passed in location.

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.
Returns: the Enumerator starting at the desired location
Parameters:
- path - the starting location for the enumeration

publicabstract void invalidatePathBounds (TreePath path)

Instructs the LayoutCache that the bounds for path are invalid, and need to be updated.

Instructs the LayoutCache that the bounds for
path are invalid, and need to be updated.
Parameters:
- path - the path being updated

publicabstract void invalidateSizes ()

Informs the TreeState that it needs to recalculate all the sizes it is referencing.

publicabstract boolean isExpanded (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.

public boolean isRootVisible ()

Returns true if the root node of the tree is displayed.

publicabstract void setExpandedState (TreePath path, boolean isExpanded)

Marks the path path expanded state to isExpanded.

Marks the path path expanded state to
isExpanded.
Parameters:
- path - the path being expanded or collapsed
- isExpanded - true if the path should be expanded, false otherwise

public void setModel (TreeModel newModel)

Sets the TreeModel that will provide the data.

Sets the TreeModel that will provide the data.
Parameters:
- newModel - the TreeModel that is to provide the data

public void setNodeDimensions (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.

Sets the renderer that is responsible for drawing nodes in the tree
and which is threfore responsible for calculating the dimensions of
individual nodes.
Parameters:
- nd - a NodeDimensions object

public void setRootVisible (boolean rootVisible)

Determines whether or not the root node from the TreeModel is visible.

Determines whether or not the root node from
the TreeModel is visible.
Parameters:
- rootVisible - true if the root node of the tree is to be displayed
See Also: AbstractLayoutCache.rootVisible,

public void setRowHeight (int rowHeight)

Sets the height of each cell.

public void setSelectionModel (TreeSelectionModel newLSM)

Sets the TreeSelectionModel used to manage the selection to new LSM.

Sets the TreeSelectionModel used to manage the
selection to new LSM.
Parameters:
- newLSM - the new TreeSelectionModel

publicabstract void treeNodesChanged (TreeModelEvent e)

Invoked after a node (or a set of siblings) has changed in some way.

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).

Parameters:
- e - the TreeModelEvent

publicabstract void treeNodesInserted (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.

Parameters:
- e - the TreeModelEvent

publicabstract void treeNodesRemoved (TreeModelEvent e)

Invoked after nodes have been removed from the tree.

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.

Parameters:
- e - the TreeModelEvent

publicabstract void treeStructureChanged (TreeModelEvent e)

Invoked after the tree has drastically changed structure from a given node down.

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.

Parameters:
- e - the TreeModelEvent