javax.swing.tree.AbstractLayoutCache

AbstractLayoutCache

Java SE 6

Implements: RowMapper

Inner classes: AbstractLayoutCache.NodeDimensions

Extended by: FixedHeightLayoutCache, VariableHeightLayoutCache

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.18 11/17/05

Fields

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.

Constructors

public

AbstractLayoutCache()

Methods

abstract public void

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

path

the path being updated

abstract public void

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

abstract 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`

abstract 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`

abstract 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`

abstract 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`

Properties

abstract public Rectangle

getBounds(TreePath path, Rectangle placeIn)
Returns a rectangle giving the bounds needed to draw path.

path	a `TreePath` specifying a node
placeIn	a `Rectangle` object giving the available space
return	a `Rectangle` object specifying the space to be used

abstract public boolean

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

abstract public void

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

path	the path being expanded or collapsed
isExpanded	true if the path should be expanded, false otherwise

abstract public boolean

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

path	the path being queried
return	true if the path is expanded and visible, false otherwise

protected boolean

isFixedRowHeight()
Returns true if the height of each row is a fixed size.

public void

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

newModel the TreeModel that is to provide the data

public TreeModel

getModel()
Returns the TreeModel that is providing the data.

return the TreeModel that is providing the data

public void

setNodeDimensions(AbstractLayoutCache.NodeDimensions nd)
Sets the renderer that is responsible for drawing nodes in the tree and which is threfore responsible for calculating the dimensions of individual nodes.

nd	a `NodeDimensions` object

public AbstractLayoutCache.NodeDimensions

getNodeDimensions()
Returns the object that renders nodes in the tree, and which is responsible for calculating the dimensions of individual nodes.

return the NodeDimensions object

protected 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 represented
row	row being queried
depth	the depth of the row
expanded	true if row is expanded, false otherwise
placeIn	a `Rectangle` containing the size needed to represent `value`
return	a `Rectangle` containing the node dimensions, or `null` if node has no dimension

abstract 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'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 location
y	the vertical component of the desired location
return	the `TreePath` closest to the specified point

abstract public TreePath

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

row	the row being queried
return	the `TreePath` for the given row

public int

getPreferredHeight()
Returns the preferred height.

return

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 queried
return	the preferred width for the passed in region

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 boolean

isRootVisible()
Returns true if the root node of the tree is displayed.

return	true if the root node of the tree is displayed
See also	rootVisible

abstract public int

getRowCount()
Number of rows being displayed.

return

the number of rows being displayed

abstract public 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 queried
return	the row where the last item in path is visible or -1 if any elements in path aren't currently 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

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

paths	the array of `TreePath`s being queried
return	an array of the same length that is passed in containing the rows that each corresponding where each `TreePath` is displayed; if `paths` is `null`, `null` is returned

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.

return the treeSelectionModel

abstract public int

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

path	the path being queried
return	the number of visible children for the specified path

abstract 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. 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 enumeration
return	the `Enumerator` starting at the desired location

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

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

Java SE 6