public class

JTree

extends JComponent
implements Accessible Scrollable
java.lang.Object
   ↳ java.awt.Component
     ↳ java.awt.Container
       ↳ javax.swing.JComponent
         ↳ javax.swing.JTree
Known Direct Subclasses

Class Overview

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.

The following JTree methods use "visible" to mean "displayed":

  • isRootVisible()
  • setRootVisible()
  • scrollPathToVisible()
  • scrollRowToVisible()
  • getVisibleRowCount()
  • setVisibleRowCount()

The next group of JTree methods use "visible" to mean "viewable" (under an expanded parent):

  • isVisible()
  • makeVisible()

If you are interested in knowing when the selection changes implement the 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(TreeCellRenderer) to tell the tree to use it. To edit such nodes, subclass TreeCellEditor and use setCellEditor(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: Swing is not thread safe. For more information see Swing's Threading Policy.

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

Summary

Nested Classes
class JTree.AccessibleJTree This class implements accessibility support for the JTree class. 
class JTree.DropLocation A subclass of TransferHandler.DropLocation representing a drop location for a JTree. 
class JTree.DynamicUtilTreeNode DynamicUtilTreeNode can wrap vectors/hashtables/arrays/strings and create the appropriate children tree nodes as necessary. 
class JTree.EmptySelectionModel EmptySelectionModel is a TreeSelectionModel that does not allow anything to be selected. 
class JTree.TreeModelHandler Listens to the model and updates the expandedState accordingly when nodes are removed, or changed. 
class JTree.TreeSelectionRedirector Handles creating a new TreeSelectionEvent with the JTree as the source and passing it off to all the listeners. 
Constants
String ANCHOR_SELECTION_PATH_PROPERTY Bound property name for anchor selection path.
String CELL_EDITOR_PROPERTY Bound property name for cellEditor.
String CELL_RENDERER_PROPERTY Bound property name for cellRenderer.
String EDITABLE_PROPERTY Bound property name for editable.
String EXPANDS_SELECTED_PATHS_PROPERTY Bound property name for expands selected paths property
String INVOKES_STOP_CELL_EDITING_PROPERTY Bound property name for messagesStopCellEditing.
String LARGE_MODEL_PROPERTY Bound property name for largeModel.
String LEAD_SELECTION_PATH_PROPERTY Bound property name for leadSelectionPath.
String ROOT_VISIBLE_PROPERTY Bound property name for rootVisible.
String ROW_HEIGHT_PROPERTY Bound property name for rowHeight.
String SCROLLS_ON_EXPAND_PROPERTY Bound property name for scrollsOnExpand.
String SELECTION_MODEL_PROPERTY Bound property name for selectionModel.
String SHOWS_ROOT_HANDLES_PROPERTY Bound property name for showsRootHandles.
String TOGGLE_CLICK_COUNT_PROPERTY Bound property name for toggleClickCount.
String TREE_MODEL_PROPERTY Bound property name for treeModel.
String VISIBLE_ROW_COUNT_PROPERTY Bound property name for visibleRowCount.
[Expand]
Inherited Constants
From class javax.swing.JComponent
From class java.awt.Component
From interface java.awt.image.ImageObserver
Fields
protected TreeCellEditor cellEditor Editor for the entries.
protected TreeCellRenderer cellRenderer The cell used to draw nodes.
protected boolean editable Is the tree editable? Default is false.
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.
protected boolean largeModel Is this tree a large model? This is a code-optimization setting.
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 display row.
protected boolean scrollsOnExpand If true, when a node is expanded, as many of the descendants are scrolled to be visible.
protected TreeSelectionModel selectionModel Models the set of selected nodes in this tree.
protected JTree.TreeSelectionRedirector selectionRedirector Creates a new event and passed it off the selectionListeners.
protected boolean showsRootHandles True if handles are displayed at the topmost level of the tree.
protected int toggleClickCount Number of mouse clicks before a node is expanded.
protected TreeModel treeModel The model that defines the tree displayed by this object.
protected TreeModelListener treeModelListener Updates the expandedState.
protected int visibleRowCount Number of rows to make visible at one time.
[Expand]
Inherited Fields
From class javax.swing.JComponent
Public Constructors
JTree()
Returns a JTree with a sample model.
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.
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.
JTree(Hashtable<?, ?> value)
Returns a JTree created from a Hashtable which does not display with root.
JTree(TreeNode root)
Returns a JTree with the specified TreeNode as its root, which displays the root node.
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.
JTree(TreeModel newModel)
Returns an instance of JTree which displays the root node -- the tree is created using the specified data model.
Public Methods
void addSelectionInterval(int index0, int index1)
Adds the paths between index0 and index1, inclusive, to the selection.
void addSelectionPath(TreePath path)
Adds the node identified by the specified TreePath to the current selection.
void addSelectionPaths(TreePath[] paths)
Adds each path in the array of paths to the current selection.
void addSelectionRow(int row)
Adds the path at the specified row to the current selection.
void addSelectionRows(int[] rows)
Adds the paths at each of the specified rows to the current selection.
void addTreeExpansionListener(TreeExpansionListener tel)
Adds a listener for TreeExpansion events.
void addTreeSelectionListener(TreeSelectionListener tsl)
Adds a listener for TreeSelection events.
void addTreeWillExpandListener(TreeWillExpandListener tel)
Adds a listener for TreeWillExpand events.
void cancelEditing()
Cancels the current editing session.
void clearSelection()
Clears the selection.
void collapsePath(TreePath path)
Ensures that the node identified by the specified path is collapsed and viewable.
void collapseRow(int row)
Ensures that the node in the specified row is collapsed.
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.
void expandPath(TreePath path)
Ensures that the node identified by the specified path is expanded and viewable.
void expandRow(int row)
Ensures that the node in the specified row is expanded and viewable.
void fireTreeCollapsed(TreePath path)
Notifies all listeners that have registered interest for notification on this event type.
void fireTreeExpanded(TreePath path)
Notifies all listeners that have registered interest for notification on this event type.
void fireTreeWillCollapse(TreePath path)
Notifies all listeners that have registered interest for notification on this event type.
void fireTreeWillExpand(TreePath path)
Notifies all listeners that have registered interest for notification on this event type.
AccessibleContext getAccessibleContext()
Gets the AccessibleContext associated with this JTree.
TreePath getAnchorSelectionPath()
Returns the path identified as the anchor.
TreeCellEditor getCellEditor()
Returns the editor used to edit entries in the tree.
TreeCellRenderer getCellRenderer()
Returns the current TreeCellRenderer that is rendering each cell.
TreePath getClosestPathForLocation(int x, int y)
Returns the path to the node that is closest to x,y.
int getClosestRowForLocation(int x, int y)
Returns the row to the node that is closest to x,y.
boolean getDragEnabled()
Returns whether or not automatic drag handling is enabled.
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.
final DropMode getDropMode()
Returns the drop mode for this component.
TreePath getEditingPath()
Returns the path to the element that is currently being edited.
Enumeration<TreePath> getExpandedDescendants(TreePath parent)
Returns an Enumeration of the descendants of the path parent that are currently expanded.
boolean getExpandsSelectedPaths()
Returns the expandsSelectedPaths property.
boolean getInvokesStopCellEditing()
Returns the indicator that tells what happens when editing is interrupted.
Object getLastSelectedPathComponent()
Returns the last path component in the first node of the current selection.
TreePath getLeadSelectionPath()
Returns the path identified as the lead.
int getLeadSelectionRow()
Returns the row index corresponding to the lead path.
int getMaxSelectionRow()
Returns the last selected row.
int getMinSelectionRow()
Gets the first selected row.
TreeModel getModel()
Returns the TreeModel that is providing the data.
TreePath getNextMatch(String prefix, int startingRow, Position.Bias bias)
Returns the TreePath to the next tree element that begins with a prefix.
Rectangle getPathBounds(TreePath path)
Returns the Rectangle that the specified node will be drawn into.
TreePath getPathForLocation(int x, int y)
Returns the path for the node at the specified location.
TreePath getPathForRow(int row)
Returns the path for the specified row.
Dimension getPreferredScrollableViewportSize()
Returns the preferred display size of a JTree.
Rectangle getRowBounds(int row)
Returns the Rectangle that the node at the specified row is drawn in.
int getRowCount()
Returns the number of rows that are currently being displayed.
int getRowForLocation(int x, int y)
Returns the row for the specified location.
int getRowForPath(TreePath path)
Returns the row that displays the node identified by the specified path.
int getRowHeight()
Returns the height of each row.
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.
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.
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.
int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
Returns the amount to increment when scrolling.
boolean getScrollsOnExpand()
Returns the value of the scrollsOnExpand property.
int getSelectionCount()
Returns the number of nodes selected.
TreeSelectionModel getSelectionModel()
Returns the model for selections.
TreePath getSelectionPath()
Returns the path to the first selected node.
TreePath[] getSelectionPaths()
Returns the paths of all selected values.
int[] getSelectionRows()
Returns all of the currently selected rows.
boolean getShowsRootHandles()
Returns the value of the showsRootHandles property.
int getToggleClickCount()
Returns the number of mouse clicks needed to expand or close a node.
String getToolTipText(MouseEvent event)
Overrides JComponent's getToolTipText method in order to allow renderer's tips to be used if it has text set.
TreeExpansionListener[] getTreeExpansionListeners()
Returns an array of all the TreeExpansionListeners added to this JTree with addTreeExpansionListener().
TreeSelectionListener[] getTreeSelectionListeners()
Returns an array of all the TreeSelectionListeners added to this JTree with addTreeSelectionListener().
TreeWillExpandListener[] getTreeWillExpandListeners()
Returns an array of all the TreeWillExpandListeners added to this JTree with addTreeWillExpandListener().
TreeUI getUI()
Returns the L&F object that renders this component.
String getUIClassID()
Returns the name of the L&F class that renders this component.
int getVisibleRowCount()
Returns the number of rows that are displayed in the display area.
boolean hasBeenExpanded(TreePath path)
Returns true if the node identified by the path has ever been expanded.
boolean isCollapsed(int row)
Returns true if the node at the specified display row is collapsed.
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.
boolean isEditable()
Returns true if the tree is editable.
boolean isEditing()
Returns true if the tree is being edited.
boolean isExpanded(int row)
Returns true if the node at the specified display row is currently expanded.
boolean isExpanded(TreePath path)
Returns true if the node identified by the path is currently expanded,
boolean isFixedRowHeight()
Returns true if the height of each display row is a fixed size.
boolean isLargeModel()
Returns true if the tree is configured for a large model.
boolean isPathEditable(TreePath path)
Returns isEditable.
boolean isPathSelected(TreePath path)
Returns true if the item identified by the path is currently selected.
boolean isRootVisible()
Returns true if the root node of the tree is displayed.
boolean isRowSelected(int row)
Returns true if the node identified by row is selected.
boolean isSelectionEmpty()
Returns true if the selection is currently empty.
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.
void makeVisible(TreePath path)
Ensures that the node identified by path is currently viewable.
void removeSelectionInterval(int index0, int index1)
Removes the nodes between index0 and index1, inclusive, from the selection.
void removeSelectionPath(TreePath path)
Removes the node identified by the specified path from the current selection.
void removeSelectionPaths(TreePath[] paths)
Removes the nodes identified by the specified paths from the current selection.
void removeSelectionRow(int row)
Removes the row at the index row from the current selection.
void removeSelectionRows(int[] rows)
Removes the rows that are selected at each of the specified rows.
void removeTreeExpansionListener(TreeExpansionListener tel)
Removes a listener for TreeExpansion events.
void removeTreeSelectionListener(TreeSelectionListener tsl)
Removes a TreeSelection listener.
void removeTreeWillExpandListener(TreeWillExpandListener tel)
Removes a listener for TreeWillExpand events.
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.
void scrollRowToVisible(int row)
Scrolls the item identified by row until it is displayed.
void setAnchorSelectionPath(TreePath newPath)
Sets the path identified as the anchor.
void setCellEditor(TreeCellEditor cellEditor)
Sets the cell editor.
void setCellRenderer(TreeCellRenderer x)
Sets the TreeCellRenderer that will be used to draw each cell.
void setDragEnabled(boolean b)
Turns on or off automatic drag handling.
final void setDropMode(DropMode dropMode)
Sets the drop mode for this component.
void setEditable(boolean flag)
Determines whether the tree is editable.
void setExpandsSelectedPaths(boolean newValue)
Configures the expandsSelectedPaths property.
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.
void setLargeModel(boolean newValue)
Specifies whether the UI should use a large model.
void setLeadSelectionPath(TreePath newPath)
Sets the path identifies as the lead.
void setModel(TreeModel newModel)
Sets the TreeModel that will provide the data.
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, in pixels.
void setScrollsOnExpand(boolean newValue)
Sets the scrollsOnExpand property, which determines whether the tree might scroll to show previously hidden children.
void setSelectionInterval(int index0, int index1)
Selects the nodes between index0 and index1, inclusive.
void setSelectionModel(TreeSelectionModel selectionModel)
Sets the tree's selection model.
void setSelectionPath(TreePath path)
Selects the node identified by the specified path.
void setSelectionPaths(TreePath[] paths)
Selects the nodes identified by the specified array of paths.
void setSelectionRow(int row)
Selects the node at the specified row in the display.
void setSelectionRows(int[] rows)
Selects the nodes corresponding to each of the specified rows in the display.
void setShowsRootHandles(boolean newValue)
Sets the value of the showsRootHandles property, which specifies whether the node handles should be displayed.
void setToggleClickCount(int clickCount)
Sets the number of mouse clicks before a node will expand or close.
void setUI(TreeUI ui)
Sets the L&F object that renders this component.
void setVisibleRowCount(int newCount)
Sets the number of rows that are to be displayed.
void startEditingAtPath(TreePath path)
Selects the node identified by the specified path and initiates editing.
boolean stopEditing()
Ends the current editing session.
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).
void updateUI()
Notification from the UIManager that the L&F has changed.
Protected Methods
void clearToggledPaths()
Clears the cache of toggled tree paths.
static TreeModel createTreeModel(Object value)
Returns a TreeModel wrapping the specified object.
TreeModelListener createTreeModelListener()
Creates and returns an instance of TreeModelHandler.
void fireValueChanged(TreeSelectionEvent e)
Notifies all listeners that have registered interest for notification on this event type.
static TreeModel getDefaultTreeModel()
Creates and returns a sample TreeModel.
Enumeration<TreePath> getDescendantToggledPaths(TreePath parent)
Returns an Enumeration of TreePaths that have been expanded that are descendants of parent.
TreePath[] getPathBetweenRows(int index0, int index1)
Returns JTreePath instances representing the path between index0 and index1 (including index1).
String paramString()
Returns a string representation of this JTree.
boolean removeDescendantSelectedPaths(TreePath path, boolean includePath)
Removes any paths in the selection that are descendants of path.
void removeDescendantToggledPaths(Enumeration<TreePath> toRemove)
Removes any descendants of the TreePaths in toRemove that have been expanded.
void setExpandedState(TreePath path, boolean state)
Sets the expanded state of this JTree.
[Expand]
Inherited Methods
From class javax.swing.JComponent
From class java.awt.Container
From class java.awt.Component
From class java.lang.Object
From interface java.awt.MenuContainer
From interface java.awt.image.ImageObserver
From interface javax.accessibility.Accessible
From interface javax.swing.Scrollable

Constants

public static final String ANCHOR_SELECTION_PATH_PROPERTY

Bound property name for anchor selection path.

Constant Value: "anchorSelectionPath"

public static final String CELL_EDITOR_PROPERTY

Bound property name for cellEditor.

Constant Value: "cellEditor"

public static final String CELL_RENDERER_PROPERTY

Bound property name for cellRenderer.

Constant Value: "cellRenderer"

public static final String EDITABLE_PROPERTY

Bound property name for editable.

Constant Value: "editable"

public static final String EXPANDS_SELECTED_PATHS_PROPERTY

Bound property name for expands selected paths property

Constant Value: "expandsSelectedPaths"

public static final String INVOKES_STOP_CELL_EDITING_PROPERTY

Bound property name for messagesStopCellEditing.

Constant Value: "invokesStopCellEditing"

public static final String LARGE_MODEL_PROPERTY

Bound property name for largeModel.

Constant Value: "largeModel"

public static final String LEAD_SELECTION_PATH_PROPERTY

Bound property name for leadSelectionPath.

Constant Value: "leadSelectionPath"

public static final String ROOT_VISIBLE_PROPERTY

Bound property name for rootVisible.

Constant Value: "rootVisible"

public static final String ROW_HEIGHT_PROPERTY

Bound property name for rowHeight.

Constant Value: "rowHeight"

public static final String SCROLLS_ON_EXPAND_PROPERTY

Bound property name for scrollsOnExpand.

Constant Value: "scrollsOnExpand"

public static final String SELECTION_MODEL_PROPERTY

Bound property name for selectionModel.

Constant Value: "selectionModel"

public static final String SHOWS_ROOT_HANDLES_PROPERTY

Bound property name for showsRootHandles.

Constant Value: "showsRootHandles"

public static final String TOGGLE_CLICK_COUNT_PROPERTY

Bound property name for toggleClickCount.

Constant Value: "toggleClickCount"

public static final String TREE_MODEL_PROPERTY

Bound property name for treeModel.

Constant Value: "model"

public static final String VISIBLE_ROW_COUNT_PROPERTY

Bound property name for visibleRowCount.

Constant Value: "visibleRowCount"

Fields

protected TreeCellEditor cellEditor

Editor for the entries. Default is null (tree is not editable).

protected TreeCellRenderer cellRenderer

The cell used to draw nodes. If null, the UI uses a default cellRenderer.

protected boolean editable

Is the tree editable? Default is false.

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 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 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 display row. If this is <= 0 the renderer determines the height for each row.

protected boolean scrollsOnExpand

If true, when a node is expanded, as many of the descendants are scrolled to be visible.

protected TreeSelectionModel selectionModel

Models the set of selected nodes in this tree.

protected JTree.TreeSelectionRedirector selectionRedirector

Creates a new event and passed it off the selectionListeners.

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.

See Also

protected int toggleClickCount

Number of mouse clicks before a node is expanded.

protected TreeModel treeModel

The model that defines the tree displayed by this object.

protected TreeModelListener treeModelListener

Updates the expandedState.

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.

Public Constructors

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.

See Also

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

Parameters
value an array of Objects
See Also

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

Parameters
value a Vector
See Also

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

Parameters
value a Hashtable
See Also

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

Parameters
root a TreeNode object
See Also

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

Parameters
root a TreeNode object
asksAllowsChildren if false, any node without children is a leaf node; if true, only nodes that do not allow children are leaf nodes
See Also

public JTree (TreeModel newModel)

Returns an instance of JTree which displays the root node -- the tree is created using the specified data model.

Parameters
newModel the TreeModel to use as the data model

Public Methods

public void addSelectionInterval (int index0, int index1)

Adds the paths between index0 and index1, inclusive, to the selection.

Parameters
index0 an integer specifying a display row, where 0 is the first row in the display
index1 an integer specifying a second display row

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

Parameters
path the TreePath to add

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

Parameters
paths an array of TreePath objects that specifies the nodes to add

public void addSelectionRow (int row)

Adds the path at the specified row to the current selection.

Parameters
row an integer specifying the row of the node to add, where 0 is the first row in the display

public void addSelectionRows (int[] rows)

Adds the paths at each of the specified rows to the current selection.

Parameters
rows an array of ints specifying the rows to add, where 0 indicates the first row in the display

public void addTreeExpansionListener (TreeExpansionListener tel)

Adds a listener for TreeExpansion events.

Parameters
tel a TreeExpansionListener that will be notified when a tree node is expanded or collapsed (a "negative expansion")

public void addTreeSelectionListener (TreeSelectionListener tsl)

Adds a listener for TreeSelection events.

Parameters
tsl the TreeSelectionListener that will be notified when a node is selected or deselected (a "negative selection")

public void addTreeWillExpandListener (TreeWillExpandListener tel)

Adds a listener for TreeWillExpand events.

Parameters
tel a TreeWillExpandListener that will be notified when a tree node will be expanded or collapsed (a "negative expansion")

public void cancelEditing ()

Cancels the current editing session. Has no effect if the tree isn't being edited.

public void clearSelection ()

Clears the selection.

public void collapsePath (TreePath path)

Ensures that the node identified by the specified path is collapsed and viewable.

Parameters
path the TreePath identifying a node

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

Parameters
row an integer specifying a display row, where 0 is the first row in the display

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

Parameters
value the Object to convert to text
selected true if the node is selected
expanded true if the node is expanded
leaf true if the node is a leaf node
row an integer specifying the node's display row, where 0 is the first row in the display
hasFocus true if the node has the focus
Returns
  • the String representation of the node's value

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

Parameters
path the TreePath identifying a node

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

Parameters
row an integer specifying a display row, where 0 is the first row in the display

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

Parameters
path the TreePath indicating the node that was collapsed
See Also

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

Parameters
path the TreePath indicating the node that was expanded
See Also

public void fireTreeWillCollapse (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.

Parameters
path the TreePath indicating the node that was expanded
Throws
ExpandVetoException
See Also

public void fireTreeWillExpand (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.

Parameters
path the TreePath indicating the node that was expanded
Throws
ExpandVetoException
See Also

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.

Returns
  • an AccessibleJTree that serves as the AccessibleContext of this JTree

public TreePath getAnchorSelectionPath ()

Returns the path identified as the anchor.

Returns
  • path identified as the anchor

public TreeCellEditor getCellEditor ()

Returns the editor used to edit entries in the tree.

Returns
  • the TreeCellEditor in use, or null if the tree cannot be edited

public TreeCellRenderer getCellRenderer ()

Returns the current TreeCellRenderer that is rendering each cell.

Returns
  • the TreeCellRenderer that is rendering each cell

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.

Parameters
x an integer giving the number of pixels horizontally from the left edge of the display area, minus any left margin
y an integer giving the number of pixels vertically from the top of the display area, minus any top margin
Returns
  • the TreePath for the node closest to that location, null if nothing is viewable or there is no model
See Also

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.

Parameters
x an integer giving the number of pixels horizontally from the left edge of the display area, minus any left margin
y an integer giving the number of pixels vertically from the top of the display area, minus any top margin
Returns
  • the row closest to the location, -1 if nothing is viewable or there is no model
See Also

public boolean getDragEnabled ()

Returns whether or not automatic drag handling is enabled.

Returns
  • the value of the dragEnabled property
See Also

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.

Returns
  • the drop location
See Also

public final DropMode getDropMode ()

Returns the drop mode for this component.

Returns
  • the drop mode for this component
See Also

public TreePath getEditingPath ()

Returns the path to the element that is currently being edited.

Returns
  • the TreePath for the node being edited

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

Parameters
parent the path which is to be examined
Returns
  • an Enumeration of the descendents of parent, or null if parent is not currently expanded

public boolean getExpandsSelectedPaths ()

Returns the expandsSelectedPaths property.

Returns
  • true if selection changes result in the parent path being expanded
See Also

public boolean getInvokesStopCellEditing ()

Returns the indicator that tells what happens when editing is interrupted.

Returns
  • the indicator that tells what happens when editing is interrupted
See Also

public Object getLastSelectedPathComponent ()

Returns the last path component in the first node of the current selection.

Returns
  • the last Object in the first selected node's TreePath, or null if nothing is selected
See Also

public TreePath getLeadSelectionPath ()

Returns the path identified as the lead.

Returns
  • path identified as the lead

public int getLeadSelectionRow ()

Returns the row index corresponding to the lead path.

Returns
  • an integer giving the row index of the lead path, where 0 is the first row in the display; or -1 if leadPath is null

public int getMaxSelectionRow ()

Returns the last selected row.

Returns
  • an integer designating the last selected row, where 0 is the first row in the display

public int getMinSelectionRow ()

Gets the first selected row.

Returns
  • an integer designating the first selected row, where 0 is the first row in the display

public TreeModel getModel ()

Returns the TreeModel that is providing the data.

Returns
  • the TreeModel that is providing the data

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.

Parameters
prefix the string to test for a match
startingRow the row for starting the search
bias the search direction, either Position.Bias.Forward or Position.Bias.Backward.
Returns
  • the TreePath of the next tree element that starts with the prefix; otherwise null
Throws
IllegalArgumentException if prefix is null or startingRow is out of bounds

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.

Parameters
path the TreePath identifying the node
Returns
  • the Rectangle the node is drawn in, or null

public TreePath getPathForLocation (int x, int y)

Returns the path for the node at the specified location.

Parameters
x an integer giving the number of pixels horizontally from the left edge of the display area, minus any left margin
y an integer giving the number of pixels vertically from the top of the display area, minus any top margin
Returns
  • the TreePath for the node at that location

public TreePath getPathForRow (int row)

Returns the path for the specified row. If row is not visible, null is returned.

Parameters
row an integer specifying a row
Returns
  • the TreePath to the specified node, null if row < 0 or row > getRowCount()

public Dimension getPreferredScrollableViewportSize ()

Returns the preferred display size of a JTree. The height is determined from getVisibleRowCount and the width is the current preferred width.

Returns
  • a Dimension object containing the preferred size

public Rectangle getRowBounds (int row)

Returns the Rectangle that the node at the specified row is drawn in.

Parameters
row the row to be drawn, where 0 is the first row in the display
Returns
  • the Rectangle the node is drawn in

public int getRowCount ()

Returns the number of rows that are currently being displayed.

Returns
  • the number of rows that are being displayed

public int getRowForLocation (int x, int y)

Returns the row for the specified location.

Parameters
x an integer giving the number of pixels horizontally from the left edge of the display area, minus any left margin
y an integer giving the number of pixels vertically from the top of the display area, minus any top margin
Returns
  • the row corresponding to the location, or -1 if the location is not within the bounds of a displayed cell
See Also

public int getRowForPath (TreePath path)

Returns the row that displays the node identified by the specified path.

Parameters
path the TreePath identifying a node
Returns
  • an integer specifying the display row, where 0 is the first row in the display, or -1 if any of the elements in path are hidden under a collapsed parent.

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

Parameters
visibleRect the view area visible within the viewport
orientation either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL
direction less than zero to scroll up/left, greater than zero for down/right.
Returns
  • the "block" increment for scrolling in the specified direction
See Also

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.

Returns
  • false
See Also

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.

Returns
  • false
See Also

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.

Parameters
visibleRect the view area visible within the viewport
orientation either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL
direction less than zero to scroll up/left, greater than zero for down/right
Returns
  • the "unit" increment for scrolling in the specified direction
See Also

public boolean getScrollsOnExpand ()

Returns the value of the scrollsOnExpand property.

Returns
  • the value of the scrollsOnExpand property

public int getSelectionCount ()

Returns the number of nodes selected.

Returns
  • the number of nodes selected

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

See Also

public TreePath getSelectionPath ()

Returns the path to the first selected node.

Returns
  • the TreePath for the first selected node, or null if nothing is currently selected

public TreePath[] getSelectionPaths ()

Returns the paths of all selected values.

Returns
  • an array of TreePath objects indicating the selected nodes, or null if nothing is currently selected

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

Returns
  • an array of integers that identifies all currently selected rows where 0 is the first row in the display

public boolean getShowsRootHandles ()

Returns the value of the showsRootHandles property.

Returns
  • the value of the showsRootHandles property
See Also

public int getToggleClickCount ()

Returns the number of mouse clicks needed to expand or close a node.

Returns
  • number of mouse clicks before node is expanded

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!

Parameters
event the MouseEvent that initiated the ToolTip display
Returns
  • a string containing the tooltip or null if event is null

public TreeExpansionListener[] getTreeExpansionListeners ()

Returns an array of all the TreeExpansionListeners added to this JTree with addTreeExpansionListener().

Returns
  • all of the TreeExpansionListeners added or an empty array if no listeners have been added

public TreeSelectionListener[] getTreeSelectionListeners ()

Returns an array of all the TreeSelectionListeners added to this JTree with addTreeSelectionListener().

Returns
  • all of the TreeSelectionListeners added or an empty array if no listeners have been added

public TreeWillExpandListener[] getTreeWillExpandListeners ()

Returns an array of all the TreeWillExpandListeners added to this JTree with addTreeWillExpandListener().

Returns
  • all of the TreeWillExpandListeners added or an empty array if no listeners have been added

public TreeUI getUI ()

Returns the L&F object that renders this component.

Returns
  • the TreeUI object that renders this component

public String getUIClassID ()

Returns the name of the L&F class that renders this component.

Returns
  • the string "TreeUI"
See Also

public int getVisibleRowCount ()

Returns the number of rows that are displayed in the display area.

Returns
  • the number of rows displayed

public boolean hasBeenExpanded (TreePath path)

Returns true if the node identified by the path has ever been expanded.

Returns
  • true if the path has ever been expanded

public boolean isCollapsed (int row)

Returns true if the node at the specified display row is collapsed.

Parameters
row the row to check, where 0 is the first row in the display
Returns
  • true if the node is currently collapsed, otherwise false

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

Parameters
path the TreePath to check
Returns
  • true if any of the nodes in the node's path are collapsed, false if all nodes in the path are expanded

public boolean isEditable ()

Returns true if the tree is editable.

Returns
  • true if the tree is editable

public boolean isEditing ()

Returns true if the tree is being edited. The item that is being edited can be obtained using getSelectionPath.

Returns
  • true if the user is currently editing a node
See Also

public boolean isExpanded (int row)

Returns true if the node at the specified display row is currently expanded.

Parameters
row the row to check, where 0 is the first row in the display
Returns
  • true if the node is currently expanded, otherwise false

public boolean isExpanded (TreePath path)

Returns true if the node identified by the path is currently expanded,

Parameters
path the TreePath specifying the node to check
Returns
  • false if any of the nodes in the node's path are collapsed, true if all nodes in the path are expanded

public boolean isFixedRowHeight ()

Returns true if the height of each display row is a fixed size.

Returns
  • true if the height of each row is a fixed size

public boolean isLargeModel ()

Returns true if the tree is configured for a large model.

Returns
  • true if a large model is suggested
See Also

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.

Returns
  • true if every parent node and the node itself is editable
See Also

public boolean isPathSelected (TreePath path)

Returns true if the item identified by the path is currently selected.

Parameters
path a TreePath identifying a node
Returns
  • true if the node is selected

public boolean isRootVisible ()

Returns true if the root node of the tree is displayed.

Returns
  • true if the root node of the tree is displayed
See Also

public boolean isRowSelected (int row)

Returns true if the node identified by row is selected.

Parameters
row an integer specifying a display row, where 0 is the first row in the display
Returns
  • true if the node is selected

public boolean isSelectionEmpty ()

Returns true if the selection is currently empty.

Returns
  • true if the selection is currently empty

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

Returns
  • true if the node is viewable, otherwise false

public void makeVisible (TreePath path)

Ensures that the node identified by path is currently viewable.

Parameters
path the TreePath to make visible

public void removeSelectionInterval (int index0, int index1)

Removes the nodes between index0 and index1, inclusive, from the selection.

Parameters
index0 an integer specifying a display row, where 0 is the first row in the display
index1 an integer specifying a second display row

public void removeSelectionPath (TreePath path)

Removes the node identified by the specified path from the current selection.

Parameters
path the TreePath identifying a node

public void removeSelectionPaths (TreePath[] paths)

Removes the nodes identified by the specified paths from the current selection.

Parameters
paths an array of TreePath objects that specifies the nodes to remove

public void removeSelectionRow (int row)

Removes the row at the index row from the current selection.

Parameters
row the row to remove

public void removeSelectionRows (int[] rows)

Removes the rows that are selected at each of the specified rows.

Parameters
rows an array of ints specifying display rows, where 0 is the first row in the display

public void removeTreeExpansionListener (TreeExpansionListener tel)

Removes a listener for TreeExpansion events.

Parameters
tel the TreeExpansionListener to remove

public void removeTreeSelectionListener (TreeSelectionListener tsl)

Removes a TreeSelection listener.

Parameters
tsl the TreeSelectionListener to remove

public void removeTreeWillExpandListener (TreeWillExpandListener tel)

Removes a listener for TreeWillExpand events.

Parameters
tel the TreeWillExpandListener to remove

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

Parameters
path the TreePath identifying the node to bring into view

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

Parameters
row an integer specifying the row to scroll, where 0 is the first row in the display

public void setAnchorSelectionPath (TreePath newPath)

Sets the path identified as the anchor. The anchor is not maintained by JTree, rather the UI will update it.

Parameters
newPath the new anchor path

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.

Parameters
cellEditor the TreeCellEditor to use

public void setCellRenderer (TreeCellRenderer x)

Sets the TreeCellRenderer that will be used to draw each cell.

Parameters
x the TreeCellRenderer that is to render each cell

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.

Parameters
b whether or not to enable automatic drag handling
Throws
HeadlessException if b is true and GraphicsEnvironment.isHeadless() returns true
See Also

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_SELECTION
  • DropMode.ON
  • DropMode.INSERT
  • DropMode.ON_OR_INSERT

The drop mode is only meaningful if this component has a TransferHandler that accepts drops.

Parameters
dropMode the drop mode to use
Throws
IllegalArgumentException if the drop mode is unsupported or null
See Also

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

Parameters
flag a boolean value, true if the tree is editable

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

Parameters
newValue the new value for expandsSelectedPaths

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

Parameters
newValue true means that stopCellEditing is invoked when editing is interrupted, and data is saved; false means that cancelCellEditing is invoked, and changes are lost

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.

Parameters
newValue true to suggest a large model to the UI
See Also

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

Parameters
newPath the new lead path

public void setModel (TreeModel newModel)

Sets the TreeModel that will provide the data.

Parameters
newModel the TreeModel that is to provide the data

public void setRootVisible (boolean rootVisible)

Determines whether or not the root node from the TreeModel is visible.

Parameters
rootVisible true if the root node of the tree is to be displayed
See Also

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

Parameters
rowHeight the height of each cell, in pixels

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.

Parameters
newValue false to disable scrolling on expansion; true to enable it
See Also

public void setSelectionInterval (int index0, int index1)

Selects the nodes between index0 and index1, inclusive.

Parameters
index0 an integer specifying a display row, where 0 is the first row in the display
index1 an integer specifying a second display row

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

Parameters
selectionModel the TreeSelectionModel to use, or null to disable selections
See Also

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

Parameters
path the TreePath specifying the node to select

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

Parameters
paths an array of TreePath objects that specifies the nodes to select

public void setSelectionRow (int row)

Selects the node at the specified row in the display.

Parameters
row the row to select, where 0 is the first row in the display

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

Parameters
rows an array of ints specifying the rows to select, where 0 indicates the first row in the display

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

Parameters
newValue true if root handles should be displayed; otherwise, false
See Also

public void setToggleClickCount (int clickCount)

Sets the number of mouse clicks before a node will expand or close. The default is two.

public void setUI (TreeUI ui)

Sets the L&F object that renders this component.

Parameters
ui the TreeUI L&F object
See Also

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.

Parameters
newCount the number of rows to display

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.

Parameters
path the TreePath identifying a node

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, use setInvokesStopCellEditing(boolean).

Returns
  • true if editing was in progress and is now stopped, false if editing was not in progress

public 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 updateUI ()

Notification from the UIManager that the L&F has changed. Replaces the current UI object with the latest version from the UIManager.

See Also

Protected Methods

protected void clearToggledPaths ()

Clears the cache of toggled tree paths. This does NOT send out any TreeExpansionListener events.

protected static TreeModel createTreeModel (Object value)

Returns a TreeModel wrapping the specified object. If the object is:

  • an array of Objects,
  • a Hashtable, or
  • a Vector
then a new root node is created with each of the incoming objects as children. Otherwise, a new root is created with the specified object as its value.

Parameters
value the Object used as the foundation for the TreeModel
Returns
  • a TreeModel wrapping the specified object

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 void fireValueChanged (TreeSelectionEvent e)

Notifies all listeners that have registered interest for notification on this event type.

Parameters
e the TreeSelectionEvent to be fired; generated by the TreeSelectionModel when a node is selected or deselected
See Also

protected static TreeModel getDefaultTreeModel ()

Creates and returns a sample TreeModel. Used primarily for beanbuilders to show something interesting.

Returns
  • the default TreeModel

protected Enumeration<TreePath> getDescendantToggledPaths (TreePath parent)

Returns an Enumeration of TreePaths that have been expanded that are descendants of parent.

protected TreePath[] getPathBetweenRows (int index0, int index1)

Returns JTreePath instances representing the path between index0 and index1 (including index1). Returns null if there is no tree.

Parameters
index0 an integer specifying a display row, where 0 is the first row in the display
index1 an integer specifying a second display row
Returns
  • an array of TreePath objects, one for each node between index0 and index1, inclusive; or null if there is no tree

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.

Returns
  • a string representation of this JTree.

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.

Returns
  • true if a descendant was selected

protected void removeDescendantToggledPaths (Enumeration<TreePath> toRemove)

Removes any descendants of the TreePaths in toRemove that have been expanded.

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.