VariableHeightLayoutCache (Java Platform SE 8 ) (original) (raw)

java.lang.Object
- javax.swing.tree.AbstractLayoutCache
- - javax.swing.tree.VariableHeightLayoutCache
All Implemented Interfaces:
RowMapper

public class VariableHeightLayoutCache
extends AbstractLayoutCache
NOTE: This will become more open in a future release.
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 inherited from class javax.swing.tree.[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")  
 `[AbstractLayoutCache.NodeDimensions](../../../javax/swing/tree/AbstractLayoutCache.NodeDimensions.html "class in javax.swing.tree")`

Field Summary

* ### Fields inherited from class javax.swing.tree.[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")  
`[nodeDimensions](../../../javax/swing/tree/AbstractLayoutCache.html#nodeDimensions), [rootVisible](../../../javax/swing/tree/AbstractLayoutCache.html#rootVisible), [rowHeight](../../../javax/swing/tree/AbstractLayoutCache.html#rowHeight), [treeModel](../../../javax/swing/tree/AbstractLayoutCache.html#treeModel), [treeSelectionModel](../../../javax/swing/tree/AbstractLayoutCache.html#treeSelectionModel)`

Constructor Summary

Constructors

Constructor	Description
VariableHeightLayoutCache()

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
Rectangle	getBounds(TreePath path,Rectangle placeIn)	Returns the Rectangle enclosing the label portion into which the item identified by path will be drawn.
boolean	getExpandedState(TreePath path)	Returns true if the path is expanded, and visible.
TreePath	getPathClosestTo(int x, int y)	Returns the path to the node that is closest to x,y.
TreePath	getPathForRow(int row)	Returns the path for row.
int	getPreferredHeight()	Returns the preferred height.
int	getPreferredWidth(Rectangle bounds)	Returns the preferred width and height for the region invisibleRegion.
int	getRowCount()	Returns the number of visible rows.
int	getRowForPath(TreePath path)	Returns the row where the last item identified in path is visible.
int	getVisibleChildCount(TreePath path)	Returns the number of visible children for path.
Enumeration<TreePath>	getVisiblePathsFrom(TreePath path)	Returns an Enumerator that increments over the visible paths starting at the passed in location.
void	invalidatePathBounds(TreePath path)	Instructs the LayoutCache that the bounds forpath are invalid, and need to be updated.
void	invalidateSizes()	Informs the TreeState that it needs to recalculate all the sizes it is referencing.
boolean	isExpanded(TreePath path)	Returns true if the value identified by path is currently expanded.
void	setExpandedState(TreePath path, boolean isExpanded)	Marks the path path expanded state toisExpanded.
void	setModel(TreeModel newModel)	Sets the TreeModel that will provide the data.
void	setNodeDimensions(AbstractLayoutCache.NodeDimensions nd)	Sets the renderer that is responsible for drawing nodes in the tree.
void	setRootVisible(boolean rootVisible)	Determines whether or not the root node from the TreeModel is visible.
void	setRowHeight(int rowHeight)	Sets the height of each cell.
void	treeNodesChanged(TreeModelEvent e)	Invoked after a node (or a set of siblings) has changed in some way.
void	treeNodesInserted(TreeModelEvent e)	Invoked after nodes have been inserted into the tree.
void	treeNodesRemoved(TreeModelEvent e)	Invoked after nodes have been removed from the tree.
void	treeStructureChanged(TreeModelEvent e)	Invoked after the tree has drastically changed structure from a given node down.

   * ### Methods inherited from class javax.swing.tree.[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")  
   `[getModel](../../../javax/swing/tree/AbstractLayoutCache.html#getModel--), [getNodeDimensions](../../../javax/swing/tree/AbstractLayoutCache.html#getNodeDimensions--), [getNodeDimensions](../../../javax/swing/tree/AbstractLayoutCache.html#getNodeDimensions-java.lang.Object-int-int-boolean-java.awt.Rectangle-), [getRowHeight](../../../javax/swing/tree/AbstractLayoutCache.html#getRowHeight--), [getRowsForPaths](../../../javax/swing/tree/AbstractLayoutCache.html#getRowsForPaths-javax.swing.tree.TreePath:A-), [getSelectionModel](../../../javax/swing/tree/AbstractLayoutCache.html#getSelectionModel--), [isFixedRowHeight](../../../javax/swing/tree/AbstractLayoutCache.html#isFixedRowHeight--), [isRootVisible](../../../javax/swing/tree/AbstractLayoutCache.html#isRootVisible--), [setSelectionModel](../../../javax/swing/tree/AbstractLayoutCache.html#setSelectionModel-javax.swing.tree.TreeSelectionModel-)`  
   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

Constructor Detail

 * #### VariableHeightLayoutCache  
 public VariableHeightLayoutCache()

Method Detail

* #### setModel  
public void setModel([TreeModel](../../../javax/swing/tree/TreeModel.html "interface in javax.swing.tree") newModel)  
Sets the `TreeModel` that will provide the data.  
Overrides:  
`[setModel](../../../javax/swing/tree/AbstractLayoutCache.html#setModel-javax.swing.tree.TreeModel-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`newModel` \- the `TreeModel` that is to provide the data  
* #### setRootVisible  
public void setRootVisible(boolean rootVisible)  
Determines whether or not the root node from the `TreeModel` is visible.  
Overrides:  
`[setRootVisible](../../../javax/swing/tree/AbstractLayoutCache.html#setRootVisible-boolean-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`rootVisible` \- true if the root node of the tree is to be displayed  
See Also:  
[AbstractLayoutCache.rootVisible](../../../javax/swing/tree/AbstractLayoutCache.html#rootVisible)  
* #### setRowHeight  
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.  
Overrides:  
`[setRowHeight](../../../javax/swing/tree/AbstractLayoutCache.html#setRowHeight-int-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`rowHeight` \- the height of each cell, in pixels  
* #### setNodeDimensions  
public void setNodeDimensions([AbstractLayoutCache.NodeDimensions](../../../javax/swing/tree/AbstractLayoutCache.NodeDimensions.html "class in javax.swing.tree") nd)  
Sets the renderer that is responsible for drawing nodes in the tree.  
Overrides:  
`[setNodeDimensions](../../../javax/swing/tree/AbstractLayoutCache.html#setNodeDimensions-javax.swing.tree.AbstractLayoutCache.NodeDimensions-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`nd` \- the renderer  
* #### setExpandedState  
public void setExpandedState([TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") path,  
                             boolean isExpanded)  
Marks the path `path` expanded state to`isExpanded`.  
Specified by:  
`[setExpandedState](../../../javax/swing/tree/AbstractLayoutCache.html#setExpandedState-javax.swing.tree.TreePath-boolean-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the `TreePath` of interest  
`isExpanded` \- true if the path should be expanded, otherwise false  
* #### getExpandedState  
public boolean getExpandedState([TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") path)  
Returns true if the path is expanded, and visible.  
Specified by:  
`[getExpandedState](../../../javax/swing/tree/AbstractLayoutCache.html#getExpandedState-javax.swing.tree.TreePath-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the path being queried  
Returns:  
true if the path is expanded and visible, otherwise false  
* #### getBounds  
public [Rectangle](../../../java/awt/Rectangle.html "class in java.awt") getBounds([TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") path,  
                           [Rectangle](../../../java/awt/Rectangle.html "class in java.awt") placeIn)  
Returns the `Rectangle` enclosing the label portion into which the item identified by `path` will be drawn.  
Specified by:  
`[getBounds](../../../javax/swing/tree/AbstractLayoutCache.html#getBounds-javax.swing.tree.TreePath-java.awt.Rectangle-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the path to be drawn  
`placeIn` \- the bounds of the enclosing rectangle  
Returns:  
the bounds of the enclosing rectangle or `null` if the node could not be ascertained  
* #### getPathForRow  
public [TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") getPathForRow(int row)  
Returns the path for `row`. If `row` is not visible, `null` is returned.  
Specified by:  
`[getPathForRow](../../../javax/swing/tree/AbstractLayoutCache.html#getPathForRow-int-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`row` \- the location of interest  
Returns:  
the path for `row`, or `null` if `row` is not visible  
* #### getRowForPath  
public int getRowForPath([TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") path)  
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:  
`[getRowForPath](../../../javax/swing/tree/AbstractLayoutCache.html#getRowForPath-javax.swing.tree.TreePath-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the `TreePath` of interest  
Returns:  
the row where the last item in path is visible  
* #### getRowCount  
public int getRowCount()  
Returns the number of visible rows.  
Specified by:  
`[getRowCount](../../../javax/swing/tree/AbstractLayoutCache.html#getRowCount--)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Returns:  
the number of visible rows  
* #### invalidatePathBounds  
public void invalidatePathBounds([TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") path)  
Instructs the `LayoutCache` that the bounds for`path` are invalid, and need to be updated.  
Specified by:  
`[invalidatePathBounds](../../../javax/swing/tree/AbstractLayoutCache.html#invalidatePathBounds-javax.swing.tree.TreePath-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the `TreePath` which is now invalid  
* #### getPreferredHeight  
public int getPreferredHeight()  
Returns the preferred height.  
Overrides:  
`[getPreferredHeight](../../../javax/swing/tree/AbstractLayoutCache.html#getPreferredHeight--)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Returns:  
the preferred height  
* #### getPreferredWidth  
public int getPreferredWidth([Rectangle](../../../java/awt/Rectangle.html "class in java.awt") bounds)  
Returns the preferred width and height for the region in`visibleRegion`.  
Overrides:  
`[getPreferredWidth](../../../javax/swing/tree/AbstractLayoutCache.html#getPreferredWidth-java.awt.Rectangle-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`bounds` \- the region being queried  
Returns:  
the preferred width for the passed in region  
* #### getPathClosestTo  
public [TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") 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 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:  
`[getPathClosestTo](../../../javax/swing/tree/AbstractLayoutCache.html#getPathClosestTo-int-int-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`x` \- the x-coordinate  
`y` \- the y-coordinate  
Returns:  
the path to the node that is closest to x, y  
* #### getVisiblePathsFrom  
public [Enumeration](../../../java/util/Enumeration.html "interface in java.util")<[TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree")> getVisiblePathsFrom([TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") 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.  
Specified by:  
`[getVisiblePathsFrom](../../../javax/swing/tree/AbstractLayoutCache.html#getVisiblePathsFrom-javax.swing.tree.TreePath-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the location in the `TreePath` to start  
Returns:  
an `Enumerator` that increments over the visible paths  
* #### getVisibleChildCount  
public int getVisibleChildCount([TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") path)  
Returns the number of visible children for `path`.  
Specified by:  
`[getVisibleChildCount](../../../javax/swing/tree/AbstractLayoutCache.html#getVisibleChildCount-javax.swing.tree.TreePath-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the path being queried  
Returns:  
the number of visible children for `path`  
* #### invalidateSizes  
public void invalidateSizes()  
Informs the `TreeState` that it needs to recalculate all the sizes it is referencing.  
Specified by:  
`[invalidateSizes](../../../javax/swing/tree/AbstractLayoutCache.html#invalidateSizes--)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
* #### isExpanded  
public boolean isExpanded([TreePath](../../../javax/swing/tree/TreePath.html "class in javax.swing.tree") path)  
Returns true if the value identified by `path` is currently expanded.  
Specified by:  
`[isExpanded](../../../javax/swing/tree/AbstractLayoutCache.html#isExpanded-javax.swing.tree.TreePath-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Returns:  
true if the value identified by `path` is currently expanded  
* #### treeNodesChanged  
public void treeNodesChanged([TreeModelEvent](../../../javax/swing/event/TreeModelEvent.html "class in javax.swing.event") 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).  
Specified by:  
`[treeNodesChanged](../../../javax/swing/tree/AbstractLayoutCache.html#treeNodesChanged-javax.swing.event.TreeModelEvent-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`e` \- the `TreeModelEvent` of interest  
* #### treeNodesInserted  
public void treeNodesInserted([TreeModelEvent](../../../javax/swing/event/TreeModelEvent.html "class in javax.swing.event") 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.  
Specified by:  
`[treeNodesInserted](../../../javax/swing/tree/AbstractLayoutCache.html#treeNodesInserted-javax.swing.event.TreeModelEvent-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`e` \- the `TreeModelEvent` of interest  
* #### treeNodesRemoved  
public void treeNodesRemoved([TreeModelEvent](../../../javax/swing/event/TreeModelEvent.html "class in javax.swing.event") 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.  
Specified by:  
`[treeNodesRemoved](../../../javax/swing/tree/AbstractLayoutCache.html#treeNodesRemoved-javax.swing.event.TreeModelEvent-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`e` \- the `TreeModelEvent` of interest  
* #### treeStructureChanged  
public void treeStructureChanged([TreeModelEvent](../../../javax/swing/event/TreeModelEvent.html "class in javax.swing.event") 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`.  
Specified by:  
`[treeStructureChanged](../../../javax/swing/tree/AbstractLayoutCache.html#treeStructureChanged-javax.swing.event.TreeModelEvent-)` in class `[AbstractLayoutCache](../../../javax/swing/tree/AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`e` \- the `TreeModelEvent` of interest

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

VariableHeightLayoutCache (Java Platform SE 8 ) (original) (raw)

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail