public abstract class AbstractLayoutCache extends Object implements 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.
| Modifier and Type | Class and Description |
|---|---|
static class |
AbstractLayoutCache.NodeDimensions Used by |
protected AbstractLayoutCache.NodeDimensions nodeDimensions
Object responsible for getting the size of a node.
protected TreeModel treeModel
Model providing information.
protected TreeSelectionModel treeSelectionModel
Selection model.
protected boolean rootVisible
True if the root node is displayed, false if its children are the highest visible nodes.
protected int rowHeight
Height to use for each row. If this is <= 0 the renderer will be used to determine the height for each row.
public AbstractLayoutCache()
public void setNodeDimensions(AbstractLayoutCache.NodeDimensions nd)
Sets the renderer that is responsible for drawing nodes in the tree and which is therefore responsible for calculating the dimensions of individual nodes.
nd - a NodeDimensions objectpublic AbstractLayoutCache.NodeDimensions getNodeDimensions()
Returns the object that renders nodes in the tree, and which is responsible for calculating the dimensions of individual nodes.
NodeDimensions objectpublic void setModel(TreeModel newModel)
Sets the TreeModel that will provide the data.
newModel - the TreeModel that is to provide the datapublic TreeModel getModel()
Returns the TreeModel that is providing the data.
TreeModel that is providing the datapublic void setRootVisible(boolean rootVisible)
Determines whether or not the root node from the TreeModel is visible.
rootVisible - true if the root node of the tree is to be displayedrootVisiblepublic boolean isRootVisible()
Returns true if the root node of the tree is displayed.
rootVisiblepublic 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.
rowHeight - the height of each cell, in pixelspublic 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.
public void setSelectionModel(TreeSelectionModel newLSM)
Sets the TreeSelectionModel used to manage the selection to new LSM.
newLSM - the new TreeSelectionModel
public TreeSelectionModel getSelectionModel()
Returns the model used to maintain the selection.
treeSelectionModel
public int getPreferredHeight()
Returns the preferred height.
public int getPreferredWidth(Rectangle bounds)
Returns the preferred width for the passed in region. The region is defined by the path closest to (bounds.x, bounds.y) and ends at bounds.height + bounds.y. If bounds is null, the preferred width for all the nodes will be returned (and this may be a VERY expensive computation).
bounds - the region being queriedpublic abstract boolean isExpanded(TreePath path)
Returns true if the value identified by row is currently expanded.
public abstract Rectangle getBounds(TreePath path,
Rectangle placeIn) Returns a rectangle giving the bounds needed to draw path.
path - a TreePath specifying a nodeplaceIn - a Rectangle object giving the available spaceRectangle object specifying the space to be usedpublic abstract TreePath getPathForRow(int row)
Returns the path for passed in row. If row is not visible null is returned.
row - the row being queriedTreePath for the given rowpublic abstract int getRowForPath(TreePath 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.
path - the TreePath being queriedpublic abstract 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'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.
x - the horizontal component of the desired locationy - the vertical component of the desired locationTreePath closest to the specified pointpublic abstract 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. The first element of the returned enumeration will be path, unless it isn't visible, in which case null will be returned.
path - the starting location for the enumerationEnumerator starting at the desired locationpublic abstract int getVisibleChildCount(TreePath path)
Returns the number of visible children for row.
path - the path being queriedpublic abstract void setExpandedState(TreePath path,
boolean isExpanded) Marks the path path expanded state to isExpanded.
path - the path being expanded or collapsedisExpanded - true if the path should be expanded, false otherwisepublic abstract boolean getExpandedState(TreePath path)
Returns true if the path is expanded, and visible.
path - the path being queriedpublic abstract int getRowCount()
Number of rows being displayed.
public abstract void invalidateSizes()
Informs the TreeState that it needs to recalculate all the sizes it is referencing.
public abstract void invalidatePathBounds(TreePath path)
Instructs the LayoutCache that the bounds for path are invalid, and need to be updated.
path - the path being updatedpublic abstract 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).
e - the TreeModelEvent
public abstract 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.
e - the TreeModelEvent
public abstract 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.
e - the TreeModelEvent
public abstract 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.
e - the TreeModelEvent
public int[] getRowsForPaths(TreePath[] paths)
Returns the rows that the TreePath instances in path are being displayed at. This method should return an array of the same length as that passed in, and if one of the TreePaths in path is not valid its entry in the array should be set to -1.
getRowsForPaths in interface RowMapper
paths - the array of TreePaths being queriedTreePath is displayed; if paths is null, null is returnedprotected Rectangle getNodeDimensions(Object value,
int row,
int depth,
boolean expanded,
Rectangle placeIn) Returns, by reference in placeIn, the size needed to represent value. If inPlace is null, a newly created Rectangle should be returned, otherwise the value should be placed in inPlace and returned. This will return null if there is no renderer.
value - the value to be representedrow - row being querieddepth - the depth of the rowexpanded - true if row is expanded, false otherwiseplaceIn - a Rectangle containing the size needed to represent value
Rectangle containing the node dimensions, or null if node has no dimensionprotected boolean isFixedRowHeight()
Returns true if the height of each row is a fixed size.
© 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.