- All Implemented Interfaces:
RowMapper
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 JavaBeans
has been added to the java.beans package.
Please see XMLEncoder.
-
Nested Class Summary
Nested classes/interfaces declared in class javax.swing.tree.AbstractLayoutCache
AbstractLayoutCache.NodeDimensions -
Field Summary
Fields declared in class javax.swing.tree.AbstractLayoutCache
nodeDimensions, rootVisible, rowHeight, treeModel, treeSelectionModel -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns theRectangleenclosing the label portion into which the item identified bypathwill be drawn.booleangetExpandedState(TreePath path) Returns true if the path is expanded, and visible.getPathClosestTo(int x, int y) Returns the path to the node that is closest to x,y.getPathForRow(int row) Returns the path forrow.intReturns the preferred height.intgetPreferredWidth(Rectangle bounds) Returns the preferred width and height for the region invisibleRegion.intReturns the number of visible rows.intgetRowForPath(TreePath path) Returns the row where the last item identified in path is visible.intgetVisibleChildCount(TreePath path) Returns the number of visible children forpath.getVisiblePathsFrom(TreePath path) Returns anEnumeratorthat increments over the visible paths starting at the passed in location.voidinvalidatePathBounds(TreePath path) Instructs theLayoutCachethat the bounds forpathare invalid, and need to be updated.voidInforms theTreeStatethat it needs to recalculate all the sizes it is referencing.booleanisExpanded(TreePath path) Returns true if the value identified bypathis currently expanded.voidsetExpandedState(TreePath path, boolean isExpanded) Marks the pathpathexpanded state toisExpanded.voidSets theTreeModelthat will provide the data.voidSets the renderer that is responsible for drawing nodes in the tree.voidsetRootVisible(boolean rootVisible) Determines whether or not the root node from theTreeModelis visible.voidsetRowHeight(int rowHeight) Sets the height of each cell.voidInvoked after a node (or a set of siblings) has changed in some way.voidInvoked after nodes have been inserted into the tree.voidInvoked after nodes have been removed from the tree.voidInvoked after the tree has drastically changed structure from a given node down.Methods declared in class javax.swing.tree.AbstractLayoutCache
getModel, getNodeDimensions, getNodeDimensions, getRowHeight, getRowsForPaths, getSelectionModel, isFixedRowHeight, isRootVisible, setSelectionModel
-
Constructor Details
-
VariableHeightLayoutCache
public VariableHeightLayoutCache()Constructs aVariableHeightLayoutCache.
-
-
Method Details
-
setModel
@BeanProperty(description="The TreeModel that will provide the data.") public void setModel(TreeModel newModel) Sets theTreeModelthat will provide the data.- Overrides:
setModelin classAbstractLayoutCache- Parameters:
newModel- theTreeModelthat is to provide 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 theTreeModelis visible.- Overrides:
setRootVisiblein classAbstractLayoutCache- Parameters:
rootVisible- true if the root node of the tree is to be 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.- Overrides:
setRowHeightin classAbstractLayoutCache- Parameters:
rowHeight- the height of each cell, in pixels
-
setNodeDimensions
Sets the renderer that is responsible for drawing nodes in the tree.- Overrides:
setNodeDimensionsin classAbstractLayoutCache- Parameters:
nd- the renderer
-
setExpandedState
Marks the pathpathexpanded state toisExpanded.- Specified by:
setExpandedStatein classAbstractLayoutCache- Parameters:
path- theTreePathof interestisExpanded- true if the path should be expanded, otherwise false
-
getExpandedState
Returns true if the path is expanded, and visible.- Specified by:
getExpandedStatein classAbstractLayoutCache- Parameters:
path- the path being queried- Returns:
- true if the path is expanded and visible, otherwise false
-
getBounds
Returns theRectangleenclosing the label portion into which the item identified bypathwill be drawn.- Specified by:
getBoundsin classAbstractLayoutCache- Parameters:
path- the path to be drawnplaceIn- the bounds of the enclosing rectangle- Returns:
- the bounds of the enclosing rectangle or
nullif the node could not be ascertained
-
getPathForRow
Returns the path forrow. Ifrowis not visible,nullis returned.- Specified by:
getPathForRowin classAbstractLayoutCache- Parameters:
row- the location of interest- Returns:
- the path for
row, ornullifrowis not visible
-
getRowForPath
Returns the row where the last item identified in path is visible. Will return -1 if any of the elements in path are not currently visible.- Specified by:
getRowForPathin classAbstractLayoutCache- Parameters:
path- theTreePathof interest- Returns:
- the row where the last item in path is visible
-
getRowCount
public int getRowCount()Returns the number of visible rows.- Specified by:
getRowCountin classAbstractLayoutCache- Returns:
- the number of visible rows
-
invalidatePathBounds
Instructs theLayoutCachethat the bounds forpathare invalid, and need to be updated.- Specified by:
invalidatePathBoundsin classAbstractLayoutCache- Parameters:
path- theTreePathwhich is now invalid
-
getPreferredHeight
public int getPreferredHeight()Returns the preferred height.- Overrides:
getPreferredHeightin classAbstractLayoutCache- Returns:
- the preferred height
-
getPreferredWidth
Returns the preferred width and height for the region invisibleRegion.- Overrides:
getPreferredWidthin classAbstractLayoutCache- Parameters:
bounds- the region being queried- Returns:
- the preferred width for the passed in region
-
getPathClosestTo
Returns the path to the node that is closest to x,y. If there is nothing currently visible this will returnnull, otherwise it will 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.- Specified by:
getPathClosestToin classAbstractLayoutCache- Parameters:
x- the x-coordinatey- the y-coordinate- Returns:
- the path to the node that is closest to x, y
-
getVisiblePathsFrom
Returns anEnumeratorthat increments over the visible paths starting at the passed in location. The ordering of the enumeration is based on how the paths are displayed.- Specified by:
getVisiblePathsFromin classAbstractLayoutCache- Parameters:
path- the location in theTreePathto start- Returns:
- an
Enumeratorthat increments over the visible paths
-
getVisibleChildCount
Returns the number of visible children forpath.- Specified by:
getVisibleChildCountin classAbstractLayoutCache- Parameters:
path- the path being queried- Returns:
- the number of visible children for
path
-
invalidateSizes
public void invalidateSizes()Informs theTreeStatethat it needs to recalculate all the sizes it is referencing.- Specified by:
invalidateSizesin classAbstractLayoutCache
-
isExpanded
Returns true if the value identified bypathis currently expanded.- Specified by:
isExpandedin classAbstractLayoutCache- Parameters:
path- TreePath to check- Returns:
- true if the value identified by
pathis currently expanded
-
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.pathreturns the path the parent of the changed node(s).e.childIndicesreturns the index(es) of the changed node(s).- Specified by:
treeNodesChangedin classAbstractLayoutCache- Parameters:
e- theTreeModelEventof interest
-
treeNodesInserted
Invoked after nodes have been inserted into the tree.e.pathreturns the parent of the new nodes.e.childIndicesreturns the indices of the new nodes in ascending order.- Specified by:
treeNodesInsertedin classAbstractLayoutCache- Parameters:
e- theTreeModelEventof interest
-
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.pathreturns the former parent of the deleted nodes.e.childIndicesreturns the indices the nodes had before they were deleted in ascending order.- Specified by:
treeNodesRemovedin classAbstractLayoutCache- Parameters:
e- theTreeModelEventof interest
-
treeStructureChanged
Invoked after the tree has drastically changed structure from a given node down. If the path returned bye.getPathis 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.pathholds the path to the node.e.childIndicesreturnsnull.- Specified by:
treeStructureChangedin classAbstractLayoutCache- Parameters:
e- theTreeModelEventof interest
-