public class JTree extends JComponent implements Scrollable, Accessible
A control that displays a set of hierarchical data as an outline. You can find task-oriented documentation and examples of using trees in How to Use Trees, a section in The Java Tutorial.
A specific node in a tree can be identified either by a TreePath (an object that encapsulates a node and all of its ancestors), or by its display row, where each row in the display area displays one node. An expanded node is a non-leaf node (as identified by TreeModel.isLeaf(node) returning false) that will displays its children when all its ancestors are expanded. A collapsed node is one which hides them. A hidden node is one which is under a collapsed ancestor. All of a viewable nodes parents are expanded, but may or may not be displayed. A displayed node is both viewable and in the display area, where it can be seen.
JTree methods use "visible" to mean "displayed": isRootVisible() setRootVisible() scrollPathToVisible() scrollRowToVisible() getVisibleRowCount() setVisibleRowCount() JTree methods use "visible" to mean "viewable" (under an expanded parent): isVisible() makeVisible() TreeSelectionListener interface and add the instance using the method addTreeSelectionListener. valueChanged will be invoked when the selection changes, that is if the user clicks twice on the same node valueChanged will only be invoked once. If you are interested in detecting either double-click events or when a user clicks on a node, regardless of whether or not it was selected, we recommend you do the following:
final JTree tree = ...;
MouseListener ml = new MouseAdapter() {
public void mousePressed(MouseEvent e) {
int selRow = tree.getRowForLocation(e.getX(), e.getY());
TreePath selPath = tree.getPathForLocation(e.getX(), e.getY());
if(selRow != -1) {
if(e.getClickCount() == 1) {
mySingleClick(selRow, selPath);
}
else if(e.getClickCount() == 2) {
myDoubleClick(selRow, selPath);
}
}
}
};
tree.addMouseListener(ml); NOTE: This example obtains both the path and row, but you only need to get the one you're interested in. To use JTree to display compound nodes (for example, nodes containing both a graphic icon and text), subclass TreeCellRenderer and use setCellRenderer(javax.swing.tree.TreeCellRenderer) to tell the tree to use it. To edit such nodes, subclass TreeCellEditor and use setCellEditor(javax.swing.tree.TreeCellEditor).
Like all JComponent classes, you can use InputMap and ActionMap to associate an Action object with a KeyStroke and execute the action under specified conditions.
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.
| Modifier and Type | Class and Description |
|---|---|
protected class |
JTree.AccessibleJTree This class implements accessibility support for the |
static class |
JTree.DropLocation A subclass of |
static class |
JTree.DynamicUtilTreeNode
|
protected static class |
JTree.EmptySelectionModel
|
protected class |
JTree.TreeModelHandler Listens to the model and updates the |
protected class |
JTree.TreeSelectionRedirector Handles creating a new |
JComponent.AccessibleJComponent Container.AccessibleAWTContainer Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy protected transient TreeModel treeModel
The model that defines the tree displayed by this object.
protected transient TreeSelectionModel selectionModel
Models the set of selected nodes in this tree.
protected boolean rootVisible
True if the root node is displayed, false if its children are the highest visible nodes.
protected transient TreeCellRenderer cellRenderer
The cell used to draw nodes. If null, the UI uses a default cellRenderer.
protected int rowHeight
Height to use for each display row. If this is <= 0 the renderer determines the height for each row.
protected boolean showsRootHandles
True if handles are displayed at the topmost level of the tree.
A handle is a small icon that displays adjacent to the node which allows the user to click once to expand or collapse the node. A common interface shows a plus sign (+) for a node which can be expanded and a minus sign (-) for a node which can be collapsed. Handles are always shown for nodes below the topmost level.
If the rootVisible setting specifies that the root node is to be displayed, then that is the only node at the topmost level. If the root node is not displayed, then all of its children are at the topmost level of the tree. Handles are always displayed for nodes other than the topmost.
If the root node isn't visible, it is generally a good to make this value true. Otherwise, the tree looks exactly like a list, and users may not know that the "list entries" are actually tree nodes.
rootVisibleprotected transient JTree.TreeSelectionRedirector selectionRedirector
Creates a new event and passed it off the selectionListeners.
protected transient TreeCellEditor cellEditor
Editor for the entries. Default is null (tree is not editable).
protected boolean editable
Is the tree editable? Default is false.
protected boolean largeModel
Is this tree a large model? This is a code-optimization setting. A large model can be used when the cell height is the same for all nodes. The UI will then cache very little information and instead continually message the model. Without a large model the UI caches most of the information, resulting in fewer method calls to the model.
This value is only a suggestion to the UI. Not all UIs will take advantage of it. Default value is false.
protected int visibleRowCount
Number of rows to make visible at one time. This value is used for the Scrollable interface. It determines the preferred size of the display area.
protected boolean invokesStopCellEditing
If true, when editing is to be stopped by way of selection changing, data in tree changing or other means stopCellEditing is invoked, and changes are saved. If false, cancelCellEditing is invoked, and changes are discarded. Default is false.
protected boolean scrollsOnExpand
If true, when a node is expanded, as many of the descendants are scrolled to be visible.
protected int toggleClickCount
Number of mouse clicks before a node is expanded.
protected transient TreeModelListener treeModelListener
Updates the expandedState.
public static final String CELL_RENDERER_PROPERTY
Bound property name for cellRenderer.
public static final String TREE_MODEL_PROPERTY
Bound property name for treeModel.
public static final String ROOT_VISIBLE_PROPERTY
Bound property name for rootVisible.
public static final String SHOWS_ROOT_HANDLES_PROPERTY
Bound property name for showsRootHandles.
public static final String ROW_HEIGHT_PROPERTY
Bound property name for rowHeight.
public static final String CELL_EDITOR_PROPERTY
Bound property name for cellEditor.
public static final String EDITABLE_PROPERTY
Bound property name for editable.
public static final String LARGE_MODEL_PROPERTY
Bound property name for largeModel.
public static final String SELECTION_MODEL_PROPERTY
Bound property name for selectionModel.
public static final String VISIBLE_ROW_COUNT_PROPERTY
Bound property name for visibleRowCount.
public static final String INVOKES_STOP_CELL_EDITING_PROPERTY
Bound property name for messagesStopCellEditing.
public static final String SCROLLS_ON_EXPAND_PROPERTY
Bound property name for scrollsOnExpand.
public static final String TOGGLE_CLICK_COUNT_PROPERTY
Bound property name for toggleClickCount.
public static final String LEAD_SELECTION_PATH_PROPERTY
Bound property name for leadSelectionPath.
public static final String ANCHOR_SELECTION_PATH_PROPERTY
Bound property name for anchor selection path.
public static final String EXPANDS_SELECTED_PATHS_PROPERTY
Bound property name for expands selected paths property
public JTree()
Returns a JTree with a sample model. The default model used by the tree defines a leaf node as any node without children.
DefaultTreeModel.asksAllowsChildrenpublic JTree(Object[] value)
Returns a JTree with each element of the specified array as the child of a new root node which is not displayed. By default, the tree defines a leaf node as any node without children.
value - an array of ObjectsDefaultTreeModel.asksAllowsChildrenpublic JTree(Vector<?> value)
Returns a JTree with each element of the specified Vector as the child of a new root node which is not displayed. By default, the tree defines a leaf node as any node without children.
value - a Vector
DefaultTreeModel.asksAllowsChildrenpublic JTree(Hashtable<?,?> value)
Returns a JTree created from a Hashtable which does not display with root. Each value-half of the key/value pairs in the HashTable becomes a child of the new root node. By default, the tree defines a leaf node as any node without children.
value - a Hashtable
DefaultTreeModel.asksAllowsChildrenpublic JTree(TreeNode root)
Returns a JTree with the specified TreeNode as its root, which displays the root node. By default, the tree defines a leaf node as any node without children.
root - a TreeNode objectDefaultTreeModel.asksAllowsChildrenpublic JTree(TreeNode root,
boolean asksAllowsChildren) Returns a JTree with the specified TreeNode as its root, which displays the root node and which decides whether a node is a leaf node in the specified manner.
root - a TreeNode objectasksAllowsChildren - if false, any node without children is a leaf node; if true, only nodes that do not allow children are leaf nodesDefaultTreeModel.asksAllowsChildren@ConstructorProperties(value="model") public JTree(TreeModel newModel)
Returns an instance of JTree which displays the root node -- the tree is created using the specified data model.
newModel - the TreeModel to use as the data modelprotected static TreeModel getDefaultTreeModel()
Creates and returns a sample TreeModel. Used primarily for beanbuilders to show something interesting.
TreeModel
protected static TreeModel createTreeModel(Object value)
Returns a TreeModel wrapping the specified object. If the object is:
Objects, Hashtable, or Vector "root". value - the Object used as the foundation for the TreeModel
TreeModel wrapping the specified objectpublic TreeUI getUI()
Returns the L&F object that renders this component.
TreeUI object that renders this componentpublic void setUI(TreeUI ui)
Sets the L&F object that renders this component.
This is a bound property.
ui - the TreeUI L&F objectUIDefaults.getUI(javax.swing.JComponent)public void updateUI()
Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.
updateUI in class JComponent
JComponent.updateUI()public String getUIClassID()
Returns the name of the L&F class that renders this component.
getUIClassID in class JComponent
JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)
public TreeCellRenderer getCellRenderer()
Returns the current TreeCellRenderer that is rendering each cell.
TreeCellRenderer that is rendering each cellpublic void setCellRenderer(TreeCellRenderer x)
Sets the TreeCellRenderer that will be used to draw each cell.
This is a bound property.
x - the TreeCellRenderer that is to render each cellpublic void setEditable(boolean flag)
Determines whether the tree is editable. Fires a property change event if the new setting is different from the existing setting.
This is a bound property.
flag - a boolean value, true if the tree is editablepublic boolean isEditable()
Returns true if the tree is editable.
public void setCellEditor(TreeCellEditor cellEditor)
Sets the cell editor. A null value implies that the tree cannot be edited. If this represents a change in the cellEditor, the propertyChange method is invoked on all listeners.
This is a bound property.
cellEditor - the TreeCellEditor to usepublic TreeCellEditor getCellEditor()
Returns the editor used to edit entries in the tree.
TreeCellEditor in use, or null if the tree cannot be editedpublic TreeModel getModel()
Returns the TreeModel that is providing the data.
TreeModel that is providing the datapublic void setModel(TreeModel newModel)
Sets the TreeModel that will provide the data.
This is a bound property.
newModel - the TreeModel that is to provide the datapublic boolean isRootVisible()
Returns true if the root node of the tree is displayed.
rootVisiblepublic void setRootVisible(boolean rootVisible)
Determines whether or not the root node from the TreeModel is visible.
This is a bound property.
rootVisible - true if the root node of the tree is to be displayedrootVisiblepublic void setShowsRootHandles(boolean newValue)
Sets the value of the showsRootHandles property, which specifies whether the node handles should be displayed. The default value of this property depends on the constructor used to create the JTree. Some look and feels might not support handles; they will ignore this property.
This is a bound property.
newValue - true if root handles should be displayed; otherwise, false
showsRootHandles, getShowsRootHandles()
public boolean getShowsRootHandles()
Returns the value of the showsRootHandles property.
showsRootHandles propertyshowsRootHandlespublic void setRowHeight(int rowHeight)
Sets the height of each cell, in pixels. If the specified value is less than or equal to zero the current cell renderer is queried for each row's height.
This is a bound property.
rowHeight - the height of each cell, in pixelspublic 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 boolean isFixedRowHeight()
Returns true if the height of each display row is a fixed size.
public void setLargeModel(boolean newValue)
Specifies whether the UI should use a large model. (Not all UIs will implement this.) Fires a property change for the LARGE_MODEL_PROPERTY.
This is a bound property.
newValue - true to suggest a large model to the UIlargeModelpublic boolean isLargeModel()
Returns true if the tree is configured for a large model.
largeModelpublic void setInvokesStopCellEditing(boolean newValue)
Determines what happens when editing is interrupted by selecting another node in the tree, a change in the tree's data, or by some other means. Setting this property to true causes the changes to be automatically saved when editing is interrupted.
Fires a property change for the INVOKES_STOP_CELL_EDITING_PROPERTY.
newValue - true means that stopCellEditing is invoked when editing is interrupted, and data is saved; false means that cancelCellEditing is invoked, and changes are lostpublic boolean getInvokesStopCellEditing()
Returns the indicator that tells what happens when editing is interrupted.
setInvokesStopCellEditing(boolean)public void setScrollsOnExpand(boolean newValue)
Sets the scrollsOnExpand property, which determines whether the tree might scroll to show previously hidden children. If this property is true (the default), when a node expands the tree can use scrolling to make the maximum possible number of the node's descendants visible. In some look and feels, trees might not need to scroll when expanded; those look and feels will ignore this property.
This is a bound property.
newValue - false to disable scrolling on expansion; true to enable itgetScrollsOnExpand()public boolean getScrollsOnExpand()
Returns the value of the scrollsOnExpand property.
scrollsOnExpand propertypublic void setToggleClickCount(int clickCount)
Sets the number of mouse clicks before a node will expand or close. The default is two.
This is a bound property.
public int getToggleClickCount()
Returns the number of mouse clicks needed to expand or close a node.
public void setExpandsSelectedPaths(boolean newValue)
Configures the expandsSelectedPaths property. If true, any time the selection is changed, either via the TreeSelectionModel, or the cover methods provided by JTree, the TreePaths parents will be expanded to make them visible (visible meaning the parent path is expanded, not necessarily in the visible rectangle of the JTree). If false, when the selection changes the nodes parent is not made visible (all its parents expanded). This is useful if you wish to have your selection model maintain paths that are not always visible (all parents expanded).
This is a bound property.
newValue - the new value for expandsSelectedPaths
public boolean getExpandsSelectedPaths()
Returns the expandsSelectedPaths property.
setExpandsSelectedPaths(boolean)public void setDragEnabled(boolean b)
Turns on or off automatic drag handling. In order to enable automatic drag handling, this property should be set to true, and the tree's TransferHandler needs to be non-null. The default value of the dragEnabled property is false.
The job of honoring this property, and recognizing a user drag gesture, lies with the look and feel implementation, and in particular, the tree's TreeUI. When automatic drag handling is enabled, most look and feels (including those that subclass BasicLookAndFeel) begin a drag and drop operation whenever the user presses the mouse button over an item and then moves the mouse a few pixels. Setting this property to true can therefore have a subtle effect on how selections behave.
If a look and feel is used that ignores this property, you can still begin a drag and drop operation by calling exportAsDrag on the tree's TransferHandler.
b - whether or not to enable automatic drag handlingHeadlessException - if b is true and GraphicsEnvironment.isHeadless() returns true
GraphicsEnvironment.isHeadless(), getDragEnabled(), JComponent.setTransferHandler(javax.swing.TransferHandler), TransferHandler
public boolean getDragEnabled()
Returns whether or not automatic drag handling is enabled.
dragEnabled propertysetDragEnabled(boolean)public final void setDropMode(DropMode dropMode)
Sets the drop mode for this component. For backward compatibility, the default for this property is DropMode.USE_SELECTION. Usage of one of the other modes is recommended, however, for an improved user experience. DropMode.ON, for instance, offers similar behavior of showing items as selected, but does so without affecting the actual selection in the tree.
JTree supports the following drop modes:
DropMode.USE_SELECTIONDropMode.ONDropMode.INSERTDropMode.ON_OR_INSERT The drop mode is only meaningful if this component has a TransferHandler that accepts drops.
dropMode - the drop mode to useIllegalArgumentException - if the drop mode is unsupported or null
getDropMode(), getDropLocation(), JComponent.setTransferHandler(javax.swing.TransferHandler), TransferHandler
public final DropMode getDropMode()
Returns the drop mode for this component.
setDropMode(javax.swing.DropMode)public final JTree.DropLocation getDropLocation()
Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, or null if no location is to currently be shown.
This method is not meant for querying the drop location from a TransferHandler, as the drop location is only set after the TransferHandler's canImport has returned and has allowed for the location to be shown.
When this property changes, a property change event with name "dropLocation" is fired by the component.
setDropMode(javax.swing.DropMode), TransferHandler.canImport(TransferHandler.TransferSupport)
public boolean isPathEditable(TreePath path)
Returns isEditable. This is invoked from the UI before editing begins to insure that the given path can be edited. This is provided as an entry point for subclassers to add filtered editing without having to resort to creating a new editor.
isEditable()public String getToolTipText(MouseEvent event)
Overrides JComponent's getToolTipText method in order to allow renderer's tips to be used if it has text set.
NOTE: For JTree to properly display tooltips of its renderers, JTree must be a registered component with the ToolTipManager. This can be done by invoking ToolTipManager.sharedInstance().registerComponent(tree). This is not done automatically!
getToolTipText in class JComponent
event - the MouseEvent that initiated the ToolTip displaynull if event is nullpublic String convertValueToText(Object value,
boolean selected,
boolean expanded,
boolean leaf,
int row,
boolean hasFocus) Called by the renderers to convert the specified value to text. This implementation returns value.toString, ignoring all other arguments. To control the conversion, subclass this method and use any of the arguments you need.
value - the Object to convert to textselected - true if the node is selectedexpanded - true if the node is expandedleaf - true if the node is a leaf noderow - an integer specifying the node's display row, where 0 is the first row in the displayhasFocus - true if the node has the focusString representation of the node's valuepublic int getRowCount()
Returns the number of viewable nodes. A node is viewable if all of its parents are expanded. The root is only included in this count if isRootVisible() is true. This returns 0 if the UI has not been set.
public void setSelectionPath(TreePath path)
Selects the node identified by the specified path. If any component of the path is hidden (under a collapsed node), and getExpandsSelectedPaths is true it is exposed (made viewable).
path - the TreePath specifying the node to selectpublic void setSelectionPaths(TreePath[] paths)
Selects the nodes identified by the specified array of paths. If any component in any of the paths is hidden (under a collapsed node), and getExpandsSelectedPaths is true it is exposed (made viewable).
paths - an array of TreePath objects that specifies the nodes to selectpublic void setLeadSelectionPath(TreePath newPath)
Sets the path identifies as the lead. The lead may not be selected. The lead is not maintained by JTree, rather the UI will update it.
This is a bound property.
newPath - the new lead pathpublic void setAnchorSelectionPath(TreePath newPath)
Sets the path identified as the anchor. The anchor is not maintained by JTree, rather the UI will update it.
This is a bound property.
newPath - the new anchor pathpublic void setSelectionRow(int row)
Selects the node at the specified row in the display.
row - the row to select, where 0 is the first row in the displaypublic void setSelectionRows(int[] rows)
Selects the nodes corresponding to each of the specified rows in the display. If a particular element of rows is < 0 or >= getRowCount, it will be ignored. If none of the elements in rows are valid rows, the selection will be cleared. That is it will be as if clearSelection was invoked.
rows - an array of ints specifying the rows to select, where 0 indicates the first row in the displaypublic void addSelectionPath(TreePath path)
Adds the node identified by the specified TreePath to the current selection. If any component of the path isn't viewable, and getExpandsSelectedPaths is true it is made viewable.
Note that JTree does not allow duplicate nodes to exist as children under the same parent -- each sibling must be a unique object.
path - the TreePath to addpublic void addSelectionPaths(TreePath[] paths)
Adds each path in the array of paths to the current selection. If any component of any of the paths isn't viewable and getExpandsSelectedPaths is true, it is made viewable.
Note that JTree does not allow duplicate nodes to exist as children under the same parent -- each sibling must be a unique object.
paths - an array of TreePath objects that specifies the nodes to addpublic void addSelectionRow(int row)
Adds the path at the specified row to the current selection.
row - an integer specifying the row of the node to add, where 0 is the first row in the displaypublic void addSelectionRows(int[] rows)
Adds the paths at each of the specified rows to the current selection.
rows - an array of ints specifying the rows to add, where 0 indicates the first row in the displaypublic Object getLastSelectedPathComponent()
Returns the last path component of the selected path. This is a convenience method for getSelectionModel().getSelectionPath().getLastPathComponent(). This is typically only useful if the selection has one path.
null if nothing is selectedTreePath.getLastPathComponent()public TreePath getLeadSelectionPath()
Returns the path identified as the lead.
public TreePath getAnchorSelectionPath()
Returns the path identified as the anchor.
public TreePath getSelectionPath()
Returns the path to the first selected node.
TreePath for the first selected node, or null if nothing is currently selectedpublic TreePath[] getSelectionPaths()
Returns the paths of all selected values.
TreePath objects indicating the selected nodes, or null if nothing is currently selectedpublic int[] getSelectionRows()
Returns all of the currently selected rows. This method is simply forwarded to the TreeSelectionModel. If nothing is selected null or an empty array will be returned, based on the TreeSelectionModel implementation.
public int getSelectionCount()
Returns the number of nodes selected.
public int getMinSelectionRow()
Returns the smallest selected row. If the selection is empty, or none of the selected paths are viewable, -1 is returned.
public int getMaxSelectionRow()
Returns the largest selected row. If the selection is empty, or none of the selected paths are viewable, -1 is returned.
public int getLeadSelectionRow()
Returns the row index corresponding to the lead path.
leadPath is null
public boolean isPathSelected(TreePath path)
Returns true if the item identified by the path is currently selected.
path - a TreePath identifying a nodepublic boolean isRowSelected(int row)
Returns true if the node identified by row is selected.
row - an integer specifying a display row, where 0 is the first row in the displaypublic Enumeration<TreePath> getExpandedDescendants(TreePath parent)
Returns an Enumeration of the descendants of the path parent that are currently expanded. If parent is not currently expanded, this will return null. If you expand/collapse nodes while iterating over the returned Enumeration this may not return all the expanded paths, or may return paths that are no longer expanded.
parent - the path which is to be examinedEnumeration of the descendents of parent, or null if parent is not currently expandedpublic boolean hasBeenExpanded(TreePath path)
Returns true if the node identified by the path has ever been expanded.
path has ever been expandedpublic boolean isExpanded(TreePath path)
Returns true if the node identified by the path is currently expanded,
path - the TreePath specifying the node to checkpublic boolean isExpanded(int row)
Returns true if the node at the specified display row is currently expanded.
row - the row to check, where 0 is the first row in the displaypublic boolean isCollapsed(TreePath path)
Returns true if the value identified by path is currently collapsed, this will return false if any of the values in path are currently not being displayed.
path - the TreePath to checkpublic boolean isCollapsed(int row)
Returns true if the node at the specified display row is collapsed.
row - the row to check, where 0 is the first row in the displaypublic void makeVisible(TreePath path)
Ensures that the node identified by path is currently viewable.
path - the TreePath to make visiblepublic boolean isVisible(TreePath path)
Returns true if the value identified by path is currently viewable, which means it is either the root or all of its parents are expanded. Otherwise, this method returns false.
public Rectangle getPathBounds(TreePath path)
Returns the Rectangle that the specified node will be drawn into. Returns null if any component in the path is hidden (under a collapsed parent).
Note:
This method returns a valid rectangle, even if the specified node is not currently displayed.
path - the TreePath identifying the nodeRectangle the node is drawn in, or null
public Rectangle getRowBounds(int row)
Returns the Rectangle that the node at the specified row is drawn in.
row - the row to be drawn, where 0 is the first row in the displayRectangle the node is drawn inpublic void scrollPathToVisible(TreePath path)
Makes sure all the path components in path are expanded (except for the last path component) and scrolls so that the node identified by the path is displayed. Only works when this JTree is contained in a JScrollPane.
path - the TreePath identifying the node to bring into viewpublic void scrollRowToVisible(int row)
Scrolls the item identified by row until it is displayed. The minimum of amount of scrolling necessary to bring the row into view is performed. Only works when this JTree is contained in a JScrollPane.
row - an integer specifying the row to scroll, where 0 is the first row in the displaypublic TreePath getPathForRow(int row)
Returns the path for the specified row. If row is not visible, or a TreeUI has not been set, null is returned.
row - an integer specifying a rowTreePath to the specified node, null if row < 0 or row >= getRowCount()
public int getRowForPath(TreePath path)
Returns the row that displays the node identified by the specified path.
path - the TreePath identifying a nodepublic void expandPath(TreePath path)
Ensures that the node identified by the specified path is expanded and viewable. If the last item in the path is a leaf, this will have no effect.
path - the TreePath identifying a nodepublic void expandRow(int row)
Ensures that the node in the specified row is expanded and viewable.
If row is < 0 or >= getRowCount this will have no effect.
row - an integer specifying a display row, where 0 is the first row in the displaypublic void collapsePath(TreePath path)
Ensures that the node identified by the specified path is collapsed and viewable.
path - the TreePath identifying a nodepublic void collapseRow(int row)
Ensures that the node in the specified row is collapsed.
If row is < 0 or >= getRowCount this will have no effect.
row - an integer specifying a display row, where 0 is the first row in the displaypublic TreePath getPathForLocation(int x,
int y) Returns the path for the node at the specified location.
x - an integer giving the number of pixels horizontally from the left edge of the display area, minus any left marginy - an integer giving the number of pixels vertically from the top of the display area, minus any top marginTreePath for the node at that locationpublic int getRowForLocation(int x,
int y) Returns the row for the specified location.
x - an integer giving the number of pixels horizontally from the left edge of the display area, minus any left marginy - an integer giving the number of pixels vertically from the top of the display area, minus any top margingetClosestRowForLocation(int, int)public TreePath getClosestPathForLocation(int x,
int y) Returns the path to the node that is closest to x,y. If no nodes are currently viewable, or there is no model, returns null, otherwise it always returns a valid path. To test if the node is exactly at x, y, get the node's bounds and test x, y against that.
x - an integer giving the number of pixels horizontally from the left edge of the display area, minus any left marginy - an integer giving the number of pixels vertically from the top of the display area, minus any top marginTreePath for the node closest to that location, null if nothing is viewable or there is no modelgetPathForLocation(int, int), getPathBounds(javax.swing.tree.TreePath)
public int getClosestRowForLocation(int x,
int y) Returns the row to the node that is closest to x,y. If no nodes are viewable or there is no model, returns -1. Otherwise, it always returns a valid row. To test if the returned object is exactly at x, y, get the bounds for the node at the returned row and test x, y against that.
x - an integer giving the number of pixels horizontally from the left edge of the display area, minus any left marginy - an integer giving the number of pixels vertically from the top of the display area, minus any top margingetRowForLocation(int, int), getRowBounds(int)
public boolean isEditing()
Returns true if the tree is being edited. The item that is being edited can be obtained using getSelectionPath.
getSelectionPath()public boolean stopEditing()
Ends the current editing session. (The DefaultTreeCellEditor object saves any edits that are currently in progress on a cell. Other implementations may operate differently.) Has no effect if the tree isn't being edited.
Note:
To make edit-saves automatic whenever the user changes their position in the tree, usesetInvokesStopCellEditing(boolean).
public void cancelEditing()
Cancels the current editing session. Has no effect if the tree isn't being edited.
public void startEditingAtPath(TreePath path)
Selects the node identified by the specified path and initiates editing. The edit-attempt fails if the CellEditor does not allow editing for the specified item.
path - the TreePath identifying a nodepublic TreePath getEditingPath()
Returns the path to the element that is currently being edited.
TreePath for the node being editedpublic void setSelectionModel(TreeSelectionModel selectionModel)
Sets the tree's selection model. When a null value is specified an empty selectionModel is used, which does not allow selections.
This is a bound property.
selectionModel - the TreeSelectionModel to use, or null to disable selectionsTreeSelectionModelpublic TreeSelectionModel getSelectionModel()
Returns the model for selections. This should always return a non-null value. If you don't want to allow anything to be selected set the selection model to null, which forces an empty selection model to be used.
protected TreePath[] getPathBetweenRows(int index0,
int index1) Returns the paths (inclusive) between the specified rows. If the specified indices are within the viewable set of rows, or bound the viewable set of rows, then the indices are constrained by the viewable set of rows. If the specified indices are not within the viewable set of rows, or do not bound the viewable set of rows, then an empty array is returned. For example, if the row count is 10, and this method is invoked with -1, 20, then the specified indices are constrained to the viewable set of rows, and this is treated as if invoked with 0, 9. On the other hand, if this were invoked with -10, -1, then the specified indices do not bound the viewable set of rows, and an empty array is returned.
The parameters are not order dependent. That is, getPathBetweenRows(x, y) is equivalent to getPathBetweenRows(y, x).
An empty array is returned if the row count is 0, or the specified indices do not bound the viewable set of rows.
index0 - the first index in the rangeindex1 - the last index in the rangepublic void setSelectionInterval(int index0,
int index1) Selects the rows in the specified interval (inclusive). If the specified indices are within the viewable set of rows, or bound the viewable set of rows, then the specified rows are constrained by the viewable set of rows. If the specified indices are not within the viewable set of rows, or do not bound the viewable set of rows, then the selection is cleared. For example, if the row count is 10, and this method is invoked with -1, 20, then the specified indices bounds the viewable range, and this is treated as if invoked with 0, 9. On the other hand, if this were invoked with -10, -1, then the specified indices do not bound the viewable set of rows, and the selection is cleared.
The parameters are not order dependent. That is, setSelectionInterval(x, y) is equivalent to setSelectionInterval(y, x).
index0 - the first index in the range to selectindex1 - the last index in the range to selectpublic void addSelectionInterval(int index0,
int index1) Adds the specified rows (inclusive) to the selection. If the specified indices are within the viewable set of rows, or bound the viewable set of rows, then the specified indices are constrained by the viewable set of rows. If the indices are not within the viewable set of rows, or do not bound the viewable set of rows, then the selection is unchanged. For example, if the row count is 10, and this method is invoked with -1, 20, then the specified indices bounds the viewable range, and this is treated as if invoked with 0, 9. On the other hand, if this were invoked with -10, -1, then the specified indices do not bound the viewable set of rows, and the selection is unchanged.
The parameters are not order dependent. That is, addSelectionInterval(x, y) is equivalent to addSelectionInterval(y, x).
index0 - the first index in the range to add to the selectionindex1 - the last index in the range to add to the selectionpublic void removeSelectionInterval(int index0,
int index1) Removes the specified rows (inclusive) from the selection. If the specified indices are within the viewable set of rows, or bound the viewable set of rows, then the specified indices are constrained by the viewable set of rows. If the specified indices are not within the viewable set of rows, or do not bound the viewable set of rows, then the selection is unchanged. For example, if the row count is 10, and this method is invoked with -1, 20, then the specified range bounds the viewable range, and this is treated as if invoked with 0, 9. On the other hand, if this were invoked with -10, -1, then the specified range does not bound the viewable set of rows, and the selection is unchanged.
The parameters are not order dependent. That is, removeSelectionInterval(x, y) is equivalent to removeSelectionInterval(y, x).
index0 - the first row to remove from the selectionindex1 - the last row to remove from the selectionpublic void removeSelectionPath(TreePath path)
Removes the node identified by the specified path from the current selection.
path - the TreePath identifying a nodepublic void removeSelectionPaths(TreePath[] paths)
Removes the nodes identified by the specified paths from the current selection.
paths - an array of TreePath objects that specifies the nodes to removepublic void removeSelectionRow(int row)
Removes the row at the index row from the current selection.
row - the row to removepublic void removeSelectionRows(int[] rows)
Removes the rows that are selected at each of the specified rows.
rows - an array of ints specifying display rows, where 0 is the first row in the displaypublic void clearSelection()
Clears the selection.
public boolean isSelectionEmpty()
Returns true if the selection is currently empty.
public void addTreeExpansionListener(TreeExpansionListener tel)
Adds a listener for TreeExpansion events.
tel - a TreeExpansionListener that will be notified when a tree node is expanded or collapsed (a "negative expansion")public void removeTreeExpansionListener(TreeExpansionListener tel)
Removes a listener for TreeExpansion events.
tel - the TreeExpansionListener to removepublic TreeExpansionListener[] getTreeExpansionListeners()
Returns an array of all the TreeExpansionListeners added to this JTree with addTreeExpansionListener().
TreeExpansionListeners added or an empty array if no listeners have been addedpublic void addTreeWillExpandListener(TreeWillExpandListener tel)
Adds a listener for TreeWillExpand events.
tel - a TreeWillExpandListener that will be notified when a tree node will be expanded or collapsed (a "negative expansion")public void removeTreeWillExpandListener(TreeWillExpandListener tel)
Removes a listener for TreeWillExpand events.
tel - the TreeWillExpandListener to removepublic TreeWillExpandListener[] getTreeWillExpandListeners()
Returns an array of all the TreeWillExpandListeners added to this JTree with addTreeWillExpandListener().
TreeWillExpandListeners added or an empty array if no listeners have been addedpublic void fireTreeExpanded(TreePath path)
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the path parameter.
path - the TreePath indicating the node that was expandedEventListenerListpublic void fireTreeCollapsed(TreePath path)
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the path parameter.
path - the TreePath indicating the node that was collapsedEventListenerListpublic void fireTreeWillExpand(TreePath path)
throws ExpandVetoException Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the path parameter.
path - the TreePath indicating the node that was expandedExpandVetoExceptionEventListenerListpublic void fireTreeWillCollapse(TreePath path)
throws ExpandVetoException Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the path parameter.
path - the TreePath indicating the node that was expandedExpandVetoExceptionEventListenerListpublic void addTreeSelectionListener(TreeSelectionListener tsl)
Adds a listener for TreeSelection events.
tsl - the TreeSelectionListener that will be notified when a node is selected or deselected (a "negative selection")public void removeTreeSelectionListener(TreeSelectionListener tsl)
Removes a TreeSelection listener.
tsl - the TreeSelectionListener to removepublic TreeSelectionListener[] getTreeSelectionListeners()
Returns an array of all the TreeSelectionListeners added to this JTree with addTreeSelectionListener().
TreeSelectionListeners added or an empty array if no listeners have been addedprotected void fireValueChanged(TreeSelectionEvent e)
Notifies all listeners that have registered interest for notification on this event type.
e - the TreeSelectionEvent to be fired; generated by the TreeSelectionModel when a node is selected or deselectedEventListenerListpublic void treeDidChange()
Sent when the tree has changed enough that we need to resize the bounds, but not enough that we need to remove the expanded node set (e.g nodes were expanded or collapsed, or nodes were inserted into the tree). You should never have to invoke this, the UI will invoke this as it needs to.
public void setVisibleRowCount(int newCount)
Sets the number of rows that are to be displayed. This will only work if the tree is contained in a JScrollPane, and will adjust the preferred size and size of that scrollpane.
This is a bound property.
newCount - the number of rows to displaypublic int getVisibleRowCount()
Returns the number of rows that are displayed in the display area.
public TreePath getNextMatch(String prefix,
int startingRow,
Position.Bias bias) Returns the TreePath to the next tree element that begins with a prefix. To handle the conversion of a TreePath into a String, convertValueToText is used.
prefix - the string to test for a matchstartingRow - the row for starting the searchbias - the search direction, either Position.Bias.Forward or Position.Bias.Backward.IllegalArgumentException - if prefix is null or startingRow is out of boundspublic Dimension getPreferredScrollableViewportSize()
Returns the preferred display size of a JTree. The height is determined from getVisibleRowCount and the width is the current preferred width.
getPreferredScrollableViewportSize in interface Scrollable
Dimension object containing the preferred sizeJComponent.getPreferredSize()public int getScrollableUnitIncrement(Rectangle visibleRect,
int orientation,
int direction) Returns the amount to increment when scrolling. The amount is the height of the first displayed row that isn't completely in view or, if it is totally displayed, the height of the next row in the scrolling direction.
getScrollableUnitIncrement in interface Scrollable
visibleRect - the view area visible within the viewportorientation - either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL
direction - less than zero to scroll up/left, greater than zero for down/rightJScrollBar.setUnitIncrement(int)public int getScrollableBlockIncrement(Rectangle visibleRect,
int orientation,
int direction) Returns the amount for a block increment, which is the height or width of visibleRect, based on orientation.
getScrollableBlockIncrement in interface Scrollable
visibleRect - the view area visible within the viewportorientation - either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL
direction - less than zero to scroll up/left, greater than zero for down/right.JScrollBar.setBlockIncrement(int)public boolean getScrollableTracksViewportWidth()
Returns false to indicate that the width of the viewport does not determine the width of the table, unless the preferred width of the tree is smaller than the viewports width. In other words: ensure that the tree is never smaller than its viewport.
getScrollableTracksViewportWidth in interface Scrollable
Scrollable.getScrollableTracksViewportWidth()public boolean getScrollableTracksViewportHeight()
Returns false to indicate that the height of the viewport does not determine the height of the table, unless the preferred height of the tree is smaller than the viewports height. In other words: ensure that the tree is never smaller than its viewport.
getScrollableTracksViewportHeight in interface Scrollable
Scrollable.getScrollableTracksViewportHeight()protected void setExpandedState(TreePath path,
boolean state) Sets the expanded state of this JTree. If state is true, all parents of path and path are marked as expanded. If state is false, all parents of path are marked EXPANDED, but path itself is marked collapsed.
This will fail if a TreeWillExpandListener vetos it.
protected Enumeration<TreePath> getDescendantToggledPaths(TreePath parent)
Returns an Enumeration of TreePaths that have been expanded that are descendants of parent.
protected void removeDescendantToggledPaths(Enumeration<TreePath> toRemove)
Removes any descendants of the TreePaths in toRemove that have been expanded.
toRemove - an enumeration of the paths to remove; a value of null is ignoredClassCastException - if toRemove contains an element that is not a TreePath; null values are ignoredprotected void clearToggledPaths()
Clears the cache of toggled tree paths. This does NOT send out any TreeExpansionListener events.
protected TreeModelListener createTreeModelListener()
Creates and returns an instance of TreeModelHandler. The returned object is responsible for updating the expanded state when the TreeModel changes.
For more information on what expanded state means, see the JTree description above.
protected boolean removeDescendantSelectedPaths(TreePath path,
boolean includePath) Removes any paths in the selection that are descendants of path. If includePath is true and path is selected, it will be removed from the selection.
protected String paramString()
Returns a string representation of this JTree. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.
paramString in class JComponent
JTree.public AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JTree. For JTrees, the AccessibleContext takes the form of an AccessibleJTree. A new AccessibleJTree instance is created if necessary.
getAccessibleContext in interface Accessible
getAccessibleContext in class Component
© 1993–2017, 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.