Class TreeUI
- java.lang.Object
-
- javax.swing.plaf.ComponentUI
-
- javax.swing.plaf.TreeUI
- Direct Known Subclasses:
- BasicTreeUI, MultiTreeUI
public abstract class TreeUI extends ComponentUI
Pluggable look and feel interface for JTree.
Constructors
Constructor and Description |
---|
TreeUI() |
Methods
Modifier and Type | Method and Description |
---|---|
abstract void |
cancelEditing(JTree tree) Cancels the current editing session. |
abstract TreePath |
getClosestPathForLocation(JTree tree,
int x,
int y) Returns the path to the node that is closest to x,y. |
abstract TreePath |
getEditingPath(JTree tree) Returns the path to the element that is being edited. |
abstract Rectangle |
getPathBounds(JTree tree,
TreePath path) Returns the Rectangle enclosing the label portion that the last item in path will be drawn into. |
abstract TreePath |
getPathForRow(JTree tree,
int row) Returns the path for passed in row. |
abstract int |
getRowCount(JTree tree) Returns the number of rows that are being displayed. |
abstract int |
getRowForPath(JTree tree,
TreePath path) Returns the row that the last item identified in path is visible at. |
abstract boolean |
isEditing(JTree tree) Returns true if the tree is being edited. |
abstract void |
startEditingAtPath(JTree tree,
TreePath path) Selects the last item in path and tries to edit it. |
abstract boolean |
stopEditing(JTree tree) Stops the current editing session. |
Methods inherited from class javax.swing.plaf.ComponentUI
contains, createUI, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, getPreferredSize, installUI, paint, uninstallUI, update
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Constructors
TreeUI
public TreeUI()
Methods
getPathBounds
public abstract Rectangle getPathBounds(JTree tree, TreePath path)
Returns the Rectangle enclosing the label portion that the last item in path will be drawn into. Will return null if any component in path is currently valid.
getPathForRow
public abstract TreePath getPathForRow(JTree tree, int row)
Returns the path for passed in row. If row is not visible null is returned.
getRowForPath
public abstract int getRowForPath(JTree 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.
getRowCount
public abstract int getRowCount(JTree tree)
Returns the number of rows that are being displayed.
getClosestPathForLocation
public abstract TreePath getClosestPathForLocation(JTree tree, 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.
isEditing
public abstract boolean isEditing(JTree tree)
Returns true if the tree is being edited. The item that is being edited can be returned by getEditingPath().
stopEditing
public abstract boolean stopEditing(JTree tree)
Stops the current editing session. This has no effect if the tree isn't being edited. Returns true if the editor allows the editing session to stop.
cancelEditing
public abstract void cancelEditing(JTree tree)
Cancels the current editing session. This has no effect if the tree isn't being edited. Returns true if the editor allows the editing session to stop.
startEditingAtPath
public abstract void startEditingAtPath(JTree tree, TreePath path)
Selects the last item in path and tries to edit it. Editing will fail if the CellEditor won't allow it for the selected item.
getEditingPath
public abstract TreePath getEditingPath(JTree tree)
Returns the path to the element that is being edited.
© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/javase/8/docs/api/javax/swing/plaf/TreeUI.html