| |
|
| java.lang.Object
 javax.swing.tree.AbstractLayoutCache
All known Subclasses: javax.swing.tree.FixedHeightLayoutCache, javax.swing.tree.VariableHeightLayoutCache,
| AbstractLayoutCache | | abstract public class AbstractLayoutCache implements RowMapper(Code) | | 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. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans package.
Please see
java.beans.XMLEncoder .
version:
1.24 05/05/07
author:
Scott Violet |
| Inner Class :abstract public static class NodeDimensions | |
| Method Summary | |
| abstract public Rectangle | getBounds(TreePath path, Rectangle placeIn)
Returns a rectangle giving the bounds needed to draw path. | | abstract public boolean | getExpandedState(TreePath path)
Returns true if the path is expanded, and visible. | | public TreeModel | getModel()
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. | | protected Rectangle | getNodeDimensions(Object value, int row, int depth, boolean expanded, 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. | | abstract public TreePath | getPathClosestTo(int x, int y)
Returns the path to the node that is closest to x,y. | | abstract public TreePath | getPathForRow(int row)
Returns the path for passed in row. | | public int | getPreferredHeight()
Returns the preferred height. | | public int | getPreferredWidth(Rectangle bounds)
Returns the preferred width for the passed in region. | | abstract public int | getRowCount()
Number of rows being displayed. | | abstract public int | getRowForPath(TreePath path)
Returns the row that the last item identified in path is visible
at. | | public int | getRowHeight()
Returns the height of each row. | | public int[] | getRowsForPaths(TreePath[] paths)
Returns the rows that the TreePath instances in
path are being displayed at. | | public TreeSelectionModel | getSelectionModel()
Returns the model used to maintain the selection. | | abstract public int | getVisibleChildCount(TreePath path)
Returns the number of visible children for row. | | abstract public Enumeration<TreePath> | getVisiblePathsFrom(TreePath path)
Returns an Enumerator that increments over the visible
paths starting at the passed in location. | | abstract public void | invalidatePathBounds(TreePath path)
Instructs the LayoutCache that the bounds for
path are invalid, and need to be updated. | | abstract public void | invalidateSizes()
Informs the TreeState that it needs to recalculate
all the sizes it is referencing. | | abstract public 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. | | abstract public void | setExpandedState(TreePath path, boolean isExpanded)
Marks the path path expanded state to
isExpanded. | | public void | setModel(TreeModel newModel)
Sets the TreeModel that will 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. | | public void | setRootVisible(boolean rootVisible)
Determines whether or not the root node from
the TreeModel is visible. | | 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. | | abstract public void | treeNodesChanged(TreeModelEvent e)
Invoked after a node (or a set of siblings) has changed in some
way. | | abstract public void | treeNodesInserted(TreeModelEvent e)
| | abstract public void | treeNodesRemoved(TreeModelEvent e)
Invoked after nodes have been removed from the tree. | | abstract public void | treeStructureChanged(TreeModelEvent e)
Invoked after the tree has drastically changed structure from a
given node down. |
| nodeDimensions | | protected NodeDimensions nodeDimensions(Code) | | Object responsible for getting the size of a node.
|
| rootVisible | | protected boolean rootVisible(Code) | | True if the root node is displayed, false if its children are
the highest visible nodes.
|
| rowHeight | | protected int rowHeight(Code) | | Height to use for each row. If this is <= 0 the renderer will be
used to determine the height for each row.
|
| getBounds | | abstract public Rectangle getBounds(TreePath path, Rectangle placeIn)(Code) | | Returns a rectangle giving the bounds needed to draw path.
Parameters:
path - a TreePath specifying a node
Parameters:
placeIn - a Rectangle object giving theavailable space a Rectangle object specifying the space to be used |
| getExpandedState | | abstract public boolean getExpandedState(TreePath path)(Code) | | Returns true if the path is expanded, and visible.
Parameters:
path - the path being queried true if the path is expanded and visible, false otherwise |
| getModel | | public TreeModel getModel()(Code) | | Returns the TreeModel that is providing the data.
the TreeModel that is providing the data |
| getNodeDimensions | | public NodeDimensions getNodeDimensions()(Code) | | Returns the object that renders nodes in the tree, and which is
responsible for calculating the dimensions of individual nodes.
the NodeDimensions object |
| getNodeDimensions | | protected Rectangle getNodeDimensions(Object value, int row, int depth, boolean expanded, Rectangle placeIn)(Code) | | 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.
Parameters:
value - the value to be represented
Parameters:
row - row being queried
Parameters:
depth - the depth of the row
Parameters:
expanded - true if row is expanded, false otherwise
Parameters:
placeIn - a Rectangle containing the size neededto represent value a Rectangle containing the node dimensions,or null if node has no dimension |
| getPathClosestTo | | abstract public TreePath getPathClosestTo(int x, int y)(Code) | | 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.
Parameters:
x - the horizontal component of the desired location
Parameters:
y - the vertical component of the desired location the TreePath closest to the specified point |
| getPathForRow | | abstract public TreePath getPathForRow(int row)(Code) | | Returns the path for passed in row. If row is not visible
null is returned.
Parameters:
row - the row being queried the TreePath for the given row |
| getPreferredHeight | | public int getPreferredHeight()(Code) | | Returns the preferred height.
the preferred height |
| getPreferredWidth | | public int getPreferredWidth(Rectangle bounds)(Code) | | 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).
Parameters:
bounds - the region being queried the preferred width for the passed in region |
| getRowCount | | abstract public int getRowCount()(Code) | | Number of rows being displayed.
the number of rows being displayed |
| getRowForPath | | abstract public int getRowForPath(TreePath path)(Code) | | 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.
Parameters:
path - the TreePath being queried the row where the last item in path is visible or -1if any elements in path aren't currently visible |
| getRowHeight | | public int getRowHeight()(Code) | | 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.
|
| getRowsForPaths | | public int[] getRowsForPaths(TreePath[] paths)(Code) | | 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.
Parameters:
paths - the array of TreePaths being queried an array of the same length that is passed in containingthe rows that each corresponding where eachTreePath is displayed; if pathsis null, null is returned |
| getSelectionModel | | public TreeSelectionModel getSelectionModel()(Code) | | Returns the model used to maintain the selection.
the treeSelectionModel |
| getVisibleChildCount | | abstract public int getVisibleChildCount(TreePath path)(Code) | | Returns the number of visible children for row.
Parameters:
path - the path being queried the number of visible children for the specified path |
| getVisiblePathsFrom | | abstract public Enumeration<TreePath> getVisiblePathsFrom(TreePath path)(Code) | | 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.
Parameters:
path - the starting location for the enumeration the Enumerator starting at the desired location |
| invalidatePathBounds | | abstract public void invalidatePathBounds(TreePath path)(Code) | | Instructs the LayoutCache that the bounds for
path are invalid, and need to be updated.
Parameters:
path - the path being updated |
| invalidateSizes | | abstract public void invalidateSizes()(Code) | | Informs the TreeState that it needs to recalculate
all the sizes it is referencing.
|
| isExpanded | | abstract public boolean isExpanded(TreePath path)(Code) | | Returns true if the value identified by row is currently expanded.
|
| isFixedRowHeight | | protected boolean isFixedRowHeight()(Code) | | Returns true if the height of each row is a fixed size.
|
| isRootVisible | | public boolean isRootVisible()(Code) | | Returns true if the root node of the tree is displayed.
true if the root node of the tree is displayed
See Also: AbstractLayoutCache.rootVisible |
| setExpandedState | | abstract public void setExpandedState(TreePath path, boolean isExpanded)(Code) | | Marks the path path expanded state to
isExpanded.
Parameters:
path - the path being expanded or collapsed
Parameters:
isExpanded - true if the path should be expanded, false otherwise |
| setModel | | public void setModel(TreeModel newModel)(Code) | | Sets the TreeModel that will provide the data.
Parameters:
newModel - the TreeModel that is toprovide the data |
| setNodeDimensions | | public void setNodeDimensions(NodeDimensions nd)(Code) | | 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 |
| setRootVisible | | public void setRootVisible(boolean rootVisible)(Code) | | 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 |
| setRowHeight | | public void setRowHeight(int rowHeight)(Code) | | 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.
Parameters:
rowHeight - the height of each cell, in pixels |
| setSelectionModel | | public void setSelectionModel(TreeSelectionModel newLSM)(Code) | | Sets the TreeSelectionModel used to manage the
selection to new LSM.
Parameters:
newLSM - the new TreeSelectionModel |
| treeNodesChanged | | abstract public void treeNodesChanged(TreeModelEvent e)(Code) | |
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 |
| treeNodesInserted | | abstract public void treeNodesInserted(TreeModelEvent e)(Code) | | 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 |
| treeNodesRemoved | | abstract public void treeNodesRemoved(TreeModelEvent e)(Code) | | 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 |
| treeStructureChanged | | abstract public void treeStructureChanged(TreeModelEvent e)(Code) | | 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 |
|
|
|