Class JTree
- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,Accessible,Scrollable
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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classThis class implements accessibility support for theJTreeclass.static final classA subclass ofTransferHandler.DropLocationrepresenting a drop location for aJTree.static classDynamicUtilTreeNodecan wrap vectors/hashtables/arrays/strings and create the appropriate children tree nodes as necessary.protected static classEmptySelectionModelis aTreeSelectionModelthat does not allow anything to be selected.protected classListens to the model and updates theexpandedStateaccordingly when nodes are removed, or changed.protected classHandles creating a newTreeSelectionEventwith theJTreeas the source and passing it off to all the listeners.Nested classes/interfaces declared in class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces declared in class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces declared in class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringBound property name for anchor selection path.static final StringBound property name forcellEditor.static final StringBound property name forcellRenderer.protected TreeCellEditorEditor for the entries.protected TreeCellRendererThe cell used to draw nodes.protected booleanIs the tree editable?static final StringBound property name foreditable.static final StringBound property name for expands selected paths propertystatic final StringBound property name formessagesStopCellEditing.protected booleanIf true, when editing is to be stopped by way of selection changing, data in tree changing or other meansstopCellEditingis invoked, and changes are saved.static final StringBound property name forlargeModel.protected booleanIs this tree a large model?static final StringBound property name forleadSelectionPath.static final StringBound property name forrootVisible.protected booleanTrue if the root node is displayed, false if its children are the highest visible nodes.static final StringBound property name forrowHeight.protected intHeight to use for each display row.static final StringBound property name forscrollsOnExpand.protected booleanIf true, when a node is expanded, as many of the descendants are scrolled to be visible.static final StringBound property name for selectionModel.protected TreeSelectionModelModels the set of selected nodes in this tree.protected JTree.TreeSelectionRedirectorCreates a new event and passed it off theselectionListeners.static final StringBound property name forshowsRootHandles.protected booleanTrue if handles are displayed at the topmost level of the tree.static final StringBound property name fortoggleClickCount.protected intNumber of mouse clicks before a node is expanded.static final StringBound property name fortreeModel.protected TreeModelThe model that defines the tree displayed by this object.protected TreeModelListenerUpdates theexpandedState.static final StringBound property name forvisibleRowCount.protected intNumber 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_WINDOWFields declared in class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields declared in interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionJTree()Returns aJTreewith a sample model.Returns aJTreewith each element of the specified array as the child of a new root node which is not displayed.Returns aJTreecreated from aHashtablewhich does not display with root.Returns aJTreewith each element of the specifiedVectoras the child of a new root node which is not displayed.Returns an instance ofJTreewhich displays the root node -- the tree is created using the specified data model.Returns aJTreewith the specifiedTreeNodeas its root, which displays the root node.Returns aJTreewith the specifiedTreeNodeas its root, which displays the root node and which decides whether a node is a leaf node in the specified manner. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddSelectionInterval(int index0, int index1) Adds the specified rows (inclusive) to the selection.voidaddSelectionPath(TreePath path) Adds the node identified by the specifiedTreePathto the current selection.voidaddSelectionPaths(TreePath[] paths) Adds each path in the array of paths to the current selection.voidaddSelectionRow(int row) Adds the path at the specified row to the current selection.voidaddSelectionRows(int[] rows) Adds the paths at each of the specified rows to the current selection.voidAdds a listener forTreeExpansionevents.voidAdds a listener forTreeSelectionevents.voidAdds a listener forTreeWillExpandevents.voidCancels the current editing session.voidClears the selection.protected voidClears the cache of toggled tree paths.voidcollapsePath(TreePath path) Ensures that the node identified by the specified path is collapsed and viewable.voidcollapseRow(int row) Ensures that the node in the specified row is collapsed.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 TreeModelcreateTreeModel(Object value) Returns aTreeModelwrapping the specified object.protected TreeModelListenerCreates and returns an instance ofTreeModelHandler.voidexpandPath(TreePath path) Ensures that the node identified by the specified path is expanded and viewable.voidexpandRow(int row) Ensures that the node in the specified row is expanded and viewable.voidfireTreeCollapsed(TreePath path) Notifies all listeners that have registered interest for notification on this event type.voidfireTreeExpanded(TreePath path) Notifies all listeners that have registered interest for notification on this event type.voidfireTreeWillCollapse(TreePath path) Notifies all listeners that have registered interest for notification on this event type.voidfireTreeWillExpand(TreePath path) Notifies all listeners that have registered interest for notification on this event type.protected voidNotifies all listeners that have registered interest for notification on this event type.Gets the AccessibleContext associated with this JTree.Returns the path identified as the anchor.Returns the editor used to edit entries in the tree.Returns the currentTreeCellRendererthat is rendering each cell.getClosestPathForLocation(int x, int y) Returns the path to the node that is closest to x,y.intgetClosestRowForLocation(int x, int y) Returns the row to the node that is closest to x,y.protected static TreeModelCreates and returns a sampleTreeModel.protected Enumeration<TreePath> getDescendantToggledPaths(TreePath parent) Returns anEnumerationofTreePathsthat have been expanded that are descendants ofparent.booleanReturns whether or not automatic drag handling is enabled.final JTree.DropLocationReturns the location that this component should visually indicate as the drop location during a DnD operation over the component, ornullif no location is to currently be shown.final DropModeReturns the drop mode for this component.Returns the path to the element that is currently being edited.getExpandedDescendants(TreePath parent) Returns anEnumerationof the descendants of the pathparentthat are currently expanded.booleanReturns theexpandsSelectedPathsproperty.booleanReturns the indicator that tells what happens when editing is interrupted.Returns the last path component of the selected path.Returns the path identified as the lead.intReturns the row index corresponding to the lead path.intReturns the largest selected row.intReturns the smallest selected row.getModel()Returns theTreeModelthat is providing the data.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.getPathBounds(TreePath path) Returns theRectanglethat the specified node will be drawn into.getPathForLocation(int x, int y) Returns the path for the node at the specified location.getPathForRow(int row) Returns the path for the specified row.Returns the preferred display size of aJTree.getRowBounds(int row) Returns theRectanglethat the node at the specified row is drawn in.intReturns the number of viewable nodes.intgetRowForLocation(int x, int y) Returns the row for the specified location.intgetRowForPath(TreePath path) Returns the row that displays the node identified by the specified path.intReturns the height of each row.intgetScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction) Returns the amount for a block increment, which is the height or width ofvisibleRect, based onorientation.booleanReturns 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.booleanReturns 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.intgetScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) Returns the amount to increment when scrolling.booleanReturns the value of thescrollsOnExpandproperty.intReturns the number of nodes selected.Returns the model for selections.Returns the path to the first selected node.TreePath[]Returns the paths of all selected values.int[]Returns all of the currently selected rows.booleanReturns the value of theshowsRootHandlesproperty.intReturns the number of mouse clicks needed to expand or close a node.getToolTipText(MouseEvent event) OverridesJComponent'sgetToolTipTextmethod in order to allow renderer's tips to be used if it has text set.Returns an array of all theTreeExpansionListeners added to this JTree with addTreeExpansionListener().Returns an array of all theTreeSelectionListeners added to this JTree with addTreeSelectionListener().Returns an array of all theTreeWillExpandListeners added to this JTree with addTreeWillExpandListener().getUI()Returns the L&F object that renders this component.Returns the name of the L&F class that renders this component.intReturns the number of rows that are displayed in the display area.booleanhasBeenExpanded(TreePath path) Returns true if the node identified by the path has ever been expanded.booleanisCollapsed(int row) Returns true if the node at the specified display row is collapsed.booleanisCollapsed(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.booleanReturns true if the tree is editable.booleanReturns true if the tree is being edited.booleanisExpanded(int row) Returns true if the node at the specified display row is currently expanded.booleanisExpanded(TreePath path) Returns true if the node identified by the path is currently expanded,booleanReturns true if the height of each display row is a fixed size.booleanReturns true if the tree is configured for a large model.booleanisPathEditable(TreePath path) ReturnsisEditable.booleanisPathSelected(TreePath path) Returns true if the item identified by the path is currently selected.booleanReturns true if the root node of the tree is displayed.booleanisRowSelected(int row) Returns true if the node identified by row is selected.booleanReturns true if the selection is currently empty.booleanReturns true if the value identified by path is currently viewable, which means it is either the root or all of its parents are expanded.voidmakeVisible(TreePath path) Ensures that the node identified by path is currently viewable.protected StringReturns a string representation of thisJTree.protected booleanremoveDescendantSelectedPaths(TreePath path, boolean includePath) Removes any paths in the selection that are descendants ofpath.protected voidremoveDescendantToggledPaths(Enumeration<TreePath> toRemove) Removes any descendants of theTreePathsintoRemovethat have been expanded.voidremoveSelectionInterval(int index0, int index1) Removes the specified rows (inclusive) from the selection.voidremoveSelectionPath(TreePath path) Removes the node identified by the specified path from the current selection.voidremoveSelectionPaths(TreePath[] paths) Removes the nodes identified by the specified paths from the current selection.voidremoveSelectionRow(int row) Removes the row at the indexrowfrom the current selection.voidremoveSelectionRows(int[] rows) Removes the rows that are selected at each of the specified rows.voidRemoves a listener forTreeExpansionevents.voidRemoves aTreeSelectionlistener.voidRemoves a listener forTreeWillExpandevents.voidscrollPathToVisible(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.voidscrollRowToVisible(int row) Scrolls the item identified by row until it is displayed.voidsetAnchorSelectionPath(TreePath newPath) Sets the path identified as the anchor.voidsetCellEditor(TreeCellEditor cellEditor) Sets the cell editor.voidSets theTreeCellRendererthat will be used to draw each cell.voidsetDragEnabled(boolean b) Turns on or off automatic drag handling.final voidsetDropMode(DropMode dropMode) Sets the drop mode for this component.voidsetEditable(boolean flag) Determines whether the tree is editable.protected voidsetExpandedState(TreePath path, boolean state) Sets the expanded state of thisJTree.voidsetExpandsSelectedPaths(boolean newValue) Configures theexpandsSelectedPathsproperty.voidsetInvokesStopCellEditing(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.voidsetLargeModel(boolean newValue) Specifies whether the UI should use a large model.voidsetLeadSelectionPath(TreePath newPath) Sets the path identifies as the lead.voidSets theTreeModelthat will provide the data.voidsetRootVisible(boolean rootVisible) Determines whether or not the root node from theTreeModelis visible.voidsetRowHeight(int rowHeight) Sets the height of each cell, in pixels.voidsetScrollsOnExpand(boolean newValue) Sets thescrollsOnExpandproperty, which determines whether the tree might scroll to show previously hidden children.voidsetSelectionInterval(int index0, int index1) Selects the rows in the specified interval (inclusive).voidsetSelectionModel(TreeSelectionModel selectionModel) Sets the tree's selection model.voidsetSelectionPath(TreePath path) Selects the node identified by the specified path.voidsetSelectionPaths(TreePath[] paths) Selects the nodes identified by the specified array of paths.voidsetSelectionRow(int row) Selects the node at the specified row in the display.voidsetSelectionRows(int[] rows) Selects the nodes corresponding to each of the specified rows in the display.voidsetShowsRootHandles(boolean newValue) Sets the value of theshowsRootHandlesproperty, which specifies whether the node handles should be displayed.voidsetToggleClickCount(int clickCount) Sets the number of mouse clicks before a node will expand or close.voidSets the L&F object that renders this component.voidsetVisibleRowCount(int newCount) Sets the number of rows that are to be displayed.voidstartEditingAtPath(TreePath path) Selects the node identified by the specified path and initiates editing.booleanEnds the current editing session.voidSent 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).voidupdateUI()Notification from theUIManagerthat the L&F has changed.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, hide, 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, updateMethods 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, validateTreeMethods 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, 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
-
Field Details
-
treeModel
The model that defines the tree displayed by this object. -
selectionModel
Models the set of selected nodes in this tree. -
rootVisible
protected boolean rootVisibleTrue if the root node is displayed, false if its children are the highest visible nodes. -
cellRenderer
The cell used to draw nodes. Ifnull, the UI uses a defaultcellRenderer. -
rowHeight
protected int rowHeightHeight to use for each display row. If this is <= 0 the renderer determines the height for each row. -
showsRootHandles
protected boolean showsRootHandlesTrue 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
rootVisiblesetting 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:
-
selectionRedirector
Creates a new event and passed it off theselectionListeners. -
cellEditor
Editor for the entries. Default isnull(tree is not editable). -
editable
protected boolean editableIs the tree editable? Default is false. -
largeModel
protected boolean largeModelIs 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 visibleRowCountNumber of rows to make visible at one time. This value is used for theScrollableinterface. It determines the preferred size of the display area. -
invokesStopCellEditing
protected boolean invokesStopCellEditingIf true, when editing is to be stopped by way of selection changing, data in tree changing or other meansstopCellEditingis invoked, and changes are saved. If false,cancelCellEditingis invoked, and changes are discarded. Default is false. -
scrollsOnExpand
protected boolean scrollsOnExpandIf true, when a node is expanded, as many of the descendants are scrolled to be visible. -
toggleClickCount
protected int toggleClickCountNumber of mouse clicks before a node is expanded. -
treeModelListener
Updates theexpandedState. -
CELL_RENDERER_PROPERTY
-
TREE_MODEL_PROPERTY
-
ROOT_VISIBLE_PROPERTY
-
SHOWS_ROOT_HANDLES_PROPERTY
Bound property name forshowsRootHandles.- See Also:
-
ROW_HEIGHT_PROPERTY
-
CELL_EDITOR_PROPERTY
-
EDITABLE_PROPERTY
-
LARGE_MODEL_PROPERTY
-
SELECTION_MODEL_PROPERTY
Bound property name for selectionModel.- See Also:
-
VISIBLE_ROW_COUNT_PROPERTY
Bound property name forvisibleRowCount.- See Also:
-
INVOKES_STOP_CELL_EDITING_PROPERTY
Bound property name formessagesStopCellEditing.- See Also:
-
SCROLLS_ON_EXPAND_PROPERTY
Bound property name forscrollsOnExpand.- See Also:
-
TOGGLE_CLICK_COUNT_PROPERTY
Bound property name fortoggleClickCount.- See Also:
-
LEAD_SELECTION_PATH_PROPERTY
Bound property name forleadSelectionPath.- Since:
- 1.3
- See Also:
-
ANCHOR_SELECTION_PATH_PROPERTY
Bound property name for anchor selection path.- Since:
- 1.3
- See Also:
-
EXPANDS_SELECTED_PATHS_PROPERTY
Bound property name for expands selected paths property- Since:
- 1.3
- See Also:
-
-
Constructor Details
-
JTree
public JTree()Returns aJTreewith a sample model. The default model used by the tree defines a leaf node as any node without children.- See Also:
-
JTree
Returns aJTreewith 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 ofObjects- See Also:
-
JTree
Returns aJTreewith each element of the specifiedVectoras 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:
-
JTree
Returns aJTreecreated from aHashtablewhich does not display with root. Each value-half of the key/value pairs in theHashTablebecomes 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:
-
JTree
Returns aJTreewith the specifiedTreeNodeas its root, which displays the root node. By default, the tree defines a leaf node as any node without children.- Parameters:
root- aTreeNodeobject- See Also:
-
JTree
Returns aJTreewith the specifiedTreeNodeas its root, which displays the root node and which decides whether a node is a leaf node in the specified manner.- Parameters:
root- aTreeNodeobjectasksAllowsChildren- if false, any node without children is a leaf node; if true, only nodes that do not allow children are leaf nodes- See Also:
-
JTree
Returns an instance ofJTreewhich displays the root node -- the tree is created using the specified data model.- Parameters:
newModel- theTreeModelto use as the data model
-
-
Method Details
-
getDefaultTreeModel
Creates and returns a sampleTreeModel. Used primarily for beanbuilders to show something interesting.- Returns:
- the default
TreeModel
-
createTreeModel
Returns aTreeModelwrapping the specified object. If the object is:- an array of
Objects, - a
Hashtable, or - a
Vector
"root".- Parameters:
value- theObjectused as the foundation for theTreeModel- Returns:
- a
TreeModelwrapping the specified object
- an array of
-
getUI
Returns the L&F object that renders this component.- Overrides:
getUIin classJComponent- Returns:
- the
TreeUIobject 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- theTreeUIL&F object- See Also:
-
updateUI
public void updateUI()Notification from theUIManagerthat the L&F has changed. Replaces the current UI object with the latest version from theUIManager.- Overrides:
updateUIin classJComponent- See Also:
-
getUIClassID
Returns the name of the L&F class that renders this component.- Overrides:
getUIClassIDin classJComponent- Returns:
- the string "TreeUI"
- See Also:
-
getCellRenderer
Returns the currentTreeCellRendererthat is rendering each cell.- Returns:
- the
TreeCellRendererthat is rendering each cell
-
setCellRenderer
@BeanProperty(description="The TreeCellRenderer that will be used to draw each cell.") public void setCellRenderer(TreeCellRenderer x) Sets theTreeCellRendererthat will be used to draw each cell.This is a bound property.
- Parameters:
x- theTreeCellRendererthat is to render each cell
-
setEditable
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. Anullvalue implies that the tree cannot be edited. If this represents a change in thecellEditor, thepropertyChangemethod is invoked on all listeners.This is a bound property.
- Parameters:
cellEditor- theTreeCellEditorto use
-
getCellEditor
Returns the editor used to edit entries in the tree.- Returns:
- the
TreeCellEditorin use, ornullif the tree cannot be edited
-
getModel
Returns theTreeModelthat is providing the data.- Returns:
- the
TreeModelthat is providing the data
-
setModel
@BeanProperty(description="The TreeModel that will provide the data.") public void setModel(TreeModel newModel) Sets theTreeModelthat will provide the data.This is a bound property.
- Parameters:
newModel- theTreeModelthat 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:
-
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 theTreeModelis visible.This is a bound property.
- Parameters:
rootVisible- true if the root node of the tree is to be displayed- See Also:
-
setShowsRootHandles
@BeanProperty(description="Whether the node handles are to be displayed.") public void setShowsRootHandles(boolean newValue) Sets the value of theshowsRootHandlesproperty, which specifies whether the node handles should be displayed. The default value of this property depends on the constructor used to create theJTree. Some look and feels might not support handles; they will ignore this property.This is a bound property.
- Parameters:
newValue-trueif root handles should be displayed; otherwise,false- See Also:
-
getShowsRootHandles
public boolean getShowsRootHandles()Returns the value of theshowsRootHandlesproperty.- Returns:
- the value of the
showsRootHandlesproperty - See Also:
-
setRowHeight
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
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:
-
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:
-
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 totruecauses 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 thatstopCellEditingis invoked when editing is interrupted, and data is saved; false means thatcancelCellEditingis 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:
-
setScrollsOnExpand
@BeanProperty(description="Indicates if a node descendant should be scrolled when expanded.") public void setScrollsOnExpand(boolean newValue) Sets thescrollsOnExpandproperty, which determines whether the tree might scroll to show previously hidden children. If this property istrue(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-falseto disable scrolling on expansion;trueto enable it- See Also:
-
getScrollsOnExpand
public boolean getScrollsOnExpand()Returns the value of thescrollsOnExpandproperty.- Returns:
- the value of the
scrollsOnExpandproperty
-
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 theexpandsSelectedPathsproperty. If true, any time the selection is changed, either via theTreeSelectionModel, or the cover methods provided byJTree, theTreePaths parents will be expanded to make them visible (visible meaning the parent path is expanded, not necessarily in the visible rectangle of theJTree). 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 theexpandsSelectedPathsproperty.- Returns:
- true if selection changes result in the parent path being expanded
- Since:
- 1.3
- See Also:
-
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 totrue, and the tree'sTransferHandlerneeds to benon-null. The default value of thedragEnabledproperty isfalse.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 subclassBasicLookAndFeel) 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 totruecan 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
exportAsDragon the tree'sTransferHandler.- Parameters:
b- whether or not to enable automatic drag handling- Throws:
HeadlessException- ifbistrueandGraphicsEnvironment.isHeadless()returnstrue- Since:
- 1.4
- See Also:
-
getDragEnabled
public boolean getDragEnabled()Returns whether or not automatic drag handling is enabled.- Returns:
- the value of the
dragEnabledproperty - Since:
- 1.4
- See Also:
-
setDropMode
Sets the drop mode for this component. For backward compatibility, the default for this property isDropMode.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.JTreesupports the following drop modes:DropMode.USE_SELECTIONDropMode.ONDropMode.INSERTDropMode.ON_OR_INSERT
The drop mode is only meaningful if this component has a
TransferHandlerthat accepts drops.- Parameters:
dropMode- the drop mode to use- Throws:
IllegalArgumentException- if the drop mode is unsupported ornull- Since:
- 1.6
- See Also:
-
getDropMode
Returns the drop mode for this component.- Returns:
- the drop mode for this component
- Since:
- 1.6
- See Also:
-
getDropLocation
Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, ornullif 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 theTransferHandler'scanImporthas 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:
-
isPathEditable
ReturnsisEditable. This is invoked from the UI before editing begins to ensure 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- aTreePathidentifying a node- Returns:
- true if every parent node and the node itself is editable
- See Also:
-
getToolTipText
OverridesJComponent'sgetToolTipTextmethod in order to allow renderer's tips to be used if it has text set.NOTE: For
JTreeto properly display tooltips of its renderers,JTreemust be a registered component with theToolTipManager. This can be done by invokingToolTipManager.sharedInstance().registerComponent(tree). This is not done automatically!- Overrides:
getToolTipTextin classJComponent- Parameters:
event- theMouseEventthat initiated theToolTipdisplay- Returns:
- a string containing the tooltip or
nullifeventis 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 returnsvalue.toString, ignoring all other arguments. To control the conversion, subclass this method and use any of the arguments you need.- Parameters:
value- theObjectto convert to textselected- true if the node is selectedexpanded- true if the node is expandedleaf- true if the node is a leaf noderow- an integer specifying the node's display row, where 0 is the first row in the displayhasFocus- true if the node has the focus- Returns:
- the
Stringrepresentation of the node's value
-
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 ifisRootVisible()istrue. This returns0if the UI has not been set.- Returns:
- the number of viewable nodes
-
setSelectionPath
Selects the node identified by the specified path. If any component of the path is hidden (under a collapsed node), andgetExpandsSelectedPathsis true it is exposed (made viewable).- Parameters:
path- theTreePathspecifying the node to select
-
setSelectionPaths
Selects the nodes identified by the specified array of paths. If any component in any of the paths is hidden (under a collapsed node), andgetExpandsSelectedPathsis true it is exposed (made viewable).- Parameters:
paths- an array ofTreePathobjects that specifies the nodes to select
-
setLeadSelectionPath
Sets the path identifies as the lead. The lead may not be selected. The lead is not maintained byJTree, 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 byJTree, 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 ofrowsis < 0 or >=getRowCount, it will be ignored. If none of the elements inrowsare valid rows, the selection will be cleared. That is it will be as ifclearSelectionwas invoked.- Parameters:
rows- an array of ints specifying the rows to select, where 0 indicates the first row in the display
-
addSelectionPath
Adds the node identified by the specifiedTreePathto the current selection. If any component of the path isn't viewable, andgetExpandsSelectedPathsis true it is made viewable.Note that
JTreedoes not allow duplicate nodes to exist as children under the same parent -- each sibling must be a unique object.- Parameters:
path- theTreePathto add
-
addSelectionPaths
Adds each path in the array of paths to the current selection. If any component of any of the paths isn't viewable andgetExpandsSelectedPathsis true, it is made viewable.Note that
JTreedoes not allow duplicate nodes to exist as children under the same parent -- each sibling must be a unique object.- Parameters:
paths- an array ofTreePathobjects 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
Returns the last path component of the selected path. This is a convenience method forgetSelectionModel().getSelectionPath().getLastPathComponent(). This is typically only useful if the selection has one path.- Returns:
- the last path component of the selected path, or
nullif nothing is selected - See Also:
-
getLeadSelectionPath
Returns the path identified as the lead.- Returns:
- path identified as the lead
-
getAnchorSelectionPath
Returns the path identified as the anchor.- Returns:
- path identified as the anchor
- Since:
- 1.3
-
getSelectionPath
Returns the path to the first selected node.- Returns:
- the
TreePathfor the first selected node, ornullif nothing is currently selected
-
getSelectionPaths
Returns the paths of all selected values.- Returns:
- an array of
TreePathobjects indicating the selected nodes, ornullif nothing is currently selected
-
getSelectionRows
public int[] getSelectionRows()Returns all of the currently selected rows. This method is simply forwarded to theTreeSelectionModel. If nothing is selectednullor an empty array will be returned, based on theTreeSelectionModelimplementation.- Returns:
- an array of integers that identifies all currently selected rows where 0 is the first row in the display
-
getSelectionCount
Returns the number of nodes selected.- Returns:
- the number of nodes selected
-
getMinSelectionRow
Returns the smallest selected row. If the selection is empty, or none of the selected paths are viewable,-1is returned.- Returns:
- the smallest selected row
-
getMaxSelectionRow
Returns the largest selected row. If the selection is empty, or none of the selected paths are viewable,-1is returned.- Returns:
- the largest selected row
-
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
leadPathisnull
-
isPathSelected
Returns true if the item identified by the path is currently selected.- Parameters:
path- aTreePathidentifying 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
Returns anEnumerationof the descendants of the pathparentthat are currently expanded. Ifparentis not currently expanded, this will returnnull. If you expand/collapse nodes while iterating over the returnedEnumerationthis 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
Enumerationof the descendents ofparent, ornullifparentis not currently expanded
-
hasBeenExpanded
Returns true if the node identified by the path has ever been expanded.- Parameters:
path- aTreePathidentifying a node- Returns:
- true if the
pathhas ever been expanded
-
isExpanded
Returns true if the node identified by the path is currently expanded,- Parameters:
path- theTreePathspecifying 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
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- theTreePathto 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
Ensures that the node identified by path is currently viewable.- Parameters:
path- theTreePathto make visible
-
isVisible
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-TreePathidentifying a node- Returns:
- true if the node is viewable, otherwise false
-
getPathBounds
Returns theRectanglethat the specified node will be drawn into. Returnsnullif 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- theTreePathidentifying the node- Returns:
- the
Rectanglethe node is drawn in, ornull
-
getRowBounds
Returns theRectanglethat 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
Rectanglethe node is drawn in
-
scrollPathToVisible
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 thisJTreeis contained in aJScrollPane.- Parameters:
path- theTreePathidentifying 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 thisJTreeis contained in aJScrollPane.- Parameters:
row- an integer specifying the row to scroll, where 0 is the first row in the display
-
getPathForRow
Returns the path for the specified row. Ifrowis not visible, or aTreeUIhas not been set,nullis returned.- Parameters:
row- an integer specifying a row- Returns:
- the
TreePathto the specified node,nullifrow < 0orrow >= getRowCount()
-
getRowForPath
Returns the row that displays the node identified by the specified path.- Parameters:
path- theTreePathidentifying 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
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- theTreePathidentifying a node
-
expandRow
public void expandRow(int row) Ensures that the node in the specified row is expanded and viewable.If
rowis < 0 or >=getRowCountthis will have no effect.- Parameters:
row- an integer specifying a display row, where 0 is the first row in the display
-
collapsePath
Ensures that the node identified by the specified path is collapsed and viewable.- Parameters:
path- theTreePathidentifying a node
-
collapseRow
public void collapseRow(int row) Ensures that the node in the specified row is collapsed.If
rowis < 0 or >=getRowCountthis will have no effect.- Parameters:
row- an integer specifying a display row, where 0 is the first row in the display
-
getPathForLocation
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 marginy- an integer giving the number of pixels vertically from the top of the display area, minus any top margin- Returns:
- the
TreePathfor 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 marginy- 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:
-
getClosestPathForLocation
Returns the path to the node that is closest to x,y. If no nodes are currently viewable, or there is no model, returnsnull, 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 marginy- an integer giving the number of pixels vertically from the top of the display area, minus any top margin- Returns:
- the
TreePathfor the node closest to that location,nullif nothing is viewable or there is no model - See Also:
-
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 marginy- 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:
-
isEditing
Returns true if the tree is being edited. The item that is being edited can be obtained usinggetSelectionPath.- Returns:
- true if the user is currently editing a node
- See Also:
-
stopEditing
public boolean stopEditing()Ends the current editing session. (TheDefaultTreeCellEditorobject 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
Selects the node identified by the specified path and initiates editing. The edit-attempt fails if theCellEditordoes not allow editing for the specified item.- Parameters:
path- theTreePathidentifying a node
-
getEditingPath
Returns the path to the element that is currently being edited.- Returns:
- the
TreePathfor the node being edited
-
setSelectionModel
@BeanProperty(description="The tree's selection model.") public void setSelectionModel(TreeSelectionModel selectionModel) Sets the tree's selection model. When anullvalue is specified an emptyselectionModelis used, which does not allow selections.This is a bound property.
- Parameters:
selectionModel- theTreeSelectionModelto use, ornullto disable selections- See Also:
-
getSelectionModel
Returns the model for selections. This should always return a non-nullvalue. If you don't want to allow anything to be selected set the selection model tonull, which forces an empty selection model to be used.- Returns:
- the model for selections
- See Also:
-
getPathBetweenRows
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 is10, 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 with0, 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 togetPathBetweenRows(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 rangeindex1- 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 is10, and this method is invoked with-1, 20, then the specified indices bounds the viewable range, and this is treated as if invoked with0, 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 tosetSelectionInterval(y, x).- Parameters:
index0- the first index in the range to selectindex1- 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 is10, and this method is invoked with-1, 20, then the specified indices bounds the viewable range, and this is treated as if invoked with0, 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 toaddSelectionInterval(y, x).- Parameters:
index0- the first index in the range to add to the selectionindex1- 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 is10, and this method is invoked with-1, 20, then the specified range bounds the viewable range, and this is treated as if invoked with0, 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 toremoveSelectionInterval(y, x).- Parameters:
index0- the first row to remove from the selectionindex1- the last row to remove from the selection
-
removeSelectionPath
Removes the node identified by the specified path from the current selection.- Parameters:
path- theTreePathidentifying a node
-
removeSelectionPaths
Removes the nodes identified by the specified paths from the current selection.- Parameters:
paths- an array ofTreePathobjects that specifies the nodes to remove
-
removeSelectionRow
public void removeSelectionRow(int row) Removes the row at the indexrowfrom 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
Returns true if the selection is currently empty.- Returns:
- true if the selection is currently empty
-
addTreeExpansionListener
Adds a listener forTreeExpansionevents.- Parameters:
tel- a TreeExpansionListener that will be notified when a tree node is expanded or collapsed (a "negative expansion")
-
removeTreeExpansionListener
Removes a listener forTreeExpansionevents.- Parameters:
tel- theTreeExpansionListenerto remove
-
getTreeExpansionListeners
Returns an array of all theTreeExpansionListeners added to this JTree with addTreeExpansionListener().- Returns:
- all of the
TreeExpansionListeners added or an empty array if no listeners have been added - Since:
- 1.4
-
addTreeWillExpandListener
Adds a listener forTreeWillExpandevents.- Parameters:
tel- aTreeWillExpandListenerthat will be notified when a tree node will be expanded or collapsed (a "negative expansion")
-
removeTreeWillExpandListener
Removes a listener forTreeWillExpandevents.- Parameters:
tel- theTreeWillExpandListenerto remove
-
getTreeWillExpandListeners
Returns an array of all theTreeWillExpandListeners added to this JTree with addTreeWillExpandListener().- Returns:
- all of the
TreeWillExpandListeners added or an empty array if no listeners have been added - Since:
- 1.4
-
fireTreeExpanded
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using thepathparameter.- Parameters:
path- theTreePathindicating the node that was expanded- See Also:
-
fireTreeCollapsed
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using thepathparameter.- Parameters:
path- theTreePathindicating the node that was collapsed- See Also:
-
fireTreeWillExpand
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using thepathparameter.- Parameters:
path- theTreePathindicating the node that was expanded- Throws:
ExpandVetoException- if the expansion is prevented from occurring- See Also:
-
fireTreeWillCollapse
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using thepathparameter.- Parameters:
path- theTreePathindicating the node that was expanded- Throws:
ExpandVetoException- if the collapse is prevented from occurring- See Also:
-
addTreeSelectionListener
Adds a listener forTreeSelectionevents.- Parameters:
tsl- theTreeSelectionListenerthat will be notified when a node is selected or deselected (a "negative selection")
-
removeTreeSelectionListener
Removes aTreeSelectionlistener.- Parameters:
tsl- theTreeSelectionListenerto remove
-
getTreeSelectionListeners
Returns an array of all theTreeSelectionListeners added to this JTree with addTreeSelectionListener().- Returns:
- all of the
TreeSelectionListeners added or an empty array if no listeners have been added - Since:
- 1.4
-
fireValueChanged
Notifies all listeners that have registered interest for notification on this event type.- Parameters:
e- theTreeSelectionEventto be fired; generated by theTreeSelectionModelwhen a node is selected or deselected- See Also:
-
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 aJScrollPane, 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
Returns the TreePath to the next tree element that begins with a prefix. To handle the conversion of aTreePathinto a String,convertValueToTextis used.- Parameters:
prefix- the string to test for a matchstartingRow- the row for starting the searchbias- the search direction, either Position.Bias.Forward or Position.Bias.Backward.- 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
Returns the preferred display size of aJTree. The height is determined fromgetVisibleRowCountand the width is the current preferred width.- Specified by:
getPreferredScrollableViewportSizein interfaceScrollable- Returns:
- a
Dimensionobject containing the preferred size - See Also:
-
getScrollableUnitIncrement
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:
getScrollableUnitIncrementin interfaceScrollable- Parameters:
visibleRect- the view area visible within the viewportorientation- eitherSwingConstants.VERTICALorSwingConstants.HORIZONTALdirection- 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:
-
getScrollableBlockIncrement
Returns the amount for a block increment, which is the height or width ofvisibleRect, based onorientation.- Specified by:
getScrollableBlockIncrementin interfaceScrollable- Parameters:
visibleRect- the view area visible within the viewportorientation- eitherSwingConstants.VERTICALorSwingConstants.HORIZONTALdirection- 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:
-
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:
getScrollableTracksViewportWidthin interfaceScrollable- Returns:
- whether the tree should track the width of the viewport
- See Also:
-
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:
getScrollableTracksViewportHeightin interfaceScrollable- Returns:
- whether the tree should track the height of the viewport
- See Also:
-
setExpandedState
Sets the expanded state of thisJTree. Ifstateis true, all parents ofpathand path are marked as expanded. Ifstateis false, all parents ofpathare marked EXPANDED, butpathitself is marked collapsed.This will fail if a
TreeWillExpandListenervetos it.- Parameters:
path- aTreePathidentifying a nodestate- iftrue, all parents ofpathand path are marked as expanded. Otherwise, all parents ofpathare marked EXPANDED, butpathitself is marked collapsed.
-
getDescendantToggledPaths
Returns anEnumerationofTreePathsthat have been expanded that are descendants ofparent.- Parameters:
parent- a path- Returns:
- the
EnumerationofTreePaths
-
removeDescendantToggledPaths
Removes any descendants of theTreePathsintoRemovethat have been expanded.- Parameters:
toRemove- an enumeration of the paths to remove; a value ofnullis ignored- Throws:
ClassCastException- iftoRemovecontains an element that is not aTreePath;nullvalues are ignored
-
clearToggledPaths
protected void clearToggledPaths()Clears the cache of toggled tree paths. This does NOT send out anyTreeExpansionListenerevents. -
createTreeModelListener
Creates and returns an instance ofTreeModelHandler. The returned object is responsible for updating the expanded state when theTreeModelchanges.For more information on what expanded state means, see the
JTree descriptionabove.- Returns:
- the instance of
TreeModelHandler
-
removeDescendantSelectedPaths
Removes any paths in the selection that are descendants ofpath. IfincludePathis true andpathis selected, it will be removed from the selection.- Parameters:
path- a pathincludePath- istrueandpathis selected, it will be removed from the selection.- Returns:
- true if a descendant was selected
- Since:
- 1.3
-
paramString
Returns a string representation of thisJTree. 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 benull.- Overrides:
paramStringin classJComponent- Returns:
- a string representation of this
JTree.
-
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:
getAccessibleContextin interfaceAccessible- Overrides:
getAccessibleContextin classComponent- Returns:
- an AccessibleJTree that serves as the AccessibleContext of this JTree
-