javax.swing.tree.VariableHeightLayoutCache

VariableHeightLayoutCache

Java SE 6

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^TM has been added to the java.beans package. Please see java.beans.XMLEncoder.

version 1.22 11/17/05

Constructors

public

VariableHeightLayoutCache()

Methods

public void

invalidatePathBounds(TreePath path)
Instructs the LayoutCache that the bounds for path are invalid, and need to be updated.

path the TreePath which is now invalid

public void

invalidateSizes()
Informs the TreeState that it needs to recalculate all the sizes it is referencing.

public 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 of interest

public 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 of interest

public 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 of interest

public 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 of interest

Properties

public Rectangle

getBounds(TreePath path, Rectangle placeIn)
Returns the Rectangle enclosing the label portion into which the item identified by path will be drawn.

path	the path to be drawn
placeIn	the bounds of the enclosing rectangle
return	the bounds of the enclosing rectangle or `null` if the node could not be ascertained

public boolean

isExpanded(TreePath path)
Returns true if the value identified by path is currently expanded.

return true if the value identified by path is currently expanded

public void

setExpandedState(TreePath path, boolean isExpanded)
Marks the path path expanded state to isExpanded.

path	the `TreePath` of interest
isExpanded	true if the path should be expanded, otherwise false

public boolean

getExpandedState(TreePath path)
Returns true if the path is expanded, and visible.

return

true if the path is expanded and visible, otherwise false

public void

setModel(TreeModel newModel)
Sets the TreeModel that will provide the data.

newModel	the `TreeModel` that is to provide the data
beaninfo	bound: true description: The TreeModel that will provide the data.

public void

setNodeDimensions(AbstractLayoutCache.NodeDimensions nd)
Sets the renderer that is responsible for drawing nodes in the tree.

nd	the renderer

public 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.

x	the x-coordinate
y	the y-coordinate
return	the path to the node that is closest to x, y

public TreePath

getPathForRow(int row)
Returns the path for row. If row is not visible, null is returned.

row	the location of interest
return	the path for `row`, or `null` if `row` is not visible

public int

getPreferredHeight()
Returns the preferred height.

return

the preferred height

public int

getPreferredWidth(Rectangle bounds)
Returns the preferred width and height for the region in visibleRegion.

bounds

the region being queried

public 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 displayed
beaninfo	bound: true description: Whether or not the root node from the TreeModel is visible.
See also	rootVisible

public int

getRowCount()
Returns the number of visible rows.

return

the number of visible rows

public 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.

path	the `TreePath` of interest
return	the row where the last item in path is visible

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.

rowHeight	the height of each cell, in pixels
beaninfo	bound: true description: The height of each cell.

public int

getVisibleChildCount(TreePath path)
Returns the number of visible children for path.

return the number of visible children for path

public Enumeration

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.

path	the location in the `TreePath` to start
return	an `Enumerator` that increments over the visible paths

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6