javax.swing.tree
Class AbstractLayoutCache

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.swing.tree.AbstractLayoutCache
All Implemented Interfaces:
RowMapper sample code for javax.swing.tree.RowMapper definition code for javax.swing.tree.RowMapper
Direct Known Subclasses:
FixedHeightLayoutCache sample code for javax.swing.tree.FixedHeightLayoutCache definition code for javax.swing.tree.FixedHeightLayoutCache , VariableHeightLayoutCache sample code for javax.swing.tree.VariableHeightLayoutCache definition code for javax.swing.tree.VariableHeightLayoutCache

public abstract class AbstractLayoutCache
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements RowMapper sample code for javax.swing.tree.RowMapper definition code for javax.swing.tree.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 XMLEncoder sample code for java.beans.XMLEncoder definition code for java.beans.XMLEncoder .


Nested Class Summary
static class AbstractLayoutCache.NodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.NodeDimensions definition code for javax.swing.tree.AbstractLayoutCache.NodeDimensions
          Used by AbstractLayoutCache to determine the size and x origin of a particular node.
 
Field Summary
protected  AbstractLayoutCache.NodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.NodeDimensions definition code for javax.swing.tree.AbstractLayoutCache.NodeDimensions nodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.nodeDimensions definition code for javax.swing.tree.AbstractLayoutCache.nodeDimensions
          Object responsible for getting the size of a node.
protected  boolean rootVisible sample code for javax.swing.tree.AbstractLayoutCache.rootVisible definition code for javax.swing.tree.AbstractLayoutCache.rootVisible
          True if the root node is displayed, false if its children are the highest visible nodes.
protected  int rowHeight sample code for javax.swing.tree.AbstractLayoutCache.rowHeight definition code for javax.swing.tree.AbstractLayoutCache.rowHeight
          Height to use for each row.
protected  TreeModel sample code for javax.swing.tree.TreeModel definition code for javax.swing.tree.TreeModel treeModel sample code for javax.swing.tree.AbstractLayoutCache.treeModel definition code for javax.swing.tree.AbstractLayoutCache.treeModel
          Model providing information.
protected  TreeSelectionModel sample code for javax.swing.tree.TreeSelectionModel definition code for javax.swing.tree.TreeSelectionModel treeSelectionModel sample code for javax.swing.tree.AbstractLayoutCache.treeSelectionModel definition code for javax.swing.tree.AbstractLayoutCache.treeSelectionModel
          Selection model.
 
Constructor Summary
AbstractLayoutCache sample code for javax.swing.tree.AbstractLayoutCache.AbstractLayoutCache() definition code for javax.swing.tree.AbstractLayoutCache.AbstractLayoutCache() ()
           
 
Method Summary
abstract  Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle getBounds sample code for javax.swing.tree.AbstractLayoutCache.getBounds(javax.swing.tree.TreePath, java.awt.Rectangle) definition code for javax.swing.tree.AbstractLayoutCache.getBounds(javax.swing.tree.TreePath, java.awt.Rectangle) (TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path, Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  placeIn)
          Returns a rectangle giving the bounds needed to draw path.
abstract  boolean getExpandedState sample code for javax.swing.tree.AbstractLayoutCache.getExpandedState(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.getExpandedState(javax.swing.tree.TreePath) (TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
          Returns true if the path is expanded, and visible.
 TreeModel sample code for javax.swing.tree.TreeModel definition code for javax.swing.tree.TreeModel getModel sample code for javax.swing.tree.AbstractLayoutCache.getModel() definition code for javax.swing.tree.AbstractLayoutCache.getModel() ()
          Returns the TreeModel that is providing the data.
 AbstractLayoutCache.NodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.NodeDimensions definition code for javax.swing.tree.AbstractLayoutCache.NodeDimensions getNodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.getNodeDimensions() definition code for javax.swing.tree.AbstractLayoutCache.getNodeDimensions() ()
          Returns the object that renders nodes in the tree, and which is responsible for calculating the dimensions of individual nodes.
protected  Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle getNodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.getNodeDimensions(java.lang.Object, int, int, boolean, java.awt.Rectangle) definition code for javax.swing.tree.AbstractLayoutCache.getNodeDimensions(java.lang.Object, int, int, boolean, java.awt.Rectangle) (Object sample code for java.lang.Object definition code for java.lang.Object  value, int row, int depth, boolean expanded, Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  placeIn)
          Returns, by reference in placeIn, the size needed to represent value.
abstract  TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath getPathClosestTo sample code for javax.swing.tree.AbstractLayoutCache.getPathClosestTo(int, int) definition code for javax.swing.tree.AbstractLayoutCache.getPathClosestTo(int, int) (int x, int y)
          Returns the path to the node that is closest to x,y.
abstract  TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath getPathForRow sample code for javax.swing.tree.AbstractLayoutCache.getPathForRow(int) definition code for javax.swing.tree.AbstractLayoutCache.getPathForRow(int) (int row)
          Returns the path for passed in row.
 int getPreferredHeight sample code for javax.swing.tree.AbstractLayoutCache.getPreferredHeight() definition code for javax.swing.tree.AbstractLayoutCache.getPreferredHeight() ()
          Returns the preferred height.
 int getPreferredWidth sample code for javax.swing.tree.AbstractLayoutCache.getPreferredWidth(java.awt.Rectangle) definition code for javax.swing.tree.AbstractLayoutCache.getPreferredWidth(java.awt.Rectangle) (Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  bounds)
          Returns the preferred width for the passed in region.
abstract  int getRowCount sample code for javax.swing.tree.AbstractLayoutCache.getRowCount() definition code for javax.swing.tree.AbstractLayoutCache.getRowCount() ()
          Number of rows being displayed.
abstract  int getRowForPath sample code for javax.swing.tree.AbstractLayoutCache.getRowForPath(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.getRowForPath(javax.swing.tree.TreePath) (TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
          Returns the row that the last item identified in path is visible at.
 int getRowHeight sample code for javax.swing.tree.AbstractLayoutCache.getRowHeight() definition code for javax.swing.tree.AbstractLayoutCache.getRowHeight() ()
          Returns the height of each row.
 int[] getRowsForPaths sample code for javax.swing.tree.AbstractLayoutCache.getRowsForPaths(javax.swing.tree.TreePath[]) definition code for javax.swing.tree.AbstractLayoutCache.getRowsForPaths(javax.swing.tree.TreePath[]) (TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath [] paths)
          Returns the rows that the TreePath instances in path are being displayed at.
 TreeSelectionModel sample code for javax.swing.tree.TreeSelectionModel definition code for javax.swing.tree.TreeSelectionModel getSelectionModel sample code for javax.swing.tree.AbstractLayoutCache.getSelectionModel() definition code for javax.swing.tree.AbstractLayoutCache.getSelectionModel() ()
          Returns the model used to maintain the selection.
abstract  int getVisibleChildCount sample code for javax.swing.tree.AbstractLayoutCache.getVisibleChildCount(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.getVisibleChildCount(javax.swing.tree.TreePath) (TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
          Returns the number of visible children for row.
abstract  Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath > getVisiblePathsFrom sample code for javax.swing.tree.AbstractLayoutCache.getVisiblePathsFrom(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.getVisiblePathsFrom(javax.swing.tree.TreePath) (TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
          Returns an Enumerator that increments over the visible paths starting at the passed in location.
abstract  void invalidatePathBounds sample code for javax.swing.tree.AbstractLayoutCache.invalidatePathBounds(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.invalidatePathBounds(javax.swing.tree.TreePath) (TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
          Instructs the LayoutCache that the bounds for path are invalid, and need to be updated.
abstract  void invalidateSizes sample code for javax.swing.tree.AbstractLayoutCache.invalidateSizes() definition code for javax.swing.tree.AbstractLayoutCache.invalidateSizes() ()
          Informs the TreeState that it needs to recalculate all the sizes it is referencing.
abstract  boolean isExpanded sample code for javax.swing.tree.AbstractLayoutCache.isExpanded(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.isExpanded(javax.swing.tree.TreePath) (TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
          Returns true if the value identified by row is currently expanded.
protected  boolean isFixedRowHeight sample code for javax.swing.tree.AbstractLayoutCache.isFixedRowHeight() definition code for javax.swing.tree.AbstractLayoutCache.isFixedRowHeight() ()
          Returns true if the height of each row is a fixed size.
 boolean isRootVisible sample code for javax.swing.tree.AbstractLayoutCache.isRootVisible() definition code for javax.swing.tree.AbstractLayoutCache.isRootVisible() ()
          Returns true if the root node of the tree is displayed.
abstract  void setExpandedState sample code for javax.swing.tree.AbstractLayoutCache.setExpandedState(javax.swing.tree.TreePath, boolean) definition code for javax.swing.tree.AbstractLayoutCache.setExpandedState(javax.swing.tree.TreePath, boolean) (TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path, boolean isExpanded)
          Marks the path path expanded state to isExpanded.
 void setModel sample code for javax.swing.tree.AbstractLayoutCache.setModel(javax.swing.tree.TreeModel) definition code for javax.swing.tree.AbstractLayoutCache.setModel(javax.swing.tree.TreeModel) (TreeModel sample code for javax.swing.tree.TreeModel definition code for javax.swing.tree.TreeModel  newModel)
          Sets the TreeModel that will provide the data.
 void setNodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.setNodeDimensions(javax.swing.tree.AbstractLayoutCache.NodeDimensions) definition code for javax.swing.tree.AbstractLayoutCache.setNodeDimensions(javax.swing.tree.AbstractLayoutCache.NodeDimensions) (AbstractLayoutCache.NodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.NodeDimensions definition code for javax.swing.tree.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.
 void setRootVisible sample code for javax.swing.tree.AbstractLayoutCache.setRootVisible(boolean) definition code for javax.swing.tree.AbstractLayoutCache.setRootVisible(boolean) (boolean rootVisible)
          Determines whether or not the root node from the TreeModel is visible.
 void setRowHeight sample code for javax.swing.tree.AbstractLayoutCache.setRowHeight(int) definition code for javax.swing.tree.AbstractLayoutCache.setRowHeight(int) (int rowHeight)
          Sets the height of each cell.
 void setSelectionModel sample code for javax.swing.tree.AbstractLayoutCache.setSelectionModel(javax.swing.tree.TreeSelectionModel) definition code for javax.swing.tree.AbstractLayoutCache.setSelectionModel(javax.swing.tree.TreeSelectionModel) (TreeSelectionModel sample code for javax.swing.tree.TreeSelectionModel definition code for javax.swing.tree.TreeSelectionModel  newLSM)
          Sets the TreeSelectionModel used to manage the selection to new LSM.
abstract  void treeNodesChanged sample code for javax.swing.tree.AbstractLayoutCache.treeNodesChanged(javax.swing.event.TreeModelEvent) definition code for javax.swing.tree.AbstractLayoutCache.treeNodesChanged(javax.swing.event.TreeModelEvent) (TreeModelEvent sample code for javax.swing.event.TreeModelEvent definition code for javax.swing.event.TreeModelEvent  e)
           Invoked after a node (or a set of siblings) has changed in some way.
abstract  void treeNodesInserted sample code for javax.swing.tree.AbstractLayoutCache.treeNodesInserted(javax.swing.event.TreeModelEvent) definition code for javax.swing.tree.AbstractLayoutCache.treeNodesInserted(javax.swing.event.TreeModelEvent) (TreeModelEvent sample code for javax.swing.event.TreeModelEvent definition code for javax.swing.event.TreeModelEvent  e)
          Invoked after nodes have been inserted into the tree.
abstract  void treeNodesRemoved sample code for javax.swing.tree.AbstractLayoutCache.treeNodesRemoved(javax.swing.event.TreeModelEvent) definition code for javax.swing.tree.AbstractLayoutCache.treeNodesRemoved(javax.swing.event.TreeModelEvent) (TreeModelEvent sample code for javax.swing.event.TreeModelEvent definition code for javax.swing.event.TreeModelEvent  e)
          Invoked after nodes have been removed from the tree.
abstract  void treeStructureChanged sample code for javax.swing.tree.AbstractLayoutCache.treeStructureChanged(javax.swing.event.TreeModelEvent) definition code for javax.swing.tree.AbstractLayoutCache.treeStructureChanged(javax.swing.event.TreeModelEvent) (TreeModelEvent sample code for javax.swing.event.TreeModelEvent definition code for javax.swing.event.TreeModelEvent  e)
          Invoked after the tree has drastically changed structure from a given node down.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

nodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.nodeDimensions

protected AbstractLayoutCache.NodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.NodeDimensions definition code for javax.swing.tree.AbstractLayoutCache.NodeDimensions  nodeDimensions
Object responsible for getting the size of a node.


treeModel sample code for javax.swing.tree.AbstractLayoutCache.treeModel

protected TreeModel sample code for javax.swing.tree.TreeModel definition code for javax.swing.tree.TreeModel  treeModel
Model providing information.


treeSelectionModel sample code for javax.swing.tree.AbstractLayoutCache.treeSelectionModel

protected TreeSelectionModel sample code for javax.swing.tree.TreeSelectionModel definition code for javax.swing.tree.TreeSelectionModel  treeSelectionModel
Selection model.


rootVisible sample code for javax.swing.tree.AbstractLayoutCache.rootVisible

protected boolean rootVisible
True if the root node is displayed, false if its children are the highest visible nodes.


rowHeight sample code for javax.swing.tree.AbstractLayoutCache.rowHeight

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.

Constructor Detail

AbstractLayoutCache sample code for javax.swing.tree.AbstractLayoutCache() definition code for javax.swing.tree.AbstractLayoutCache()

public AbstractLayoutCache()
Method Detail

setNodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.setNodeDimensions(javax.swing.tree.AbstractLayoutCache.NodeDimensions) definition code for javax.swing.tree.AbstractLayoutCache.setNodeDimensions(javax.swing.tree.AbstractLayoutCache.NodeDimensions)

public void setNodeDimensions(AbstractLayoutCache.NodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.NodeDimensions definition code for javax.swing.tree.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.

Parameters:
nd - a NodeDimensions object

getNodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.getNodeDimensions() definition code for javax.swing.tree.AbstractLayoutCache.getNodeDimensions()

public AbstractLayoutCache.NodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.NodeDimensions definition code for javax.swing.tree.AbstractLayoutCache.NodeDimensions  getNodeDimensions()
Returns the object that renders nodes in the tree, and which is responsible for calculating the dimensions of individual nodes.

Returns:
the NodeDimensions object

setModel sample code for javax.swing.tree.AbstractLayoutCache.setModel(javax.swing.tree.TreeModel) definition code for javax.swing.tree.AbstractLayoutCache.setModel(javax.swing.tree.TreeModel)

public void setModel(TreeModel sample code for javax.swing.tree.TreeModel definition code for javax.swing.tree.TreeModel  newModel)
Sets the TreeModel that will provide the data.

Parameters:
newModel - the TreeModel that is to provide the data

getModel sample code for javax.swing.tree.AbstractLayoutCache.getModel() definition code for javax.swing.tree.AbstractLayoutCache.getModel()

public TreeModel sample code for javax.swing.tree.TreeModel definition code for javax.swing.tree.TreeModel  getModel()
Returns the TreeModel that is providing the data.

Returns:
the TreeModel that is providing the data

setRootVisible sample code for javax.swing.tree.AbstractLayoutCache.setRootVisible(boolean) definition code for javax.swing.tree.AbstractLayoutCache.setRootVisible(boolean)

public void setRootVisible(boolean rootVisible)
Determines whether or not the root node from the TreeModel is visible.

Parameters:
rootVisible - true if the root node of the tree is to be displayed
See Also:
rootVisible sample code for javax.swing.tree.AbstractLayoutCache.rootVisible definition code for javax.swing.tree.AbstractLayoutCache.rootVisible

isRootVisible sample code for javax.swing.tree.AbstractLayoutCache.isRootVisible() definition code for javax.swing.tree.AbstractLayoutCache.isRootVisible()

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

Returns:
true if the root node of the tree is displayed
See Also:
rootVisible sample code for javax.swing.tree.AbstractLayoutCache.rootVisible definition code for javax.swing.tree.AbstractLayoutCache.rootVisible

setRowHeight sample code for javax.swing.tree.AbstractLayoutCache.setRowHeight(int) definition code for javax.swing.tree.AbstractLayoutCache.setRowHeight(int)

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.

Parameters:
rowHeight - the height of each cell, in pixels

getRowHeight sample code for javax.swing.tree.AbstractLayoutCache.getRowHeight() definition code for javax.swing.tree.AbstractLayoutCache.getRowHeight()

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.


setSelectionModel sample code for javax.swing.tree.AbstractLayoutCache.setSelectionModel(javax.swing.tree.TreeSelectionModel) definition code for javax.swing.tree.AbstractLayoutCache.setSelectionModel(javax.swing.tree.TreeSelectionModel)

public void setSelectionModel(TreeSelectionModel sample code for javax.swing.tree.TreeSelectionModel definition code for javax.swing.tree.TreeSelectionModel  newLSM)
Sets the TreeSelectionModel used to manage the selection to new LSM.

Parameters:
newLSM - the new TreeSelectionModel

getSelectionModel sample code for javax.swing.tree.AbstractLayoutCache.getSelectionModel() definition code for javax.swing.tree.AbstractLayoutCache.getSelectionModel()

public TreeSelectionModel sample code for javax.swing.tree.TreeSelectionModel definition code for javax.swing.tree.TreeSelectionModel  getSelectionModel()
Returns the model used to maintain the selection.

Returns:
the treeSelectionModel

getPreferredHeight sample code for javax.swing.tree.AbstractLayoutCache.getPreferredHeight() definition code for javax.swing.tree.AbstractLayoutCache.getPreferredHeight()

public int getPreferredHeight()
Returns the preferred height.

Returns:
the preferred height

getPreferredWidth sample code for javax.swing.tree.AbstractLayoutCache.getPreferredWidth(java.awt.Rectangle) definition code for javax.swing.tree.AbstractLayoutCache.getPreferredWidth(java.awt.Rectangle)

public int getPreferredWidth(Rectangle sample code for java.awt.Rectangle definition code for java.awt.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).

Parameters:
bounds - the region being queried
Returns:
the preferred width for the passed in region

isExpanded sample code for javax.swing.tree.AbstractLayoutCache.isExpanded(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.isExpanded(javax.swing.tree.TreePath)

public abstract boolean isExpanded(TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
Returns true if the value identified by row is currently expanded.


getBounds sample code for javax.swing.tree.AbstractLayoutCache.getBounds(javax.swing.tree.TreePath, java.awt.Rectangle) definition code for javax.swing.tree.AbstractLayoutCache.getBounds(javax.swing.tree.TreePath, java.awt.Rectangle)

public abstract Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  getBounds(TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path,
                                    Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  placeIn)
Returns a rectangle giving the bounds needed to draw path.

Parameters:
path - a TreePath specifying a node
placeIn - a Rectangle object giving the available space
Returns:
a Rectangle object specifying the space to be used

getPathForRow sample code for javax.swing.tree.AbstractLayoutCache.getPathForRow(int) definition code for javax.swing.tree.AbstractLayoutCache.getPathForRow(int)

public abstract TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  getPathForRow(int row)
Returns the path for passed in row. If row is not visible null is returned.

Parameters:
row - the row being queried
Returns:
the TreePath for the given row

getRowForPath sample code for javax.swing.tree.AbstractLayoutCache.getRowForPath(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.getRowForPath(javax.swing.tree.TreePath)

public abstract int getRowForPath(TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.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.

Parameters:
path - the TreePath being queried
Returns:
the row where the last item in path is visible or -1 if any elements in path aren't currently visible

getPathClosestTo sample code for javax.swing.tree.AbstractLayoutCache.getPathClosestTo(int, int) definition code for javax.swing.tree.AbstractLayoutCache.getPathClosestTo(int, int)

public abstract TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.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.

Parameters:
x - the horizontal component of the desired location
y - the vertical component of the desired location
Returns:
the TreePath closest to the specified point

getVisiblePathsFrom sample code for javax.swing.tree.AbstractLayoutCache.getVisiblePathsFrom(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.getVisiblePathsFrom(javax.swing.tree.TreePath)

public abstract Enumeration sample code for java.util.Enumeration definition code for java.util.Enumeration <TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath > getVisiblePathsFrom(TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.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.

Parameters:
path - the starting location for the enumeration
Returns:
the Enumerator starting at the desired location

getVisibleChildCount sample code for javax.swing.tree.AbstractLayoutCache.getVisibleChildCount(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.getVisibleChildCount(javax.swing.tree.TreePath)

public abstract int getVisibleChildCount(TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
Returns the number of visible children for row.

Parameters:
path - the path being queried
Returns:
the number of visible children for the specified path

setExpandedState sample code for javax.swing.tree.AbstractLayoutCache.setExpandedState(javax.swing.tree.TreePath, boolean) definition code for javax.swing.tree.AbstractLayoutCache.setExpandedState(javax.swing.tree.TreePath, boolean)

public abstract void setExpandedState(TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path,
                                      boolean isExpanded)
Marks the path path expanded state to isExpanded.

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

getExpandedState sample code for javax.swing.tree.AbstractLayoutCache.getExpandedState(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.getExpandedState(javax.swing.tree.TreePath)

public abstract boolean getExpandedState(TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
Returns true if the path is expanded, and visible.

Parameters:
path - the path being queried
Returns:
true if the path is expanded and visible, false otherwise

getRowCount sample code for javax.swing.tree.AbstractLayoutCache.getRowCount() definition code for javax.swing.tree.AbstractLayoutCache.getRowCount()

public abstract int getRowCount()
Number of rows being displayed.

Returns:
the number of rows being displayed

invalidateSizes sample code for javax.swing.tree.AbstractLayoutCache.invalidateSizes() definition code for javax.swing.tree.AbstractLayoutCache.invalidateSizes()

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


invalidatePathBounds sample code for javax.swing.tree.AbstractLayoutCache.invalidatePathBounds(javax.swing.tree.TreePath) definition code for javax.swing.tree.AbstractLayoutCache.invalidatePathBounds(javax.swing.tree.TreePath)

public abstract void invalidatePathBounds(TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.TreePath  path)
Instructs the LayoutCache that the bounds for path are invalid, and need to be updated.

Parameters:
path - the path being updated

treeNodesChanged sample code for javax.swing.tree.AbstractLayoutCache.treeNodesChanged(javax.swing.event.TreeModelEvent) definition code for javax.swing.tree.AbstractLayoutCache.treeNodesChanged(javax.swing.event.TreeModelEvent)

public abstract void treeNodesChanged(TreeModelEvent sample code for javax.swing.event.TreeModelEvent definition code for javax.swing.event.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).

Parameters:
e - the TreeModelEvent

treeNodesInserted sample code for javax.swing.tree.AbstractLayoutCache.treeNodesInserted(javax.swing.event.TreeModelEvent) definition code for javax.swing.tree.AbstractLayoutCache.treeNodesInserted(javax.swing.event.TreeModelEvent)

public abstract void treeNodesInserted(TreeModelEvent sample code for javax.swing.event.TreeModelEvent definition code for javax.swing.event.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.

Parameters:
e - the TreeModelEvent

treeNodesRemoved sample code for javax.swing.tree.AbstractLayoutCache.treeNodesRemoved(javax.swing.event.TreeModelEvent) definition code for javax.swing.tree.AbstractLayoutCache.treeNodesRemoved(javax.swing.event.TreeModelEvent)

public abstract void treeNodesRemoved(TreeModelEvent sample code for javax.swing.event.TreeModelEvent definition code for javax.swing.event.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.

Parameters:
e - the TreeModelEvent

treeStructureChanged sample code for javax.swing.tree.AbstractLayoutCache.treeStructureChanged(javax.swing.event.TreeModelEvent) definition code for javax.swing.tree.AbstractLayoutCache.treeStructureChanged(javax.swing.event.TreeModelEvent)

public abstract void treeStructureChanged(TreeModelEvent sample code for javax.swing.event.TreeModelEvent definition code for javax.swing.event.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.

Parameters:
e - the TreeModelEvent

getRowsForPaths sample code for javax.swing.tree.AbstractLayoutCache.getRowsForPaths(javax.swing.tree.TreePath[]) definition code for javax.swing.tree.AbstractLayoutCache.getRowsForPaths(javax.swing.tree.TreePath[])

public int[] getRowsForPaths(TreePath sample code for javax.swing.tree.TreePath definition code for javax.swing.tree.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.

Specified by:
getRowsForPaths sample code for javax.swing.tree.RowMapper.getRowsForPaths(javax.swing.tree.TreePath[]) definition code for javax.swing.tree.RowMapper.getRowsForPaths(javax.swing.tree.TreePath[]) in interface RowMapper sample code for javax.swing.tree.RowMapper definition code for javax.swing.tree.RowMapper
Parameters:
paths - the array of TreePaths being queried
Returns:
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

getNodeDimensions sample code for javax.swing.tree.AbstractLayoutCache.getNodeDimensions(java.lang.Object, int, int, boolean, java.awt.Rectangle) definition code for javax.swing.tree.AbstractLayoutCache.getNodeDimensions(java.lang.Object, int, int, boolean, java.awt.Rectangle)

protected Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  getNodeDimensions(Object sample code for java.lang.Object definition code for java.lang.Object  value,
                                      int row,
                                      int depth,
                                      boolean expanded,
                                      Rectangle sample code for java.awt.Rectangle definition code for java.awt.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.

Parameters:
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
Returns:
a Rectangle containing the node dimensions, or null if node has no dimension

isFixedRowHeight sample code for javax.swing.tree.AbstractLayoutCache.isFixedRowHeight() definition code for javax.swing.tree.AbstractLayoutCache.isFixedRowHeight()

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