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. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.
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. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.
(->variable-height-layout-cache)
Constructor.
Constructor.
(expanded? this path)
Returns true if the value identified by path is currently expanded.
path - javax.swing.tree.TreePath
returns: true if the value identified by path is
currently expanded - boolean
Returns true if the value identified by path is currently expanded. path - `javax.swing.tree.TreePath` returns: true if the value identified by path is currently expanded - `boolean`
(get-bounds this path place-in)
Returns the Rectangle enclosing the label portion into which the item identified by path will be drawn.
path - the path to be drawn - javax.swing.tree.TreePath
place-in - the bounds of the enclosing rectangle - java.awt.Rectangle
returns: the bounds of the enclosing rectangle or null
if the node could not be ascertained - java.awt.Rectangle
Returns the Rectangle enclosing the label portion into which the item identified by path will be drawn. path - the path to be drawn - `javax.swing.tree.TreePath` place-in - the bounds of the enclosing rectangle - `java.awt.Rectangle` returns: the bounds of the enclosing rectangle or null if the node could not be ascertained - `java.awt.Rectangle`
(get-expanded-state? this path)
Returns true if the path is expanded, and visible.
path - the path being queried - javax.swing.tree.TreePath
returns: true if the path is expanded and visible, otherwise false - boolean
Returns true if the path is expanded, and visible. path - the path being queried - `javax.swing.tree.TreePath` returns: true if the path is expanded and visible, otherwise false - `boolean`
(get-path-closest-to this x 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 will 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 x-coordinate - int
y - the y-coordinate - int
returns: the path to the node that is closest to x, y - javax.swing.tree.TreePath
Returns the path to the node that is closest to x,y. If there is nothing currently visible this will return null, otherwise it will 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 x-coordinate - `int` y - the y-coordinate - `int` returns: the path to the node that is closest to x, y - `javax.swing.tree.TreePath`
(get-path-for-row this row)
Returns the path for row. If row is not visible, null is returned.
row - the location of interest - int
returns: the path for row, or null
if row is not visible - javax.swing.tree.TreePath
Returns the path for row. If row is not visible, null is returned. row - the location of interest - `int` returns: the path for row, or null if row is not visible - `javax.swing.tree.TreePath`
(get-preferred-height this)
Returns the preferred height.
returns: the preferred height - int
Returns the preferred height. returns: the preferred height - `int`
(get-preferred-width this bounds)
Returns the preferred width and height for the region in visibleRegion.
bounds - the region being queried - java.awt.Rectangle
returns: the preferred width for the passed in region - int
Returns the preferred width and height for the region in visibleRegion. bounds - the region being queried - `java.awt.Rectangle` returns: the preferred width for the passed in region - `int`
(get-row-count this)
Returns the number of visible rows.
returns: the number of visible rows - int
Returns the number of visible rows. returns: the number of visible rows - `int`
(get-row-for-path this path)
Returns the row where the last item identified in path is visible. Will return -1 if any of the elements in path are not currently visible.
path - the TreePath of interest - javax.swing.tree.TreePath
returns: the row where the last item in path is visible - int
Returns the row where the last item identified in path is visible. Will return -1 if any of the elements in path are not currently visible. path - the TreePath of interest - `javax.swing.tree.TreePath` returns: the row where the last item in path is visible - `int`
(get-visible-child-count this path)
Returns the number of visible children for path.
path - the path being queried - javax.swing.tree.TreePath
returns: the number of visible children for path - int
Returns the number of visible children for path. path - the path being queried - `javax.swing.tree.TreePath` returns: the number of visible children for path - `int`
(get-visible-paths-from this 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.
path - the location in the TreePath to start - javax.swing.tree.TreePath
returns: an Enumerator that increments over the visible
paths - java.util.Enumeration<javax.swing.tree.TreePath>
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. path - the location in the TreePath to start - `javax.swing.tree.TreePath` returns: an Enumerator that increments over the visible paths - `java.util.Enumeration<javax.swing.tree.TreePath>`
(invalidate-path-bounds this path)
Instructs the LayoutCache that the bounds for path are invalid, and need to be updated.
path - the TreePath which is now invalid - javax.swing.tree.TreePath
Instructs the LayoutCache that the bounds for path are invalid, and need to be updated. path - the TreePath which is now invalid - `javax.swing.tree.TreePath`
(invalidate-sizes this)
Informs the TreeState that it needs to recalculate all the sizes it is referencing.
Informs the TreeState that it needs to recalculate all the sizes it is referencing.
(set-expanded-state this path is-expanded)
Marks the path path expanded state to isExpanded.
path - the TreePath of interest - javax.swing.tree.TreePath
is-expanded - true if the path should be expanded, otherwise false - boolean
Marks the path path expanded state to isExpanded. path - the TreePath of interest - `javax.swing.tree.TreePath` is-expanded - true if the path should be expanded, otherwise false - `boolean`
(set-model this new-model)
Sets the TreeModel that will provide the data.
new-model - the TreeModel that is to provide the data - javax.swing.tree.TreeModel
Sets the TreeModel that will provide the data. new-model - the TreeModel that is to provide the data - `javax.swing.tree.TreeModel`
(set-node-dimensions this nd)
Sets the renderer that is responsible for drawing nodes in the tree.
nd - the renderer - javax.swing.tree.AbstractLayoutCache$NodeDimensions
Sets the renderer that is responsible for drawing nodes in the tree. nd - the renderer - `javax.swing.tree.AbstractLayoutCache$NodeDimensions`
(set-root-visible this root-visible)
Determines whether or not the root node from the TreeModel is visible.
root-visible - true if the root node of the tree is to be displayed - boolean
Determines whether or not the root node from the TreeModel is visible. root-visible - true if the root node of the tree is to be displayed - `boolean`
(set-row-height this row-height)
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.
row-height - the height of each cell, in pixels - int
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. row-height - the height of each cell, in pixels - `int`
(tree-nodes-changed this 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 of interest - javax.swing.event.TreeModelEvent
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 of interest - `javax.swing.event.TreeModelEvent`
(tree-nodes-inserted this 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 of interest - javax.swing.event.TreeModelEvent
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 of interest - `javax.swing.event.TreeModelEvent`
(tree-nodes-removed this 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 of interest - javax.swing.event.TreeModelEvent
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 of interest - `javax.swing.event.TreeModelEvent`
(tree-structure-changed this 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 of interest - javax.swing.event.TreeModelEvent
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 of interest - `javax.swing.event.TreeModelEvent`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close