Home » openjdk-7 » javax » swing » tree » [javadoc | source]
javax.swing.tree
abstract public class: AbstractLayoutCache [javadoc | source]
java.lang.Object
   javax.swing.tree.AbstractLayoutCache

All Implemented Interfaces:
    RowMapper

Direct Known Subclasses:
    VariableHeightLayoutCache, FixedHeightLayoutCache

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 java.beans.XMLEncoder .
Nested Class Summary:
abstract public static class  AbstractLayoutCache.NodeDimensions  Used by AbstractLayoutCache to determine the size and x origin of a particular node. 
Field Summary
protected  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. 
Method from javax.swing.tree.AbstractLayoutCache Summary:
getBounds,   getExpandedState,   getModel,   getNodeDimensions,   getNodeDimensions,   getPathClosestTo,   getPathForRow,   getPreferredHeight,   getPreferredWidth,   getRowCount,   getRowForPath,   getRowHeight,   getRowsForPaths,   getSelectionModel,   getVisibleChildCount,   getVisiblePathsFrom,   invalidatePathBounds,   invalidateSizes,   isExpanded,   isFixedRowHeight,   isRootVisible,   setExpandedState,   setModel,   setNodeDimensions,   setRootVisible,   setRowHeight,   setSelectionModel,   treeNodesChanged,   treeNodesInserted,   treeNodesRemoved,   treeStructureChanged
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.tree.AbstractLayoutCache Detail:
 abstract public Rectangle getBounds(TreePath path,
    Rectangle placeIn)
    Returns a rectangle giving the bounds needed to draw path.
 abstract public boolean getExpandedState(TreePath path)
    Returns true if the path is expanded, and visible.
 public TreeModel getModel() 
    Returns the TreeModel that is providing the data.
 public NodeDimensions getNodeDimensions() 
    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. 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.
 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.
 abstract public TreePath getPathForRow(int row)
    Returns the path for passed in row. If row is not visible null is returned.
 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).
 abstract public int getRowCount()
    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.
 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.
 public TreeSelectionModel getSelectionModel() 
    Returns the model used to maintain the selection.
 abstract public int getVisibleChildCount(TreePath path)
    Returns the number of visible children for row.
 abstract public 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.
 abstract public  void invalidatePathBounds(TreePath path)
    Instructs the LayoutCache that the bounds for path are invalid, and need to be updated.
 abstract public  void invalidateSizes()
    Informs the TreeState that it needs to recalculate all the sizes it is referencing.
 abstract public boolean isExpanded(TreePath path)
    Returns true if the value identified by row is currently expanded.
 protected boolean isFixedRowHeight() 
    Returns true if the height of each row is a fixed size.
 public boolean isRootVisible() 
    Returns true if the root node of the tree is displayed.
 abstract public  void setExpandedState(TreePath path,
    boolean isExpanded)
    Marks the path path expanded state to isExpanded.
 public  void setModel(TreeModel newModel) 
    Sets the TreeModel that will provide the data.
 public  void setNodeDimensions(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.
 public  void setRootVisible(boolean rootVisible) 
    Determines whether or not the root node from the TreeModel 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.
 public  void setSelectionModel(TreeSelectionModel newLSM) 
    Sets the TreeSelectionModel used to manage the selection to new LSM.
 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).

 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.

 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.

 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.