Class JTree
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JTree
- All Implemented Interfaces:
-
ImageObserver
,MenuContainer
,Serializable
,Accessible
,Scrollable
@JavaBean(defaultProperty="UI", description="A component that displays a set of hierarchical data as an outline.") 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
.
- Since:
- 1.2
- See Also:
- Serialized Form
Nested Class Summary
Modifier and Type | Class | 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 |
Nested classes/interfaces declared in class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
Field Summary
Modifier and Type | Field | Description |
---|---|---|
static String | ANCHOR_SELECTION_PATH_PROPERTY | Bound property name for anchor selection path. |
static String | CELL_EDITOR_PROPERTY | Bound property name for |
static String | CELL_RENDERER_PROPERTY | Bound property name for |
protected TreeCellEditor | cellEditor | Editor for the entries. |
protected TreeCellRenderer | cellRenderer | The cell used to draw nodes. |
protected boolean | editable | Is the tree editable? |
static String | EDITABLE_PROPERTY | Bound property name for |
static String | EXPANDS_SELECTED_PATHS_PROPERTY | Bound property name for expands selected paths property |
static String | INVOKES_STOP_CELL_EDITING_PROPERTY | Bound property name for |
protected boolean | invokesStopCellEditing | If true, when editing is to be stopped by way of selection changing, data in tree changing or other means |
static String | LARGE_MODEL_PROPERTY | Bound property name for |
protected boolean | largeModel | Is this tree a large model? |
static String | LEAD_SELECTION_PATH_PROPERTY | Bound property name for |
static String | ROOT_VISIBLE_PROPERTY | Bound property name for |
protected boolean | rootVisible | True if the root node is displayed, false if its children are the highest visible nodes. |
static String | ROW_HEIGHT_PROPERTY | Bound property name for |
protected int | rowHeight | Height to use for each display row. |
static String | SCROLLS_ON_EXPAND_PROPERTY | Bound property name for |
protected boolean | scrollsOnExpand | If true, when a node is expanded, as many of the descendants are scrolled to be visible. |
static String | SELECTION_MODEL_PROPERTY | Bound property name for selectionModel. |
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 |
static String | SHOWS_ROOT_HANDLES_PROPERTY | Bound property name for |
protected boolean | showsRootHandles | True if handles are displayed at the topmost level of the tree. |
static String | TOGGLE_CLICK_COUNT_PROPERTY | Bound property name for |
protected int | toggleClickCount | Number of mouse clicks before a node is expanded. |
static String | TREE_MODEL_PROPERTY | Bound property name for |
protected TreeModel | treeModel | The model that defines the tree displayed by this object. |
protected TreeModelListener | treeModelListener | Updates the |
static String | VISIBLE_ROW_COUNT_PROPERTY | Bound property name for |
protected int | visibleRowCount | Number of rows to make visible at one time. |
Fields declared in class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Fields declared in class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
Fields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor Summary
Constructor | Description |
---|---|
JTree() | Returns a |
JTree(Object[] value) | Returns a |
JTree(Hashtable<?,?> value) | Returns a |
JTree(Vector<?> value) | Returns a |
JTree(TreeModel newModel) | Returns an instance of |
JTree(TreeNode root) | Returns a |
JTree(TreeNode root,
boolean asksAllowsChildren) | Returns a |
Method Summary
Modifier and Type | Method | Description |
---|---|---|
void | addSelectionInterval(int index0,
int index1) | Adds the specified rows (inclusive) to the selection. |
void | addSelectionPath(TreePath path) | Adds the node identified by the specified |
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 |
void | addTreeSelectionListener(TreeSelectionListener tsl) | Adds a listener for |
void | addTreeWillExpandListener(TreeWillExpandListener tel) | Adds a listener for |
void | cancelEditing() | Cancels the current editing session. |
void | clearSelection() | Clears the selection. |
protected void | clearToggledPaths() | Clears the cache of toggled tree paths. |
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. |
protected static TreeModel | createTreeModel(Object value) | Returns a |
protected TreeModelListener | createTreeModelListener() | Creates and returns an instance of |
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. |
protected void | fireValueChanged(TreeSelectionEvent e) | 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 |
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. |
protected static TreeModel | getDefaultTreeModel() | Creates and returns a sample |
protected Enumeration<TreePath> | getDescendantToggledPaths(TreePath parent) | Returns an |
boolean | getDragEnabled() | Returns whether or not automatic drag handling is enabled. |
JTree.DropLocation | getDropLocation() | Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, or |
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 |
boolean | getExpandsSelectedPaths() | Returns the |
boolean | getInvokesStopCellEditing() | Returns the indicator that tells what happens when editing is interrupted. |
Object | getLastSelectedPathComponent() | Returns the last path component of the selected path. |
TreePath | getLeadSelectionPath() | Returns the path identified as the lead. |
int | getLeadSelectionRow() | Returns the row index corresponding to the lead path. |
int | getMaxSelectionRow() | Returns the largest selected row. |
int | getMinSelectionRow() | Returns the smallest selected row. |
TreeModel | getModel() | Returns the |
TreePath | getNextMatch(String prefix,
int startingRow,
Position.Bias bias) | Returns the TreePath to the next tree element that begins with a prefix. |
protected TreePath[] | getPathBetweenRows(int index0,
int index1) | Returns the paths (inclusive) between the specified rows. |
Rectangle | getPathBounds(TreePath path) | Returns the |
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 |
Rectangle | getRowBounds(int row) | Returns the |
int | getRowCount() | Returns the number of viewable nodes. |
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 |
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 |
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 |
int | getToggleClickCount() | Returns the number of mouse clicks needed to expand or close a node. |
String | getToolTipText(MouseEvent event) | Overrides |
TreeExpansionListener[] | getTreeExpansionListeners() | Returns an array of all the |
TreeSelectionListener[] | getTreeSelectionListeners() | Returns an array of all the |
TreeWillExpandListener[] | getTreeWillExpandListeners() | Returns an array of all the |
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 |
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. |
protected String | paramString() | Returns a string representation of this |
protected boolean | removeDescendantSelectedPaths(TreePath path,
boolean includePath) | Removes any paths in the selection that are descendants of |
protected void | removeDescendantToggledPaths(Enumeration<TreePath> toRemove) | Removes any descendants of the |
void | removeSelectionInterval(int index0,
int index1) | Removes the specified rows (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 |
void | removeSelectionRows(int[] rows) | Removes the rows that are selected at each of the specified rows. |
void | removeTreeExpansionListener(TreeExpansionListener tel) | Removes a listener for |
void | removeTreeSelectionListener(TreeSelectionListener tsl) | Removes a |
void | removeTreeWillExpandListener(TreeWillExpandListener tel) | Removes a listener for |
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 |
void | setDragEnabled(boolean b) | Turns on or off automatic drag handling. |
void | setDropMode(DropMode dropMode) | Sets the drop mode for this component. |
void | setEditable(boolean flag) | Determines whether the tree is editable. |
protected void | setExpandedState(TreePath path,
boolean state) | Sets the expanded state of this |
void | setExpandsSelectedPaths(boolean newValue) | Configures the |
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 |
void | setRootVisible(boolean rootVisible) | Determines whether or not the root node from the |
void | setRowHeight(int rowHeight) | Sets the height of each cell, in pixels. |
void | setScrollsOnExpand(boolean newValue) | Sets the |
void | setSelectionInterval(int index0,
int index1) | Selects the rows in the specified interval (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 |
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 |
Methods declared in class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
Methods declared in class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree
Methods declared in class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Field Detail
treeModel
protected transient TreeModel treeModel
The model that defines the tree displayed by this object.
selectionModel
protected transient TreeSelectionModel selectionModel
Models the set of selected nodes in this tree.
rootVisible
protected boolean rootVisible
True if the root node is displayed, false if its children are the highest visible nodes.
cellRenderer
protected transient TreeCellRenderer cellRenderer
The cell used to draw nodes. If null
, the UI uses a default cellRenderer
.
rowHeight
protected int rowHeight
Height to use for each display row. If this is <= 0 the renderer determines the height for each row.
showsRootHandles
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:
rootVisible
selectionRedirector
protected transient JTree.TreeSelectionRedirector selectionRedirector
Creates a new event and passed it off the selectionListeners
.
cellEditor
protected transient TreeCellEditor cellEditor
Editor for the entries. Default is null
(tree is not editable).
editable
protected boolean editable
Is the tree editable? Default is false.
largeModel
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.
visibleRowCount
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.
invokesStopCellEditing
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.
scrollsOnExpand
protected boolean scrollsOnExpand
If true, when a node is expanded, as many of the descendants are scrolled to be visible.
toggleClickCount
protected int toggleClickCount
Number of mouse clicks before a node is expanded.
treeModelListener
protected transient TreeModelListener treeModelListener
Updates the expandedState
.
CELL_RENDERER_PROPERTY
public static final String CELL_RENDERER_PROPERTY
Bound property name for cellRenderer
.
- See Also:
- Constant Field Values
TREE_MODEL_PROPERTY
public static final String TREE_MODEL_PROPERTY
Bound property name for treeModel
.
- See Also:
- Constant Field Values
ROOT_VISIBLE_PROPERTY
public static final String ROOT_VISIBLE_PROPERTY
Bound property name for rootVisible
.
- See Also:
- Constant Field Values
SHOWS_ROOT_HANDLES_PROPERTY
public static final String SHOWS_ROOT_HANDLES_PROPERTY
Bound property name for showsRootHandles
.
- See Also:
- Constant Field Values
ROW_HEIGHT_PROPERTY
public static final String ROW_HEIGHT_PROPERTY
Bound property name for rowHeight
.
- See Also:
- Constant Field Values
CELL_EDITOR_PROPERTY
public static final String CELL_EDITOR_PROPERTY
Bound property name for cellEditor
.
- See Also:
- Constant Field Values
EDITABLE_PROPERTY
public static final String EDITABLE_PROPERTY
Bound property name for editable
.
- See Also:
- Constant Field Values
LARGE_MODEL_PROPERTY
public static final String LARGE_MODEL_PROPERTY
Bound property name for largeModel
.
- See Also:
- Constant Field Values
SELECTION_MODEL_PROPERTY
public static final String SELECTION_MODEL_PROPERTY
Bound property name for selectionModel.
- See Also:
- Constant Field Values
VISIBLE_ROW_COUNT_PROPERTY
public static final String VISIBLE_ROW_COUNT_PROPERTY
Bound property name for visibleRowCount
.
- See Also:
- Constant Field Values
INVOKES_STOP_CELL_EDITING_PROPERTY
public static final String INVOKES_STOP_CELL_EDITING_PROPERTY
Bound property name for messagesStopCellEditing
.
- See Also:
- Constant Field Values
SCROLLS_ON_EXPAND_PROPERTY
public static final String SCROLLS_ON_EXPAND_PROPERTY
Bound property name for scrollsOnExpand
.
- See Also:
- Constant Field Values
TOGGLE_CLICK_COUNT_PROPERTY
public static final String TOGGLE_CLICK_COUNT_PROPERTY
Bound property name for toggleClickCount
.
- See Also:
- Constant Field Values
LEAD_SELECTION_PATH_PROPERTY
public static final String LEAD_SELECTION_PATH_PROPERTY
Bound property name for leadSelectionPath
.
- Since:
- 1.3
- See Also:
- Constant Field Values
ANCHOR_SELECTION_PATH_PROPERTY
public static final String ANCHOR_SELECTION_PATH_PROPERTY
Bound property name for anchor selection path.
- Since:
- 1.3
- See Also:
- Constant Field Values
EXPANDS_SELECTED_PATHS_PROPERTY
public static final String EXPANDS_SELECTED_PATHS_PROPERTY
Bound property name for expands selected paths property
- Since:
- 1.3
- See Also:
- Constant Field Values
Constructor Detail
JTree
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:
DefaultTreeModel.asksAllowsChildren
JTree
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 ofObject
s - See Also:
DefaultTreeModel.asksAllowsChildren
JTree
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
- aVector
- See Also:
DefaultTreeModel.asksAllowsChildren
JTree
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
- aHashtable
- See Also:
DefaultTreeModel.asksAllowsChildren
JTree
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
- aTreeNode
object - See Also:
DefaultTreeModel.asksAllowsChildren
JTree
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
- aTreeNode
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:
DefaultTreeModel.asksAllowsChildren
JTree
@ConstructorProperties("model") 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
- theTreeModel
to use as the data model
Method Detail
getDefaultTreeModel
protected static TreeModel getDefaultTreeModel()
Creates and returns a sample TreeModel
. Used primarily for beanbuilders to show something interesting.
- Returns:
- the default
TreeModel
createTreeModel
protected static TreeModel createTreeModel(Object value)
Returns a TreeModel
wrapping the specified object. If the object is:
- an array of
Object
s, - a
Hashtable
, or - a
Vector
"root"
. - Parameters:
-
value
- theObject
used as the foundation for theTreeModel
- Returns:
- a
TreeModel
wrapping the specified object
getUI
public TreeUI getUI()
Returns the L&F object that renders this component.
- Overrides:
-
getUI
in classJComponent
- Returns:
- the
TreeUI
object that renders this component
setUI
@BeanProperty(hidden=true, visualUpdate=true, description="The UI object that implements the Component\'s LookAndFeel.") public void setUI(TreeUI ui)
Sets the L&F object that renders this component.
This is a bound property.
- Parameters:
-
ui
- theTreeUI
L&F object - See Also:
UIDefaults.getUI(javax.swing.JComponent)
updateUI
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
.
- Overrides:
-
updateUI
in classJComponent
- See Also:
JComponent.updateUI()
getUIClassID
@BeanProperty(bound=false) public String getUIClassID()
Returns the name of the L&F class that renders this component.
- Overrides:
-
getUIClassID
in classJComponent
- Returns:
- the string "TreeUI"
- See Also:
-
JComponent.getUIClassID()
,UIDefaults.getUI(javax.swing.JComponent)
getCellRenderer
public TreeCellRenderer getCellRenderer()
Returns the current TreeCellRenderer
that is rendering each cell.
- Returns:
- the
TreeCellRenderer
that is rendering each cell
setCellRenderer
@BeanProperty(description="The TreeCellRenderer that will be used to draw each cell.") public void setCellRenderer(TreeCellRenderer x)
Sets the TreeCellRenderer
that will be used to draw each cell.
This is a bound property.
- Parameters:
-
x
- theTreeCellRenderer
that is to render each cell
setEditable
@BeanProperty(description="Whether the tree is editable.") 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.
This is a bound property.
- Parameters:
-
flag
- a boolean value, true if the tree is editable
isEditable
public boolean isEditable()
Returns true if the tree is editable.
- Returns:
- true if the tree is editable
setCellEditor
@BeanProperty(description="The cell editor. A null value implies the tree cannot be edited.") 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.
- Parameters:
-
cellEditor
- theTreeCellEditor
to use
getCellEditor
public TreeCellEditor getCellEditor()
Returns the editor used to edit entries in the tree.
- Returns:
- the
TreeCellEditor
in use, ornull
if the tree cannot be edited
getModel
public TreeModel getModel()
Returns the TreeModel
that is providing the data.
- Returns:
- the
TreeModel
that is providing the data
setModel
@BeanProperty(description="The TreeModel that will provide the data.") public void setModel(TreeModel newModel)
Sets the TreeModel
that will provide the data.
This is a bound property.
- Parameters:
-
newModel
- theTreeModel
that is to provide the data
isRootVisible
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:
rootVisible
setRootVisible
@BeanProperty(description="Whether or not the root node from the TreeModel is visible.") public void setRootVisible(boolean rootVisible)
Determines whether or not the root node from the TreeModel
is visible.
This is a bound property.
- Parameters:
-
rootVisible
- true if the root node of the tree is to be displayed - See Also:
rootVisible
setShowsRootHandles
@BeanProperty(description="Whether the node handles are to be displayed.") 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.
This is a bound property.
- Parameters:
-
newValue
-true
if root handles should be displayed; otherwise,false
- See Also:
-
showsRootHandles
,getShowsRootHandles()
getShowsRootHandles
public boolean getShowsRootHandles()
Returns the value of the showsRootHandles
property.
- Returns:
- the value of the
showsRootHandles
property - See Also:
showsRootHandles
setRowHeight
@BeanProperty(description="The height of each cell.") 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.
This is a bound property.
- Parameters:
-
rowHeight
- the height of each cell, in pixels
getRowHeight
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.
- Returns:
- the height of each row
isFixedRowHeight
@BeanProperty(bound=false) 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
setLargeModel
@BeanProperty(description="Whether the UI should use a large model.") 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.
- Parameters:
-
newValue
- true to suggest a large model to the UI - See Also:
largeModel
isLargeModel
public boolean isLargeModel()
Returns true if the tree is configured for a large model.
- Returns:
- true if a large model is suggested
- See Also:
largeModel
setInvokesStopCellEditing
@BeanProperty(description="Determines what happens when editing is interrupted, selecting another node in the tree, a change in the tree\'s data, or some other means.") 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 thatstopCellEditing
is invoked when editing is interrupted, and data is saved; false means thatcancelCellEditing
is invoked, and changes are lost
getInvokesStopCellEditing
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:
setInvokesStopCellEditing(boolean)
setScrollsOnExpand
@BeanProperty(description="Indicates if a node descendant should be scrolled when expanded.") 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.
- Parameters:
-
newValue
-false
to disable scrolling on expansion;true
to enable it - See Also:
getScrollsOnExpand()
getScrollsOnExpand
public boolean getScrollsOnExpand()
Returns the value of the scrollsOnExpand
property.
- Returns:
- the value of the
scrollsOnExpand
property
setToggleClickCount
@BeanProperty(description="Number of clicks before a node will expand/collapse.") public 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.
- Parameters:
-
clickCount
- the number of mouse clicks to get a node expanded or closed - Since:
- 1.3
getToggleClickCount
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
- Since:
- 1.3
setExpandsSelectedPaths
@BeanProperty(description="Indicates whether changes to the selection should make the parent of the path visible.") 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 TreePath
s 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.
- Parameters:
-
newValue
- the new value forexpandsSelectedPaths
- Since:
- 1.3
getExpandsSelectedPaths
public boolean getExpandsSelectedPaths()
Returns the expandsSelectedPaths
property.
- Returns:
- true if selection changes result in the parent path being expanded
- Since:
- 1.3
- See Also:
setExpandsSelectedPaths(boolean)
setDragEnabled
@BeanProperty(bound=false, description="determines whether automatic drag handling is enabled") 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
- ifb
istrue
andGraphicsEnvironment.isHeadless()
returnstrue
- Since:
- 1.4
- See Also:
-
GraphicsEnvironment.isHeadless()
,getDragEnabled()
,JComponent.setTransferHandler(javax.swing.TransferHandler)
,TransferHandler
getDragEnabled
public boolean getDragEnabled()
Returns whether or not automatic drag handling is enabled.
- Returns:
- the value of the
dragEnabled
property - Since:
- 1.4
- See Also:
setDragEnabled(boolean)
setDropMode
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 ornull
- Since:
- 1.6
- See Also:
-
getDropMode()
,getDropLocation()
,JComponent.setTransferHandler(javax.swing.TransferHandler)
,TransferHandler
getDropMode
public final DropMode getDropMode()
Returns the drop mode for this component.
- Returns:
- the drop mode for this component
- Since:
- 1.6
- See Also:
setDropMode(javax.swing.DropMode)
getDropLocation
@BeanProperty(bound=false) 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
- Since:
- 1.6
- See Also:
-
setDropMode(javax.swing.DropMode)
,TransferHandler.canImport(TransferHandler.TransferSupport)
isPathEditable
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.
- Parameters:
-
path
- aTreePath
identifying a node - Returns:
- true if every parent node and the node itself is editable
- See Also:
isEditable()
getToolTipText
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!
- Overrides:
-
getToolTipText
in classJComponent
- Parameters:
-
event
- theMouseEvent
that initiated theToolTip
display - Returns:
- a string containing the tooltip or
null
ifevent
is null
convertValueToText
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
- theObject
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
getRowCount
@BeanProperty(bound=false) public 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.
- Returns:
- the number of viewable nodes
setSelectionPath
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
- theTreePath
specifying the node to select
setSelectionPaths
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 ofTreePath
objects that specifies the nodes to select
setLeadSelectionPath
@BeanProperty(description="Lead selection path") 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.
This is a bound property.
- Parameters:
-
newPath
- the new lead path - Since:
- 1.3
setAnchorSelectionPath
@BeanProperty(description="Anchor selection path") 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.
This is a bound property.
- Parameters:
-
newPath
- the new anchor path - Since:
- 1.3
setSelectionRow
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
setSelectionRows
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
addSelectionPath
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
- theTreePath
to add
addSelectionPaths
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 ofTreePath
objects that specifies the nodes to add
addSelectionRow
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
addSelectionRows
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
getLastSelectedPathComponent
@BeanProperty(bound=false) public 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.
- Returns:
- the last path component of the selected path, or
null
if nothing is selected - See Also:
TreePath.getLastPathComponent()
getLeadSelectionPath
public TreePath getLeadSelectionPath()
Returns the path identified as the lead.
- Returns:
- path identified as the lead
getAnchorSelectionPath
public TreePath getAnchorSelectionPath()
Returns the path identified as the anchor.
- Returns:
- path identified as the anchor
- Since:
- 1.3
getSelectionPath
public TreePath getSelectionPath()
Returns the path to the first selected node.
- Returns:
- the
TreePath
for the first selected node, ornull
if nothing is currently selected
getSelectionPaths
public TreePath[] getSelectionPaths()
Returns the paths of all selected values.
- Returns:
- an array of
TreePath
objects indicating the selected nodes, ornull
if nothing is currently selected
getSelectionRows
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
getSelectionCount
@BeanProperty(bound=false) public int getSelectionCount()
Returns the number of nodes selected.
- Returns:
- the number of nodes selected
getMinSelectionRow
@BeanProperty(bound=false) public int getMinSelectionRow()
Returns the smallest selected row. If the selection is empty, or none of the selected paths are viewable, -1
is returned.
- Returns:
- the smallest selected row
getMaxSelectionRow
@BeanProperty(bound=false) public int getMaxSelectionRow()
Returns the largest selected row. If the selection is empty, or none of the selected paths are viewable, -1
is returned.
- Returns:
- the largest selected row
getLeadSelectionRow
@BeanProperty(bound=false) 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
isnull
isPathSelected
public boolean isPathSelected(TreePath path)
Returns true if the item identified by the path is currently selected.
- Parameters:
-
path
- aTreePath
identifying a node - Returns:
- true if the node is selected
isRowSelected
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
getExpandedDescendants
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 ofparent
, ornull
ifparent
is not currently expanded
hasBeenExpanded
public boolean hasBeenExpanded(TreePath path)
Returns true if the node identified by the path has ever been expanded.
- Parameters:
-
path
- aTreePath
identifying a node - Returns:
- true if the
path
has ever been expanded
isExpanded
public boolean isExpanded(TreePath path)
Returns true if the node identified by the path is currently expanded,
- Parameters:
-
path
- theTreePath
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
isExpanded
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
isCollapsed
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
- theTreePath
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
isCollapsed
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
makeVisible
public void makeVisible(TreePath path)
Ensures that the node identified by path is currently viewable.
- Parameters:
-
path
- theTreePath
to make visible
isVisible
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.
- Parameters:
-
path
-TreePath
identifying a node - Returns:
- true if the node is viewable, otherwise false
getPathBounds
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
- theTreePath
identifying the node - Returns:
- the
Rectangle
the node is drawn in, ornull
getRowBounds
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
scrollPathToVisible
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
- theTreePath
identifying the node to bring into view
scrollRowToVisible
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
getPathForRow
@BeanProperty(bound=false) public 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.
- Parameters:
-
row
- an integer specifying a row - Returns:
- the
TreePath
to the specified node,null
ifrow < 0
orrow >= getRowCount()
getRowForPath
public int getRowForPath(TreePath path)
Returns the row that displays the node identified by the specified path.
- Parameters:
-
path
- theTreePath
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.
expandPath
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
- theTreePath
identifying a node
expandRow
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
collapsePath
public void collapsePath(TreePath path)
Ensures that the node identified by the specified path is collapsed and viewable.
- Parameters:
-
path
- theTreePath
identifying a node
collapseRow
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
getPathForLocation
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
getRowForLocation
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:
getClosestRowForLocation(int, int)
getClosestPathForLocation
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:
-
getPathForLocation(int, int)
,getPathBounds(javax.swing.tree.TreePath)
getClosestRowForLocation
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:
-
getRowForLocation(int, int)
,getRowBounds(int)
isEditing
@BeanProperty(bound=false) 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:
getSelectionPath()
stopEditing
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)
.
- Returns:
- true if editing was in progress and is now stopped, false if editing was not in progress
cancelEditing
public void cancelEditing()
Cancels the current editing session. Has no effect if the tree isn't being edited.
startEditingAtPath
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
- theTreePath
identifying a node
getEditingPath
@BeanProperty(bound=false) public TreePath getEditingPath()
Returns the path to the element that is currently being edited.
- Returns:
- the
TreePath
for the node being edited
setSelectionModel
@BeanProperty(description="The tree\'s selection model.") 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.
This is a bound property.
- Parameters:
-
selectionModel
- theTreeSelectionModel
to use, ornull
to disable selections - See Also:
TreeSelectionModel
getSelectionModel
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.
- Returns:
- the model for selections
- See Also:
setSelectionModel(javax.swing.tree.TreeSelectionModel)
getPathBetweenRows
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.
- Parameters:
-
index0
- the first index in the range -
index1
- the last index in the range - Returns:
- the paths (inclusive) between the specified row indices
setSelectionInterval
public 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)
.
- Parameters:
-
index0
- the first index in the range to select -
index1
- the last index in the range to select
addSelectionInterval
public 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)
.
- Parameters:
-
index0
- the first index in the range to add to the selection -
index1
- the last index in the range to add to the selection
removeSelectionInterval
public 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)
.
- Parameters:
-
index0
- the first row to remove from the selection -
index1
- the last row to remove from the selection
removeSelectionPath
public void removeSelectionPath(TreePath path)
Removes the node identified by the specified path from the current selection.
- Parameters:
-
path
- theTreePath
identifying a node
removeSelectionPaths
public void removeSelectionPaths(TreePath[] paths)
Removes the nodes identified by the specified paths from the current selection.
- Parameters:
-
paths
- an array ofTreePath
objects that specifies the nodes to remove
removeSelectionRow
public void removeSelectionRow(int row)
Removes the row at the index row
from the current selection.
- Parameters:
-
row
- the row to remove
removeSelectionRows
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
clearSelection
public void clearSelection()
Clears the selection.
isSelectionEmpty
@BeanProperty(bound=false) public boolean isSelectionEmpty()
Returns true if the selection is currently empty.
- Returns:
- true if the selection is currently empty
addTreeExpansionListener
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")
removeTreeExpansionListener
public void removeTreeExpansionListener(TreeExpansionListener tel)
Removes a listener for TreeExpansion
events.
- Parameters:
-
tel
- theTreeExpansionListener
to remove
getTreeExpansionListeners
@BeanProperty(bound=false) public TreeExpansionListener[] getTreeExpansionListeners()
Returns an array of all the TreeExpansionListener
s added to this JTree with addTreeExpansionListener().
- Returns:
- all of the
TreeExpansionListener
s added or an empty array if no listeners have been added - Since:
- 1.4
addTreeWillExpandListener
public void addTreeWillExpandListener(TreeWillExpandListener tel)
Adds a listener for TreeWillExpand
events.
- Parameters:
-
tel
- aTreeWillExpandListener
that will be notified when a tree node will be expanded or collapsed (a "negative expansion")
removeTreeWillExpandListener
public void removeTreeWillExpandListener(TreeWillExpandListener tel)
Removes a listener for TreeWillExpand
events.
- Parameters:
-
tel
- theTreeWillExpandListener
to remove
getTreeWillExpandListeners
@BeanProperty(bound=false) public TreeWillExpandListener[] getTreeWillExpandListeners()
Returns an array of all the TreeWillExpandListener
s added to this JTree with addTreeWillExpandListener().
- Returns:
- all of the
TreeWillExpandListener
s added or an empty array if no listeners have been added - Since:
- 1.4
fireTreeExpanded
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
- theTreePath
indicating the node that was expanded - See Also:
EventListenerList
fireTreeCollapsed
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
- theTreePath
indicating the node that was collapsed - See Also:
EventListenerList
fireTreeWillExpand
public 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.
- Parameters:
-
path
- theTreePath
indicating the node that was expanded - Throws:
-
ExpandVetoException
- if the expansion is prevented from occurring - See Also:
EventListenerList
fireTreeWillCollapse
public 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.
- Parameters:
-
path
- theTreePath
indicating the node that was expanded - Throws:
-
ExpandVetoException
- if the collapse is prevented from occurring - See Also:
EventListenerList
addTreeSelectionListener
public void addTreeSelectionListener(TreeSelectionListener tsl)
Adds a listener for TreeSelection
events.
- Parameters:
-
tsl
- theTreeSelectionListener
that will be notified when a node is selected or deselected (a "negative selection")
removeTreeSelectionListener
public void removeTreeSelectionListener(TreeSelectionListener tsl)
Removes a TreeSelection
listener.
- Parameters:
-
tsl
- theTreeSelectionListener
to remove
getTreeSelectionListeners
@BeanProperty(bound=false) public TreeSelectionListener[] getTreeSelectionListeners()
Returns an array of all the TreeSelectionListener
s added to this JTree with addTreeSelectionListener().
- Returns:
- all of the
TreeSelectionListener
s added or an empty array if no listeners have been added - Since:
- 1.4
fireValueChanged
protected void fireValueChanged(TreeSelectionEvent e)
Notifies all listeners that have registered interest for notification on this event type.
- Parameters:
-
e
- theTreeSelectionEvent
to be fired; generated by theTreeSelectionModel
when a node is selected or deselected - See Also:
EventListenerList
treeDidChange
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.
setVisibleRowCount
@BeanProperty(description="The number of rows that are to be displayed.") 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.
- Parameters:
-
newCount
- the number of rows to display
getVisibleRowCount
public int getVisibleRowCount()
Returns the number of rows that are displayed in the display area.
- Returns:
- the number of rows displayed
getNextMatch
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 - Since:
- 1.4
getPreferredScrollableViewportSize
@BeanProperty(bound=false) 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.
- Specified by:
-
getPreferredScrollableViewportSize
in interfaceScrollable
- Returns:
- a
Dimension
object containing the preferred size - See Also:
JComponent.getPreferredSize()
getScrollableUnitIncrement
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.
- Specified by:
-
getScrollableUnitIncrement
in interfaceScrollable
- Parameters:
-
visibleRect
- the view area visible within the viewport -
orientation
- eitherSwingConstants.VERTICAL
orSwingConstants.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:
JScrollBar.setUnitIncrement(int)
getScrollableBlockIncrement
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
.
- Specified by:
-
getScrollableBlockIncrement
in interfaceScrollable
- Parameters:
-
visibleRect
- the view area visible within the viewport -
orientation
- eitherSwingConstants.VERTICAL
orSwingConstants.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:
JScrollBar.setBlockIncrement(int)
getScrollableTracksViewportWidth
@BeanProperty(bound=false) 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.
- Specified by:
-
getScrollableTracksViewportWidth
in interfaceScrollable
- Returns:
- whether the tree should track the width of the viewport
- See Also:
Scrollable.getScrollableTracksViewportWidth()
getScrollableTracksViewportHeight
@BeanProperty(bound=false) 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.
- Specified by:
-
getScrollableTracksViewportHeight
in interfaceScrollable
- Returns:
- whether the tree should track the height of the viewport
- See Also:
Scrollable.getScrollableTracksViewportHeight()
setExpandedState
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.
- Parameters:
-
path
- aTreePath
identifying a node -
state
- iftrue
, all parents of @{code path} and path are marked as expanded. Otherwise, all parents ofpath
are marked EXPANDED, butpath
itself is marked collapsed.
getDescendantToggledPaths
protected Enumeration<TreePath> getDescendantToggledPaths(TreePath parent)
Returns an Enumeration
of TreePaths
that have been expanded that are descendants of parent
.
- Parameters:
-
parent
- a path - Returns:
- the
Enumeration
ofTreePaths
removeDescendantToggledPaths
protected void removeDescendantToggledPaths(Enumeration<TreePath> toRemove)
Removes any descendants of the TreePaths
in toRemove
that have been expanded.
- Parameters:
-
toRemove
- an enumeration of the paths to remove; a value ofnull
is ignored - Throws:
-
ClassCastException
- iftoRemove
contains an element that is not aTreePath
;null
values are ignored
clearToggledPaths
protected void clearToggledPaths()
Clears the cache of toggled tree paths. This does NOT send out any TreeExpansionListener
events.
createTreeModelListener
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.
- Returns:
- the instance of
TreeModelHandler
removeDescendantSelectedPaths
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.
- Parameters:
-
path
- a path -
includePath
- istrue
andpath
is selected, it will be removed from the selection. - Returns:
- true if a descendant was selected
- Since:
- 1.3
paramString
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
.
- Overrides:
-
paramString
in classJComponent
- Returns:
- a string representation of this
JTree
.
getAccessibleContext
@BeanProperty(bound=false) 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.
- Specified by:
-
getAccessibleContext
in interfaceAccessible
- Overrides:
-
getAccessibleContext
in classComponent
- Returns:
- an AccessibleJTree that serves as the AccessibleContext of this JTree