| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 JavaBeansTM
has been added to the java.beans
package.
Please see {@link java.beans.XMLEncoder}.
Nested Class Summary | |
---|---|
abstract static class |
Used by AbstractLayoutCache to determine the size
and x origin of a particular node. |
Field Summary | |
---|---|
protected AbstractLayoutCache.NodeDimensions |
nodeDimensions
Object responsible for getting the size of a node. |
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. |
protected TreeModel |
treeModel
Model providing information. |
protected TreeSelectionModel |
treeSelectionModel
Selection model. |
Constructor Summary | |
---|---|
|
Method Summary | |
---|---|
abstract Rectangle |
Returns a rectangle giving the bounds needed to draw path. |
abstract boolean |
getExpandedState(TreePath path) Returns true if the path is expanded, and visible. |
TreeModel |
getModel() Returns the TreeModel that is providing the data.
|
AbstractLayoutCache.NodeDimensions |
Returns the object that renders nodes in the tree, and which is responsible for calculating the dimensions of individual nodes. |
protected Rectangle |
getNodeDimensions(Object value, int row, int depth, boolean expanded, Rectangle placeIn) Returns, by reference in placeIn ,
the size needed to represent value .
|
abstract TreePath |
getPathClosestTo(int x, int y) Returns the path to the node that is closest to x,y. |
abstract TreePath |
getPathForRow(int row) Returns the path for passed in row. |
int |
Returns the preferred height. |
int |
getPreferredWidth(Rectangle bounds) Returns the preferred width for the passed in region. |
abstract int |
Number of rows being displayed. |
abstract int |
getRowForPath(TreePath path) Returns the row that the last item identified in path is visible at. |
int |
Returns the height of each row. |
int[] |
getRowsForPaths(TreePath[] paths) Returns the rows that the TreePath instances in
path are being displayed at.
|
TreeSelectionModel |
Returns the model used to maintain the selection. |
abstract int |
getVisibleChildCount(TreePath path) Returns the number of visible children for row. |
abstract Enumeration |
getVisiblePathsFrom(TreePath path) Returns an Enumerator that increments over the visible
paths starting at the passed in location.
|
abstract void |
invalidatePathBounds(TreePath path) Instructs the LayoutCache that the bounds for
path are invalid, and need to be updated.
|
abstract void |
Informs the TreeState that it needs to recalculate
all the sizes it is referencing.
|
abstract boolean |
isExpanded(TreePath path) Returns true if the value identified by row is currently expanded. |
protected boolean |
Returns true if the height of each row is a fixed size. |
boolean |
Returns true if the root node of the tree is displayed. |
abstract void |
setExpandedState(TreePath path, boolean isExpanded) Marks the path path expanded state to
isExpanded .
|
void |
Sets the TreeModel that will provide the data.
|
void |
Sets the renderer that is responsible for drawing nodes in the tree and which is threfore responsible for calculating the dimensions of individual nodes. |
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 |
setSelectionModel(TreeSelectionModel newLSM) Sets the TreeSelectionModel used to manage the
selection to new LSM.
|
abstract void |
Invoked after a node (or a set of siblings) has changed in some way. |
abstract void |
Invoked after nodes have been inserted into the tree. |
abstract void |
Invoked after nodes have been removed from the tree. |
abstract void |
Invoked after the tree has drastically changed structure from a given node down. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected AbstractLayoutCache.NodeDimensions nodeDimensions
protected boolean rootVisible
protected int rowHeight
protected TreeModel treeModel
protected TreeSelectionModel treeSelectionModel
Constructor Detail |
---|
public AbstractLayoutCache()
Method Detail |
---|
public abstract Rectangle getBounds(TreePath path, Rectangle placeIn)
path
- a TreePath
specifying a nodeplaceIn
- a Rectangle
object giving the
available spaceRectangle
object specifying the space to be usedpublic abstract boolean getExpandedState(TreePath path)
path
- the path being queriedpublic TreeModel getModel()
TreeModel
that is providing the data.
TreeModel
that is providing the datapublic AbstractLayoutCache.NodeDimensions getNodeDimensions()
NodeDimensions
objectprotected Rectangle getNodeDimensions(Object value, int row, int depth, boolean expanded, Rectangle placeIn)
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 dimensionpublic abstract TreePath getPathClosestTo(int x, int y)
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 TreePath getPathForRow(int row)
null
is returned.
row
- the row being queriedTreePath
for the given rowpublic int getPreferredHeight()
public int getPreferredWidth(Rectangle bounds)
(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 int getRowCount()
public abstract int getRowForPath(TreePath path)
path
- the TreePath
being queriedpublic int getRowHeight()
public int[] getRowsForPaths(TreePath[] paths)
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 queriedTreePath
is displayed; if paths
is null
, null
is returnedpublic TreeSelectionModel getSelectionModel()
treeSelectionModel
public abstract int getVisibleChildCount(TreePath path)
path
- the path being queriedpublic abstract Enumeration getVisiblePathsFrom(TreePath path)
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 void invalidatePathBounds(TreePath path)
LayoutCache
that the bounds for
path
are invalid, and need to be updated.
path
- the path being updatedpublic abstract void invalidateSizes()
TreeState
that it needs to recalculate
all the sizes it is referencing.
public abstract boolean isExpanded(TreePath path)
path
protected boolean isFixedRowHeight()
public boolean isRootVisible()
public abstract void setExpandedState(TreePath path, boolean isExpanded)
path
expanded state to
isExpanded
.
path
- the path being expanded or collapsedisExpanded
- true if the path should be expanded, false otherwisepublic void setModel(TreeModel newModel)
TreeModel
that will provide the data.
newModel
- the TreeModel
that is to
provide the datapublic void setNodeDimensions(AbstractLayoutCache.NodeDimensions nd)
nd
- a NodeDimensions
objectpublic void setRootVisible(boolean rootVisible)
TreeModel
is visible.
rootVisible
- true if the root node of the tree is to be displayedpublic void setRowHeight(int rowHeight)
rowHeight
- the height of each cell, in pixelspublic void setSelectionModel(TreeSelectionModel newLSM)
TreeSelectionModel
used to manage the
selection to new LSM.
newLSM
- the new TreeSelectionModel
public 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
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |