FixedHeightLayoutCache (Java SE 11 & JDK 11 ) (original) (raw)

java.lang.Object
- javax.swing.tree.AbstractLayoutCache
- - javax.swing.tree.FixedHeightLayoutCache
All Implemented Interfaces:
[RowMapper](RowMapper.html "interface in javax.swing.tree")

public class FixedHeightLayoutCache
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 declared in class javax.swing.tree.[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")  
 `[AbstractLayoutCache.NodeDimensions](AbstractLayoutCache.NodeDimensions.html "class in javax.swing.tree")`

Field Summary

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

Constructor Summary

Constructors

Constructor	Description
FixedHeightLayoutCache()	Constructs a FixedHeightLayoutCache.

Method Summary

All Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
Rectangle	getBounds(TreePath path,Rectangle placeIn)	Returns a rectangle giving the bounds needed to draw path.
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 passed in row.
int	getRowCount()	Returns the number of visible rows.
int	getRowForPath(TreePath path)	Returns the row that the last item identified in path is visible at.
int	getVisibleChildCount(TreePath path)	Returns the number of visible children for row.
Enumeration<TreePath>	getVisiblePathsFrom(TreePath path)	Returns an Enumerator that increments over the visible paths starting at the passed in location.
void	invalidatePathBounds(TreePath path)	Does nothing, FixedHeightLayoutCache doesn't cache width, and that is all that could change.
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 row 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	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 declared in class javax.swing.tree.[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")  
   `[getModel](AbstractLayoutCache.html#getModel%28%29), [getNodeDimensions](AbstractLayoutCache.html#getNodeDimensions%28%29), [getNodeDimensions](AbstractLayoutCache.html#getNodeDimensions%28java.lang.Object,int,int,boolean,java.awt.Rectangle%29), [getPreferredHeight](AbstractLayoutCache.html#getPreferredHeight%28%29), [getPreferredWidth](AbstractLayoutCache.html#getPreferredWidth%28java.awt.Rectangle%29), [getRowHeight](AbstractLayoutCache.html#getRowHeight%28%29), [getRowsForPaths](AbstractLayoutCache.html#getRowsForPaths%28javax.swing.tree.TreePath%5B%5D%29), [getSelectionModel](AbstractLayoutCache.html#getSelectionModel%28%29), [isFixedRowHeight](AbstractLayoutCache.html#isFixedRowHeight%28%29), [isRootVisible](AbstractLayoutCache.html#isRootVisible%28%29), [setNodeDimensions](AbstractLayoutCache.html#setNodeDimensions%28javax.swing.tree.AbstractLayoutCache.NodeDimensions%29), [setSelectionModel](AbstractLayoutCache.html#setSelectionModel%28javax.swing.tree.TreeSelectionModel%29)`  
   * ### Methods declared in class java.lang.[Object](../../../../java.base/java/lang/Object.html "class in java.lang")  
   `[clone](../../../../java.base/java/lang/Object.html#clone%28%29), [equals](../../../../java.base/java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java.base/java/lang/Object.html#finalize%28%29), [getClass](../../../../java.base/java/lang/Object.html#getClass%28%29), [hashCode](../../../../java.base/java/lang/Object.html#hashCode%28%29), [notify](../../../../java.base/java/lang/Object.html#notify%28%29), [notifyAll](../../../../java.base/java/lang/Object.html#notifyAll%28%29), [toString](../../../../java.base/java/lang/Object.html#toString%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long%29), [wait](../../../../java.base/java/lang/Object.html#wait%28long,int%29)`

Constructor Detail

 * #### FixedHeightLayoutCache  
 public FixedHeightLayoutCache()  
 Constructs a `FixedHeightLayoutCache`.

Method Detail

* #### setModel  
public void setModel([TreeModel](TreeModel.html "interface in javax.swing.tree") newModel)  
Sets the TreeModel that will provide the data.  
Overrides:  
`[setModel](AbstractLayoutCache.html#setModel%28javax.swing.tree.TreeModel%29)` in class `[AbstractLayoutCache](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](AbstractLayoutCache.html#setRootVisible%28boolean%29)` in class `[AbstractLayoutCache](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](AbstractLayoutCache.html#rootVisible)  
* #### setRowHeight  
public void setRowHeight(int rowHeight)  
Sets the height of each cell. If rowHeight is less than or equal to 0 this will throw an IllegalArgumentException.  
Overrides:  
`[setRowHeight](AbstractLayoutCache.html#setRowHeight%28int%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`rowHeight` \- the height of each cell, in pixels  
* #### getRowCount  
public int getRowCount()  
Returns the number of visible rows.  
Specified by:  
`[getRowCount](AbstractLayoutCache.html#getRowCount%28%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Returns:  
the number of rows being displayed  
* #### invalidatePathBounds  
public void invalidatePathBounds([TreePath](TreePath.html "class in javax.swing.tree") path)  
Does nothing, FixedHeightLayoutCache doesn't cache width, and that is all that could change.  
Specified by:  
`[invalidatePathBounds](AbstractLayoutCache.html#invalidatePathBounds%28javax.swing.tree.TreePath%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the path being updated  
* #### invalidateSizes  
public void invalidateSizes()  
Informs the TreeState that it needs to recalculate all the sizes it is referencing.  
Specified by:  
`[invalidateSizes](AbstractLayoutCache.html#invalidateSizes%28%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
* #### isExpanded  
public boolean isExpanded([TreePath](TreePath.html "class in javax.swing.tree") path)  
Returns true if the value identified by row is currently expanded.  
Specified by:  
`[isExpanded](AbstractLayoutCache.html#isExpanded%28javax.swing.tree.TreePath%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- TreePath to check  
Returns:  
whether TreePath is expanded  
* #### getBounds  
public [Rectangle](../../../java/awt/Rectangle.html "class in java.awt") getBounds([TreePath](TreePath.html "class in javax.swing.tree") path,  
                           [Rectangle](../../../java/awt/Rectangle.html "class in java.awt") placeIn)  
Returns a rectangle giving the bounds needed to draw path.  
Specified by:  
`[getBounds](AbstractLayoutCache.html#getBounds%28javax.swing.tree.TreePath,java.awt.Rectangle%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- a TreePath specifying a node  
`placeIn` \- a Rectangle object giving the available space  
Returns:  
a Rectangle object specifying the space to be used  
* #### getPathForRow  
public [TreePath](TreePath.html "class in javax.swing.tree") getPathForRow(int row)  
Returns the path for passed in row. If row is not visible null is returned.  
Specified by:  
`[getPathForRow](AbstractLayoutCache.html#getPathForRow%28int%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`row` \- the row being queried  
Returns:  
the `TreePath` for the given row  
* #### getRowForPath  
public int getRowForPath([TreePath](TreePath.html "class in javax.swing.tree") path)  
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.  
Specified by:  
`[getRowForPath](AbstractLayoutCache.html#getRowForPath%28javax.swing.tree.TreePath%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the `TreePath` 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  
public [TreePath](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'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.  
Specified by:  
`[getPathClosestTo](AbstractLayoutCache.html#getPathClosestTo%28int,int%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`x` \- the horizontal component of the desired location  
`y` \- the vertical component of the desired location  
Returns:  
the `TreePath` closest to the specified point  
* #### getVisibleChildCount  
public int getVisibleChildCount([TreePath](TreePath.html "class in javax.swing.tree") path)  
Returns the number of visible children for row.  
Specified by:  
`[getVisibleChildCount](AbstractLayoutCache.html#getVisibleChildCount%28javax.swing.tree.TreePath%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the path being queried  
Returns:  
the number of visible children for the specified path  
* #### getVisiblePathsFrom  
public [Enumeration](../../../../java.base/java/util/Enumeration.html "interface in java.util")<[TreePath](TreePath.html "class in javax.swing.tree")> getVisiblePathsFrom([TreePath](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](AbstractLayoutCache.html#getVisiblePathsFrom%28javax.swing.tree.TreePath%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the starting location for the enumeration  
Returns:  
the `Enumerator` starting at the desired location  
* #### setExpandedState  
public void setExpandedState([TreePath](TreePath.html "class in javax.swing.tree") path,  
                             boolean isExpanded)  
Marks the path `path` expanded state to`isExpanded`.  
Specified by:  
`[setExpandedState](AbstractLayoutCache.html#setExpandedState%28javax.swing.tree.TreePath,boolean%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the path being expanded or collapsed  
`isExpanded` \- true if the path should be expanded, false otherwise  
* #### getExpandedState  
public boolean getExpandedState([TreePath](TreePath.html "class in javax.swing.tree") path)  
Returns true if the path is expanded, and visible.  
Specified by:  
`[getExpandedState](AbstractLayoutCache.html#getExpandedState%28javax.swing.tree.TreePath%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`path` \- the path being queried  
Returns:  
true if the path is expanded and visible, false otherwise  
* #### treeNodesChanged  
public void treeNodesChanged([TreeModelEvent](../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](AbstractLayoutCache.html#treeNodesChanged%28javax.swing.event.TreeModelEvent%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`e` \- the `TreeModelEvent`  
* #### treeNodesInserted  
public void treeNodesInserted([TreeModelEvent](../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](AbstractLayoutCache.html#treeNodesInserted%28javax.swing.event.TreeModelEvent%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`e` \- the `TreeModelEvent`  
* #### treeNodesRemoved  
public void treeNodesRemoved([TreeModelEvent](../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](AbstractLayoutCache.html#treeNodesRemoved%28javax.swing.event.TreeModelEvent%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`e` \- the `TreeModelEvent`  
* #### treeStructureChanged  
public void treeStructureChanged([TreeModelEvent](../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](AbstractLayoutCache.html#treeStructureChanged%28javax.swing.event.TreeModelEvent%29)` in class `[AbstractLayoutCache](AbstractLayoutCache.html "class in javax.swing.tree")`  
Parameters:  
`e` \- the `TreeModelEvent`

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

FixedHeightLayoutCache (Java SE 11 & JDK 11 ) (original) (raw)

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail