- All Implemented Interfaces:
RowMapper
- Direct Known Subclasses:
FixedHeightLayoutCache
,VariableHeightLayoutCache
java.beans
package.
Please see XMLEncoder
.-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Used byAbstractLayoutCache
to determine the size and x origin of a particular node. -
Field Summary
Modifier and TypeFieldDescriptionprotected AbstractLayoutCache.NodeDimensions
Object responsible for getting the size of a node.protected boolean
True if the root node is displayed, false if its children are the highest visible nodes.protected int
Height to use for each row.protected TreeModel
Model providing information.protected TreeSelectionModel
Selection model. -
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor for subclasses to call. -
Method Summary
Modifier and TypeMethodDescriptionabstract Rectangle
Returns a rectangle giving the bounds needed to draw path.abstract boolean
getExpandedState
(TreePath path) Returns true if the path is expanded, and visible.getModel()
Returns theTreeModel
that is providing the data.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 inplaceIn
, the size needed to representvalue
.abstract TreePath
getPathClosestTo
(int x, int y) Returns the path to the node that is closest to x,y.abstract TreePath
getPathForRow
(int row) Returns the path for passed in row.int
Returns the preferred height.int
getPreferredWidth
(Rectangle bounds) Returns the preferred width for the passed in region.abstract int
Number of rows being displayed.abstract int
getRowForPath
(TreePath path) Returns the row that the last item identified in path is visible at.int
Returns the height of each row.int[]
getRowsForPaths
(TreePath[] paths) Returns the rows that theTreePath
instances inpath
are being displayed at.Returns the model used to maintain the selection.abstract int
getVisibleChildCount
(TreePath path) Returns the number of visible children for row.abstract Enumeration
<TreePath> getVisiblePathsFrom
(TreePath path) Returns anEnumerator
that increments over the visible paths starting at the passed in location.abstract void
invalidatePathBounds
(TreePath path) Instructs theLayoutCache
that the bounds forpath
are invalid, and need to be updated.abstract void
Informs theTreeState
that it needs to recalculate all the sizes it is referencing.abstract boolean
isExpanded
(TreePath path) Returns true if the value identified by row is currently expanded.protected boolean
Returns true if the height of each row is a fixed size.boolean
Returns true if the root node of the tree is displayed.abstract void
setExpandedState
(TreePath path, boolean isExpanded) Marks the pathpath
expanded state toisExpanded
.void
Sets theTreeModel
that will provide the data.void
Sets the renderer that is responsible for drawing nodes in the tree and which is therefore responsible for calculating the dimensions of individual nodes.void
setRootVisible
(boolean rootVisible) Determines whether or not the root node from theTreeModel
is visible.void
setRowHeight
(int rowHeight) Sets the height of each cell.void
setSelectionModel
(TreeSelectionModel newLSM) Sets theTreeSelectionModel
used to manage the selection to new LSM.abstract void
Invoked after a node (or a set of siblings) has changed in some way.abstract void
Invoked after nodes have been inserted into the tree.abstract void
Invoked after nodes have been removed from the tree.abstract void
Invoked after the tree has drastically changed structure from a given node down.
-
Field Details
-
nodeDimensions
Object responsible for getting the size of a node. -
treeModel
Model providing information. -
treeSelectionModel
Selection model. -
rootVisible
protected boolean rootVisibleTrue if the root node is displayed, false if its children are the highest visible nodes. -
rowHeight
protected int rowHeightHeight to use for each row. If this is <= 0 the renderer will be used to determine the height for each row.
-
-
Constructor Details
-
AbstractLayoutCache
protected AbstractLayoutCache()Constructor for subclasses to call.
-
-
Method Details
-
setNodeDimensions
Sets the renderer that is responsible for drawing nodes in the tree and which is therefore responsible for calculating the dimensions of individual nodes.- Parameters:
nd
- aNodeDimensions
object
-
getNodeDimensions
Returns the object that renders nodes in the tree, and which is responsible for calculating the dimensions of individual nodes.- Returns:
- the
NodeDimensions
object
-
setModel
Sets theTreeModel
that will provide the data.- Parameters:
newModel
- theTreeModel
that is to provide the data
-
getModel
Returns theTreeModel
that is providing the data.- Returns:
- the
TreeModel
that is providing the data
-
setRootVisible
@BeanProperty(description="Whether or not the root node from the TreeModel is visible.") public void setRootVisible(boolean rootVisible) Determines whether or not the root node from theTreeModel
is visible.- Parameters:
rootVisible
- true if the root node of the tree is to be displayed- See Also:
-
isRootVisible
public boolean isRootVisible()Returns true if the root node of the tree is displayed.- Returns:
- true if the root node of the tree is displayed
- See Also:
-
setRowHeight
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
-
getRowHeight
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.- Returns:
- the height of each row
-
setSelectionModel
Sets theTreeSelectionModel
used to manage the selection to new LSM.- Parameters:
newLSM
- the newTreeSelectionModel
-
getSelectionModel
Returns the model used to maintain the selection.- Returns:
- the
treeSelectionModel
-
getPreferredHeight
public int getPreferredHeight()Returns the preferred height.- Returns:
- the preferred height
-
getPreferredWidth
Returns the preferred width for the passed in region. The region is defined by the path closest to(bounds.x, bounds.y)
and ends atbounds.height + bounds.y
. Ifbounds
isnull
, the preferred width for all the nodes will be returned (and this may be a VERY expensive computation).- Parameters:
bounds
- the region being queried- Returns:
- the preferred width for the passed in region
-
isExpanded
Returns true if the value identified by row is currently expanded.- Parameters:
path
- TreePath to check- Returns:
- whether TreePath is expanded
-
getBounds
Returns a rectangle giving the bounds needed to draw path.- Parameters:
path
- aTreePath
specifying a nodeplaceIn
- aRectangle
object giving the available space- Returns:
- a
Rectangle
object specifying the space to be used
-
getPathForRow
Returns the path for passed in row. If row is not visiblenull
is returned.- Parameters:
row
- the row being queried- Returns:
- the
TreePath
for the given row
-
getRowForPath
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
- theTreePath
being queried- Returns:
- the row where the last item in path is visible or -1 if any elements in path aren't currently visible
-
getPathClosestTo
Returns the path to the node that is closest to x,y. If there is nothing currently visible this will returnnull
, 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 locationy
- the vertical component of the desired location- Returns:
- the
TreePath
closest to the specified point
-
getVisiblePathsFrom
Returns anEnumerator
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 casenull
will be returned.- Parameters:
path
- the starting location for the enumeration- Returns:
- the
Enumerator
starting at the desired location
-
getVisibleChildCount
Returns the number of visible children for row.- Parameters:
path
- the path being queried- Returns:
- the number of visible children for the specified path
-
setExpandedState
Marks the pathpath
expanded state toisExpanded
.- Parameters:
path
- the path being expanded or collapsedisExpanded
- true if the path should be expanded, false otherwise
-
getExpandedState
Returns true if the path is expanded, and visible.- Parameters:
path
- the path being queried- Returns:
- true if the path is expanded and visible, false otherwise
-
getRowCount
public abstract int getRowCount()Number of rows being displayed.- Returns:
- the number of rows being displayed
-
invalidateSizes
public abstract void invalidateSizes()Informs theTreeState
that it needs to recalculate all the sizes it is referencing. -
invalidatePathBounds
Instructs theLayoutCache
that the bounds forpath
are invalid, and need to be updated.- Parameters:
path
- the path being updated
-
treeNodesChanged
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
- theTreeModelEvent
-
treeNodesInserted
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
- theTreeModelEvent
-
treeNodesRemoved
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
- theTreeModelEvent
-
treeStructureChanged
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
- theTreeModelEvent
-
getRowsForPaths
Returns the rows that theTreePath
instances inpath
are being displayed at. This method should return an array of the same length as that passed in, and if one of theTreePaths
inpath
is not valid its entry in the array should be set to -1.- Specified by:
getRowsForPaths
in interfaceRowMapper
- Parameters:
paths
- the array ofTreePath
s being queried- Returns:
- an array of the same length that is passed in containing
the rows that each corresponding where each
TreePath
is displayed; ifpaths
isnull
,null
is returned
-
getNodeDimensions
protected Rectangle getNodeDimensions(Object value, int row, int depth, boolean expanded, Rectangle placeIn) Returns, by reference inplaceIn
, the size needed to representvalue
. IfinPlace
isnull
, a newly createdRectangle
should be returned, otherwise the value should be placed ininPlace
and returned. This will returnnull
if there is no renderer.- Parameters:
value
- thevalue
to be representedrow
- row being querieddepth
- the depth of the rowexpanded
- true if row is expanded, false otherwiseplaceIn
- aRectangle
containing the size needed to representvalue
- Returns:
- a
Rectangle
containing the node dimensions, ornull
if node has no dimension
-
isFixedRowHeight
protected boolean isFixedRowHeight()Returns true if the height of each row is a fixed size.- Returns:
- whether the height of each row is a fixed size
-