Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.3.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.swing.tree
Class VariableHeightLayoutCache

    java.lang.Object
      |
      +--javax.swing.tree.AbstractLayoutCache
            |
            +--javax.swing.tree.VariableHeightLayoutCache

All Implemented Interfaces:
  RowMapper

public class VariableHeightLayoutCache
extends AbstractLayoutCache

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. A future release of Swing will provide support for long term persistence.

Inner classes inherited from class javax.swing.tree.AbstractLayoutCache
`AbstractLayoutCache.NodeDimensions`

Fields inherited from class javax.swing.tree.AbstractLayoutCache
`nodeDimensions, rootVisible, rowHeight, treeModel, treeSelectionModel`

Constructor Summary
`VariableHeightLayoutCache()`

Method Summary
`Rectangle` | `getBounds(TreePath path, Rectangle placeIn)` Returns the Rectangle enclosing the label portion that the item identified by row will be drawn into.
`boolean` | `getExpandedState(TreePath path)` Returns true if the path is expanded, and visible.
`TreePath` | `getPathClosestTo(int x, int y)` Returns the path to the node that is closest to x,y.
`TreePath` | `getPathForRow(int row)` Returns the path for passed in row.
`int` | `getPreferredHeight()` Returns the preferred height.
`int` | `getPreferredWidth(Rectangle bounds)` Returns the preferred width and height for the region in `visibleRegion`.
`int` | `getRowCount()` Returns the number of visible rows.
`int` | `getRowForPath(TreePath path)` Returns the row that the last item identified in path is visible at.
`int` | `getVisibleChildCount(TreePath path)` Returns the number of visible children for row.
`Enumeration` | `getVisiblePathsFrom(TreePath path)` Returns an Enumerator that increments over the visible paths starting at the passed in location.
`void` | `invalidatePathBounds(TreePath path)` Instructs the LayoutCache that the bounds for `path` are invalid, and need to be updated.
`void` | `invalidateSizes()` Informs the TreeState that it needs to recalculate all the sizes it is referencing.
`boolean` | `isExpanded(TreePath path)` Returns true if the value identified by row is currently expanded.
`void` | `setExpandedState(TreePath path, boolean isExpanded)` Marks the path `path` expanded state to `isExpanded`.
`void` | `setModel(TreeModel newModel)` Sets the TreeModel that will provide the data.
`void` | `setNodeDimensions(AbstractLayoutCache.NodeDimensions nd)` Sets the renderer that is responsible for drawing nodes in the tree.
`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` | `treeNodesChanged(TreeModelEvent e)` Invoked after a node (or a set of siblings) has changed in some way.
`void` | `treeNodesInserted(TreeModelEvent e)` Invoked after nodes have been inserted into the tree.
`void` | `treeNodesRemoved(TreeModelEvent e)` Invoked after nodes have been removed from the tree.
`void` | `treeStructureChanged(TreeModelEvent e)` Invoked after the tree has drastically changed structure from a given node down.

Methods inherited from class javax.swing.tree.AbstractLayoutCache
`getModel, getNodeDimensions, getNodeDimensions, getRowHeight, getRowsForPaths, getSelectionModel, isFixedRowHeight, isRootVisible, setSelectionModel`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### VariableHeightLayoutCache

    public VariableHeightLayoutCache()

Method Detail

### setModel

    public void setModel(TreeModel newModel)

  Sets the TreeModel that will provide the data.
  Overrides:
    `setModel` in class `AbstractLayoutCache`
  Parameters:
    `newModel` - the TreeModel that is to provide the data

### setRootVisible

    public void setRootVisible(boolean rootVisible)

  Determines whether or not the root node from the TreeModel is visible.
  Overrides:
    `setRootVisible` in class `AbstractLayoutCache`
  Parameters:
    `rootVisible` - true if the root node of the tree is to be displayed
  See Also:
    `AbstractLayoutCache.rootVisible`

### setRowHeight

    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.
  Overrides:
    `setRowHeight` in class `AbstractLayoutCache`
  Parameters:
    `rowHeight` - the height of each cell, in pixels

### setNodeDimensions

    public void setNodeDimensions(AbstractLayoutCache.NodeDimensions nd)

  Sets the renderer that is responsible for drawing nodes in the tree.
  Overrides:
    `setNodeDimensions` in class `AbstractLayoutCache`
  Following copied from class: `javax.swing.tree.AbstractLayoutCache`
  Parameters:
    `nd` - a NodeDimensions object

### setExpandedState

    public void setExpandedState(TreePath path,
                                 boolean isExpanded)

  Marks the path `path` expanded state to `isExpanded`.
  Overrides:
    `setExpandedState` in class `AbstractLayoutCache`

### getExpandedState

    public boolean getExpandedState(TreePath path)

  Returns true if the path is expanded, and visible.
  Overrides:
    `getExpandedState` in class `AbstractLayoutCache`

### getBounds

    public Rectangle getBounds(TreePath path,
                               Rectangle placeIn)

  Returns the Rectangle enclosing the label portion that the item identified by row will be drawn into.
  Overrides:
    `getBounds` in class `AbstractLayoutCache`
  Following copied from class: `javax.swing.tree.AbstractLayoutCache`
  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

    public TreePath getPathForRow(int row)

  Returns the path for passed in row. If row is not visible null is returned.
  Overrides:
    `getPathForRow` in class `AbstractLayoutCache`

### getRowForPath

    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.
  Overrides:
    `getRowForPath` in class `AbstractLayoutCache`

### getRowCount

    public int getRowCount()

  Returns the number of visible rows.
  Overrides:
    `getRowCount` in class `AbstractLayoutCache`

### invalidatePathBounds

    public void invalidatePathBounds(TreePath path)

  Instructs the LayoutCache that the bounds for `path` are invalid, and need to be updated.
  Overrides:
    `invalidatePathBounds` in class `AbstractLayoutCache`

### getPreferredHeight

    public int getPreferredHeight()

  Returns the preferred height.
  Overrides:
    `getPreferredHeight` in class `AbstractLayoutCache`

### getPreferredWidth

    public int getPreferredWidth(Rectangle bounds)

  Returns the preferred width and height for the region in `visibleRegion`.
  Overrides:
    `getPreferredWidth` in class `AbstractLayoutCache`

### getPathClosestTo

    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.
  Overrides:
    `getPathClosestTo` in class `AbstractLayoutCache`

### getVisiblePathsFrom

    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.
  Overrides:
    `getVisiblePathsFrom` in class `AbstractLayoutCache`

### getVisibleChildCount

    public int getVisibleChildCount(TreePath path)

  Returns the number of visible children for row.
  Overrides:
    `getVisibleChildCount` in class `AbstractLayoutCache`

### invalidateSizes

    public void invalidateSizes()

  Informs the TreeState that it needs to recalculate all the sizes it is referencing.
  Overrides:
    `invalidateSizes` in class `AbstractLayoutCache`

### isExpanded

    public boolean isExpanded(TreePath path)

  Returns true if the value identified by row is currently expanded.
  Overrides:
    `isExpanded` in class `AbstractLayoutCache`

### treeNodesChanged

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

  Overrides:
    `treeNodesChanged` in class `AbstractLayoutCache`

### treeNodesInserted

    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.

  Overrides:
    `treeNodesInserted` in class `AbstractLayoutCache`

### treeNodesRemoved

    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.

  Overrides:
    `treeNodesRemoved` in class `AbstractLayoutCache`

### treeStructureChanged

    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.

  Overrides:
    `treeStructureChanged` in class `AbstractLayoutCache`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| JavaTM 2 Platform Std. Ed. v1.3.1
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Java, Java 2D, and JDBC are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-2001 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.