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
.
AbstractLayoutCache.NodeDimensions
nodeDimensions, rootVisible, rowHeight, treeModel, treeSelectionModel
public VariableHeightLayoutCache()
public void setModel(TreeModel newModel)
Sets the TreeModel
that will provide the data.
setModel
in class AbstractLayoutCache
newModel
- the TreeModel
that is to provide the datapublic void setRootVisible(boolean rootVisible)
Determines whether or not the root node from the TreeModel
is visible.
setRootVisible
in class AbstractLayoutCache
rootVisible
- true if the root node of the tree is to be displayedAbstractLayoutCache.rootVisible
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.
setRowHeight
in class AbstractLayoutCache
rowHeight
- the height of each cell, in pixelspublic void setNodeDimensions(AbstractLayoutCache.NodeDimensions nd)
Sets the renderer that is responsible for drawing nodes in the tree.
setNodeDimensions
in class AbstractLayoutCache
nd
- the rendererpublic void setExpandedState(TreePath path, boolean isExpanded)
Marks the path path
expanded state to isExpanded
.
setExpandedState
in class AbstractLayoutCache
path
- the TreePath
of interestisExpanded
- true if the path should be expanded, otherwise falsepublic boolean getExpandedState(TreePath path)
Returns true if the path is expanded, and visible.
getExpandedState
in class AbstractLayoutCache
path
- the path being queriedpublic Rectangle getBounds(TreePath path, Rectangle placeIn)
Returns the Rectangle
enclosing the label portion into which the item identified by path
will be drawn.
getBounds
in class AbstractLayoutCache
path
- the path to be drawnplaceIn
- the bounds of the enclosing rectanglenull
if the node could not be ascertainedpublic TreePath getPathForRow(int row)
Returns the path for row
. If row
is not visible, null
is returned.
getPathForRow
in class AbstractLayoutCache
row
- the location of interestrow
, or null
if row
is not visiblepublic int getRowForPath(TreePath 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.
getRowForPath
in class AbstractLayoutCache
path
- the TreePath
of interestpublic int getRowCount()
Returns the number of visible rows.
getRowCount
in class AbstractLayoutCache
public void invalidatePathBounds(TreePath path)
Instructs the LayoutCache
that the bounds for path
are invalid, and need to be updated.
invalidatePathBounds
in class AbstractLayoutCache
path
- the TreePath
which is now invalidpublic int getPreferredHeight()
Returns the preferred height.
getPreferredHeight
in class AbstractLayoutCache
public int getPreferredWidth(Rectangle bounds)
Returns the preferred width and height for the region in visibleRegion
.
getPreferredWidth
in class AbstractLayoutCache
bounds
- the region being queriedpublic TreePath 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.
getPathClosestTo
in class AbstractLayoutCache
x
- the x-coordinatey
- the y-coordinatepublic Enumeration<TreePath> getVisiblePathsFrom(TreePath 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.
getVisiblePathsFrom
in class AbstractLayoutCache
path
- the location in the TreePath
to startEnumerator
that increments over the visible pathspublic int getVisibleChildCount(TreePath path)
Returns the number of visible children for path
.
getVisibleChildCount
in class AbstractLayoutCache
path
- the path being queriedpath
public void invalidateSizes()
Informs the TreeState
that it needs to recalculate all the sizes it is referencing.
invalidateSizes
in class AbstractLayoutCache
public boolean isExpanded(TreePath path)
Returns true if the value identified by path
is currently expanded.
isExpanded
in class AbstractLayoutCache
path
is currently expandedpublic void treeNodesChanged(TreeModelEvent 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).
treeNodesChanged
in class AbstractLayoutCache
e
- the TreeModelEvent
of interestpublic void treeNodesInserted(TreeModelEvent 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.
treeNodesInserted
in class AbstractLayoutCache
e
- the TreeModelEvent
of interestpublic void treeNodesRemoved(TreeModelEvent 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.
treeNodesRemoved
in class AbstractLayoutCache
e
- the TreeModelEvent
of interestpublic void treeStructureChanged(TreeModelEvent 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
.
treeStructureChanged
in class AbstractLayoutCache
e
- the TreeModelEvent
of interest
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.