public class JTree extends JComponentimplements Scrollable , Accessible
A specific node in a tree can be identified either by a TreePath (an object that encapsulates a node and all of its ancestors), or by its display row, where each row in the display area displays one node. An expanded node is a non-leaf node (as identified by TreeModel.isLeaf(node) returning false) that will displays its children when all its ancestors are expanded. A collapsed node is one which hides them. A hidden node is one which is under a collapsed ancestor. All of a viewable nodes parents are expanded, but may or may not be displayed. A displayed node is both viewable and in the display area, where it can be seen.
JTree methods use "visible" to mean "displayed":
isRootVisible() setRootVisible() scrollPathToVisible() scrollRowToVisible() getVisibleRowCount() setVisibleRowCount() JTree methods use "visible" to mean "viewable" (under an expanded parent):
isVisible() makeVisible() TreeSelectionListener interface and add the instance using the method
addTreeSelectionListener.
valueChanged will be invoked when the selection changes, that is if the user clicks twice on the same node
valueChanged will only be invoked once.
If you are interested in detecting either double-click events or when a user clicks on a node, regardless of whether or not it was selected, we recommend you do the following:
final JTree tree = ...;
MouseListener ml = new MouseAdapter() {
public void mousePressed(MouseEvent e) {
int selRow = tree.getRowForLocation(e.getX(), e.getY());
TreePath selPath = tree.getPathForLocation(e.getX(), e.getY());
if(selRow != -1) {
if(e.getClickCount() == 1) {
mySingleClick(selRow, selPath);
}
else if(e.getClickCount() == 2) {
myDoubleClick(selRow, selPath);
}
}
}
};
tree.addMouseListener(ml);
NOTE: This example obtains both the path and row, but you only need to get the one you're interested in.
To use JTree to display compound nodes (for example, nodes containing both a graphic icon and text), subclass TreeCellRenderer and use setCellRenderer(javax.swing.tree.TreeCellRenderer) to tell the tree to use it. To edit such nodes, subclass TreeCellEditor and use setCellEditor(javax.swing.tree.TreeCellEditor).
Like all JComponent classes, you can use InputMap and ActionMap to associate an Action object with a KeyStroke and execute the action under specified conditions.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.
| Modifier and Type | Class and Description |
|---|---|
protected class |
JTree
This class implements accessibility support for the
JTree class.
|
static class |
JTree
A subclass of
TransferHandler.DropLocation representing a drop location for a
JTree.
|
static class |
JTree
DynamicUtilTreeNode can wrap vectors/hashtables/arrays/strings and create the appropriate children tree nodes as necessary.
|
protected static class |
JTree
EmptySelectionModel is a
TreeSelectionModel that does not allow anything to be selected.
|
protected class |
JTree
Listens to the model and updates the
expandedState accordingly when nodes are removed, or changed.
|
protected class |
JTree
Handles creating a new
TreeSelectionEvent with the
JTree as the source and passing it off to all the listeners.
|
JComponent.AccessibleJComponent Container.AccessibleAWTContainer Component.AccessibleAWTComponent , Component.BaselineResizeBehavior , Component.BltBufferStrategy , Component.FlipBufferStrategy | Modifier and Type | Field and Description |
|---|---|
static String |
ANCHOR_SELECTION_PATH_PROPERTY
Bound property name for anchor selection path.
|
static String |
CELL_EDITOR_PROPERTY
Bound property name for
cellEditor.
|
static String |
CELL_RENDERER_PROPERTY
Bound property name for
cellRenderer.
|
protected TreeCellEditor |
cellEditor
Editor for the entries.
|
protected TreeCellRenderer |
cellRenderer
The cell used to draw nodes.
|
protected boolean |
editable
Is the tree editable? Default is false.
|
static String |
EDITABLE_PROPERTY
Bound property name for
editable.
|
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
messagesStopCellEditing.
|
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.
|
static String |
LARGE_MODEL_PROPERTY
Bound property name for
largeModel.
|
protected boolean |
largeModel
Is this tree a large model? This is a code-optimization setting.
|
static String |
LEAD_SELECTION_PATH_PROPERTY
Bound property name for
leadSelectionPath.
|
static String |
ROOT_VISIBLE_PROPERTY
Bound property name for
rootVisible.
|
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
rowHeight.
|
protected int |
rowHeight
Height to use for each display row.
|
static String |
SCROLLS_ON_EXPAND_PROPERTY
Bound property name for
scrollsOnExpand.
|
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 |
selectionRedirector
Creates a new event and passed it off the
selectionListeners.
|
static String |
SHOWS_ROOT_HANDLES_PROPERTY
Bound property name for
showsRootHandles.
|
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
toggleClickCount.
|
protected int |
toggleClickCount
Number of mouse clicks before a node is expanded.
|
static String |
TREE_MODEL_PROPERTY
Bound property name for
treeModel.
|
protected TreeModel |
treeModel
The model that defines the tree displayed by this object.
|
protected TreeModelListener |
treeModelListener
Updates the
expandedState.
|
static String |
VISIBLE_ROW_COUNT_PROPERTY
Bound property name for
visibleRowCount.
|
protected int |
visibleRowCount
Number of rows to make visible at one time.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH| Constructor and Description |
|---|
JTree()
Returns a
JTree with a sample model.
|
JTree(Hashtable
Returns a
JTree created from a
Hashtable which does not display with root.
|
JTree(Object
Returns a
JTree with each element of the specified array as the child of a new root node which is not displayed.
|
JTree(TreeModel
Returns an instance of
JTree which displays the root node -- the tree is created using the specified data model.
|
JTree(TreeNode
Returns a
JTree with the specified
TreeNode as its root, which displays the root node.
|
JTree(TreeNode
Returns a
JTree with the specified
TreeNode as its root, which displays the root node and which decides whether a node is a leaf node in the specified manner.
|
JTree(Vector
Returns a
JTree with each element of the specified
Vector as the child of a new root node which is not displayed.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addSelectionInterval(int index0, int index1)
Adds the specified rows (inclusive) to the selection.
|
void |
addSelectionPath(TreePath
Adds the node identified by the specified
TreePath to the current selection.
|
void |
addSelectionPaths(TreePath
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
Adds a listener for
TreeExpansion events.
|
void |
addTreeSelectionListener(TreeSelectionListener
Adds a listener for
TreeSelection events.
|
void |
addTreeWillExpandListener(TreeWillExpandListener
Adds a listener for
TreeWillExpand events.
|
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
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
Called by the renderers to convert the specified value to text.
|
protected static TreeModel |
createTreeModel(Object
Returns a
TreeModel wrapping the specified object.
|
protected TreeModelListener |
createTreeModelListener()
Creates and returns an instance of
TreeModelHandler.
|
void |
expandPath(TreePath
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
Notifies all listeners that have registered interest for notification on this event type.
|
void |
fireTreeExpanded(TreePath
Notifies all listeners that have registered interest for notification on this event type.
|
void |
fireTreeWillCollapse(TreePath
Notifies all listeners that have registered interest for notification on this event type.
|
void |
fireTreeWillExpand(TreePath
Notifies all listeners that have registered interest for notification on this event type.
|
protected void |
fireValueChanged(TreeSelectionEvent
Notifies all listeners that have registered interest for notification on this event type.
|
AccessibleContext |
getAccessibleContext()
Gets the AccessibleContext associated with this JTree.
|
TreePath |
getAnchorSelectionPath()
Returns the path identified as the anchor.
|
TreeCellEditor |
getCellEditor()
Returns the editor used to edit entries in the tree.
|
TreeCellRenderer |
getCellRenderer()
Returns the current
TreeCellRenderer that is rendering each cell.
|
TreePath |
getClosestPathForLocation(int x, int y)
Returns the path to the node that is closest to x,y.
|
int |
getClosestRowForLocation(int x, int y)
Returns the row to the node that is closest to x,y.
|
protected static TreeModel |
getDefaultTreeModel()
Creates and returns a sample
TreeModel.
|
protected Enumeration |
getDescendantToggledPaths(TreePath
Returns an
Enumeration of
TreePaths that have been expanded that are descendants of
parent.
|
boolean |
getDragEnabled()
Returns whether or not automatic drag handling is enabled.
|
JTree |
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.
|
DropMode |
getDropMode()
Returns the drop mode for this component.
|
TreePath |
getEditingPath()
Returns the path to the element that is currently being edited.
|
Enumeration |
getExpandedDescendants(TreePath
Returns an
Enumeration of the descendants of the path
parent that are currently expanded.
|
boolean |
getExpandsSelectedPaths()
Returns the
expandsSelectedPaths property.
|
boolean |
getInvokesStopCellEditing()
Returns the indicator that tells what happens when editing is interrupted.
|
Object |
getLastSelectedPathComponent()
Returns the last path component 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
TreeModel that is providing the data.
|
TreePath |
getNextMatch(String
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
Returns the
Rectangle that the specified node will be drawn into.
|
TreePath |
getPathForLocation(int x, int y)
Returns the path for the node at the specified location.
|
TreePath |
getPathForRow(int row)
Returns the path for the specified row.
|
Dimension |
getPreferredScrollableViewportSize()
Returns the preferred display size of a
JTree.
|
Rectangle |
getRowBounds(int row)
Returns the
Rectangle that the node at the specified row is drawn in.
|
int |
getRowCount()
Returns the number of viewable nodes.
|
int |
getRowForLocation(int x, int y)
Returns the row for the specified location.
|
int |
getRowForPath(TreePath
Returns the row that displays the node identified by the specified path.
|
int |
getRowHeight()
Returns the height of each row.
|
int |
getScrollableBlockIncrement(Rectangle
Returns the amount for a block increment, which is the height or width of
visibleRect, based on
orientation.
|
boolean |
getScrollableTracksViewportHeight()
Returns false to indicate that the height of the viewport does not determine the height of the table, unless the preferred height of the tree is smaller than the viewports height.
|
boolean |
getScrollableTracksViewportWidth()
Returns false to indicate that the width of the viewport does not determine the width of the table, unless the preferred width of the tree is smaller than the viewports width.
|
int |
getScrollableUnitIncrement(Rectangle
Returns the amount to increment when scrolling.
|
boolean |
getScrollsOnExpand()
Returns the value of the
scrollsOnExpand property.
|
int |
getSelectionCount()
Returns the number of nodes selected.
|
TreeSelectionModel |
getSelectionModel()
Returns the model for selections.
|
TreePath |
getSelectionPath()
Returns the path to the first selected node.
|
TreePath |
getSelectionPaths()
Returns the paths of all selected values.
|
int[] |
getSelectionRows()
Returns all of the currently selected rows.
|
boolean |
getShowsRootHandles()
Returns the value of the
showsRootHandles property.
|
int |
getToggleClickCount()
Returns the number of mouse clicks needed to expand or close a node.
|
String |
getToolTipText(MouseEvent
Overrides
JComponent's
getToolTipText method in order to allow renderer's tips to be used if it has text set.
|
TreeExpansionListener |
getTreeExpansionListeners()
Returns an array of all the
TreeExpansionListeners added to this JTree with addTreeExpansionListener().
|
TreeSelectionListener |
getTreeSelectionListeners()
Returns an array of all the
TreeSelectionListeners added to this JTree with addTreeSelectionListener().
|
TreeWillExpandListener |
getTreeWillExpandListeners()
Returns an array of all the
TreeWillExpandListeners added to this JTree with addTreeWillExpandListener().
|
TreeUI |
getUI()
Returns the L&F object that renders this component.
|
String |
getUIClassID()
Returns the name of the L&F class that renders this component.
|
int |
getVisibleRowCount()
Returns the number of rows that are displayed in the display area.
|
boolean |
hasBeenExpanded(TreePath
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
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
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
Returns
isEditable.
|
boolean |
isPathSelected(TreePath
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
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
Ensures that the node identified by path is currently viewable.
|
protected String |
paramString()
Returns a string representation of this
JTree.
|
protected boolean |
removeDescendantSelectedPaths(TreePath
Removes any paths in the selection that are descendants of
path.
|
protected void |
removeDescendantToggledPaths(Enumeration
Removes any descendants of the
TreePaths in
toRemove that have been expanded.
|
void |
removeSelectionInterval(int index0, int index1)
Removes the specified rows (inclusive) from the selection.
|
void |
removeSelectionPath(TreePath
Removes the node identified by the specified path from the current selection.
|
void |
removeSelectionPaths(TreePath
Removes the nodes identified by the specified paths from the current selection.
|
void |
removeSelectionRow(int row)
Removes the row at the index
row from the current selection.
|
void |
removeSelectionRows(int[] rows)
Removes the rows that are selected at each of the specified rows.
|
void |
removeTreeExpansionListener(TreeExpansionListener
Removes a listener for
TreeExpansion events.
|
void |
removeTreeSelectionListener(TreeSelectionListener
Removes a
TreeSelection listener.
|
void |
removeTreeWillExpandListener(TreeWillExpandListener
Removes a listener for
TreeWillExpand events.
|
void |
scrollPathToVisible(TreePath
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
Sets the path identified as the anchor.
|
void |
setCellEditor(TreeCellEditor
Sets the cell editor.
|
void |
setCellRenderer(TreeCellRenderer
Sets the
TreeCellRenderer that will be used to draw each cell.
|
void |
setDragEnabled(boolean b)
Turns on or off automatic drag handling.
|
void |
setDropMode(DropMode
Sets the drop mode for this component.
|
void |
setEditable(boolean flag)
Determines whether the tree is editable.
|
protected void |
setExpandedState(TreePath
Sets the expanded state of this
JTree.
|
void |
setExpandsSelectedPaths(boolean newValue)
Configures the
expandsSelectedPaths property.
|
void |
setInvokesStopCellEditing(boolean newValue)
Determines what happens when editing is interrupted by selecting another node in the tree, a change in the tree's data, or by some other means.
|
void |
setLargeModel(boolean newValue)
Specifies whether the UI should use a large model.
|
void |
setLeadSelectionPath(TreePath
Sets the path identifies as the lead.
|
void |
setModel(TreeModel
Sets the
TreeModel that will provide the data.
|
void |
setRootVisible(boolean rootVisible)
Determines whether or not the root node from the
TreeModel is visible.
|
void |
setRowHeight(int rowHeight)
Sets the height of each cell, in pixels.
|
void |
setScrollsOnExpand(boolean newValue)
Sets the
scrollsOnExpand property, which determines whether the tree might scroll to show previously hidden children.
|
void |
setSelectionInterval(int index0, int index1)
Selects the rows in the specified interval (inclusive).
|
void |
setSelectionModel(TreeSelectionModel
Sets the tree's selection model.
|
void |
setSelectionPath(TreePath
Selects the node identified by the specified path.
|
void |
setSelectionPaths(TreePath
Selects the nodes identified by the specified array of paths.
|
void |
setSelectionRow(int row)
Selects the node at the specified row in the display.
|
void |
setSelectionRows(int[] rows)
Selects the nodes corresponding to each of the specified rows in the display.
|
void |
setShowsRootHandles(boolean newValue)
Sets the value of the
showsRootHandles property, which specifies whether the node handles should be displayed.
|
void |
setToggleClickCount(int clickCount)
Sets the number of mouse clicks before a node will expand or close.
|
void |
setUI(TreeUI
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
Selects the node identified by the specified path and initiates editing.
|
boolean |
stopEditing()
Ends the current editing session.
|
void |
treeDidChange()
Sent when the tree has changed enough that we need to resize the bounds, but not enough that we need to remove the expanded node set (e.g nodes were expanded or collapsed, or nodes were inserted into the tree).
|
void |
updateUI()
Notification from the
UIManager that the L&F has changed.
|
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, 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, updateadd, 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, validateTreeaction, 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, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycleprotected transient TreeModeltreeModel
protected transient TreeSelectionModelselectionModel
protected boolean rootVisible
protected transient TreeCellRenderercellRenderer
null, the UI uses a default
cellRenderer.
protected int rowHeight
protected boolean showsRootHandles
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.
rootVisible
protected transient JTree.TreeSelectionRedirector selectionRedirector
selectionListeners.
protected transient TreeCellEditorcellEditor
null (tree is not editable).
protected boolean editable
protected boolean largeModel
This value is only a suggestion to the UI. Not all UIs will take advantage of it. Default value is false.
protected int visibleRowCount
Scrollable interface. It determines the preferred size of the display area.
protected boolean invokesStopCellEditing
stopCellEditing is invoked, and changes are saved. If false,
cancelCellEditing is invoked, and changes are discarded. Default is false.
protected boolean scrollsOnExpand
protected int toggleClickCount
protected transient TreeModelListenertreeModelListener
expandedState.
public static final StringCELL_RENDERER_PROPERTY
cellRenderer.
public static final StringTREE_MODEL_PROPERTY
treeModel.
public static final StringROOT_VISIBLE_PROPERTY
rootVisible.
public static final StringSHOWS_ROOT_HANDLES_PROPERTY
showsRootHandles.
public static final StringROW_HEIGHT_PROPERTY
rowHeight.
public static final StringCELL_EDITOR_PROPERTY
cellEditor.
public static final StringEDITABLE_PROPERTY
editable.
public static final StringLARGE_MODEL_PROPERTY
largeModel.
public static final StringSELECTION_MODEL_PROPERTY
public static final StringVISIBLE_ROW_COUNT_PROPERTY
visibleRowCount.
public static final StringINVOKES_STOP_CELL_EDITING_PROPERTY
messagesStopCellEditing.
public static final StringSCROLLS_ON_EXPAND_PROPERTY
scrollsOnExpand.
public static final StringTOGGLE_CLICK_COUNT_PROPERTY
toggleClickCount.
public static final StringLEAD_SELECTION_PATH_PROPERTY
leadSelectionPath.
public static final StringANCHOR_SELECTION_PATH_PROPERTY
public static final StringEXPANDS_SELECTED_PATHS_PROPERTY
public JTree()
JTree with a sample model. The default model used by the tree defines a leaf node as any node without children.
DefaultTreeModel.asksAllowsChildren
public JTree(Object[] value)
JTree with each element of the specified array as the child of a new root node which is not displayed. By default, the tree defines a leaf node as any node without children.
value - an array of
Objects
DefaultTreeModel.asksAllowsChildren
public JTree(Vector<?> value)
JTree with each element of the specified
Vector as the child of a new root node which is not displayed. By default, the tree defines a leaf node as any node without children.
value - a
Vector
DefaultTreeModel.asksAllowsChildren
public JTree(Hashtable<? ,?> value)
JTree created from a
Hashtable which does not display with root. Each value-half of the key/value pairs in the
HashTable becomes a child of the new root node. By default, the tree defines a leaf node as any node without children.
value - a
Hashtable
DefaultTreeModel.asksAllowsChildren
public JTree(TreeNoderoot)
JTree with the specified
TreeNode as its root, which displays the root node. By default, the tree defines a leaf node as any node without children.
root - a
TreeNode object
DefaultTreeModel.asksAllowsChildren
public JTree(TreeNoderoot, boolean asksAllowsChildren)
JTree with the specified
TreeNode as its root, which displays the root node and which decides whether a node is a leaf node in the specified manner.
root - a
TreeNode object
asksAllowsChildren - if false, any node without children is a leaf node; if true, only nodes that do not allow children are leaf nodes
DefaultTreeModel.asksAllowsChildren
@ConstructorProperties(value="model") public JTree(TreeModelnewModel)
JTree which displays the root node -- the tree is created using the specified data model.
newModel - the
TreeModel to use as the data model
protected static TreeModelgetDefaultTreeModel()
TreeModel. Used primarily for beanbuilders to show something interesting.
TreeModel
protected static TreeModelcreateTreeModel(Object value)
TreeModel wrapping the specified object. If the object is:
Objects, Hashtable, or Vector "root".
value - the
Object used as the foundation for the
TreeModel
TreeModel wrapping the specified object
public TreeUIgetUI()
TreeUI object that renders this component
public void setUI(TreeUIui)
This is a bound property.
ui - the
TreeUI L&F object
UIDefaults.getUI(javax.swing.JComponent)
public void updateUI()
UIManager that the L&F has changed. Replaces the current UI object with the latest version from the
UIManager.
updateUI in class
JComponent
JComponent.updateUI()
public StringgetUIClassID()
getUIClassID in class
JComponent
JComponent.getUIClassID() ,
UIDefaults.getUI(javax.swing.JComponent)
public TreeCellRenderergetCellRenderer()
TreeCellRenderer that is rendering each cell.
TreeCellRenderer that is rendering each cell
public void setCellRenderer(TreeCellRendererx)
TreeCellRenderer that will be used to draw each cell.
This is a bound property.
x - the
TreeCellRenderer that is to render each cell
public void setEditable(boolean flag)
This is a bound property.
flag - a boolean value, true if the tree is editable
public boolean isEditable()
public void setCellEditor(TreeCellEditorcellEditor)
null value implies that the tree cannot be edited. If this represents a change in the
cellEditor, the
propertyChange method is invoked on all listeners.
This is a bound property.
cellEditor - the
TreeCellEditor to use
public TreeCellEditorgetCellEditor()
TreeCellEditor in use, or
null if the tree cannot be edited
public TreeModelgetModel()
TreeModel that is providing the data.
TreeModel that is providing the data
public void setModel(TreeModelnewModel)
TreeModel that will provide the data.
This is a bound property.
newModel - the
TreeModel that is to provide the data
public boolean isRootVisible()
rootVisible
public void setRootVisible(boolean rootVisible)
TreeModel is visible.
This is a bound property.
rootVisible - true if the root node of the tree is to be displayed
rootVisible
public void setShowsRootHandles(boolean newValue)
showsRootHandles property, which specifies whether the node handles should be displayed. The default value of this property depends on the constructor used to create the
JTree. Some look and feels might not support handles; they will ignore this property.
This is a bound property.
newValue -
true if root handles should be displayed; otherwise,
false
showsRootHandles,
getShowsRootHandles()
public boolean getShowsRootHandles()
showsRootHandles property.
showsRootHandles property
showsRootHandles
public void setRowHeight(int rowHeight)
This is a bound property.
rowHeight - the height of each cell, in pixels
public int getRowHeight()
public boolean isFixedRowHeight()
public void setLargeModel(boolean newValue)
This is a bound property.
newValue - true to suggest a large model to the UI
largeModel
public boolean isLargeModel()
largeModel
public void setInvokesStopCellEditing(boolean newValue)
true causes the changes to be automatically saved when editing is interrupted.
Fires a property change for the INVOKES_STOP_CELL_EDITING_PROPERTY.
newValue - true means that
stopCellEditing is invoked when editing is interrupted, and data is saved; false means that
cancelCellEditing is invoked, and changes are lost
public boolean getInvokesStopCellEditing()
setInvokesStopCellEditing(boolean)
public void setScrollsOnExpand(boolean newValue)
scrollsOnExpand property, which determines whether the tree might scroll to show previously hidden children. If this property is
true (the default), when a node expands the tree can use scrolling to make the maximum possible number of the node's descendants visible. In some look and feels, trees might not need to scroll when expanded; those look and feels will ignore this property.
This is a bound property.
newValue -
false to disable scrolling on expansion;
true to enable it
getScrollsOnExpand()
public boolean getScrollsOnExpand()
scrollsOnExpand property.
scrollsOnExpand property
public void setToggleClickCount(int clickCount)
This is a bound property.
public int getToggleClickCount()
public void setExpandsSelectedPaths(boolean newValue)
expandsSelectedPaths property. If true, any time the selection is changed, either via the
TreeSelectionModel, or the cover methods provided by
JTree, the
TreePaths parents will be expanded to make them visible (visible meaning the parent path is expanded, not necessarily in the visible rectangle of the
JTree). If false, when the selection changes the nodes parent is not made visible (all its parents expanded). This is useful if you wish to have your selection model maintain paths that are not always visible (all parents expanded).
This is a bound property.
newValue - the new value for
expandsSelectedPaths
public boolean getExpandsSelectedPaths()
expandsSelectedPaths property.
setExpandsSelectedPaths(boolean)
public void setDragEnabled(boolean b)
true, and the tree's
TransferHandler needs to be
non-null. The default value of the
dragEnabled property is
false.
The job of honoring this property, and recognizing a user drag gesture, lies with the look and feel implementation, and in particular, the tree's TreeUI. When automatic drag handling is enabled, most look and feels (including those that subclass BasicLookAndFeel) begin a drag and drop operation whenever the user presses the mouse button over an item and then moves the mouse a few pixels. Setting this property to true can therefore have a subtle effect on how selections behave.
If a look and feel is used that ignores this property, you can still begin a drag and drop operation by calling exportAsDrag on the tree's TransferHandler.
b - whether or not to enable automatic drag handling
HeadlessException - if
b is
true and
GraphicsEnvironment.isHeadless() returns
true
GraphicsEnvironment.isHeadless() ,
getDragEnabled(),
JComponent.setTransferHandler(javax.swing.TransferHandler) ,
TransferHandler
public boolean getDragEnabled()
dragEnabled property
setDragEnabled(boolean)
public final void setDropMode(DropModedropMode)
DropMode.USE_SELECTION. Usage of one of the other modes is recommended, however, for an improved user experience.
DropMode.ON, for instance, offers similar behavior of showing items as selected, but does so without affecting the actual selection in the tree.
JTree supports the following drop modes:
DropMode.USE_SELECTIONDropMode.ONDropMode.INSERTDropMode.ON_OR_INSERT The drop mode is only meaningful if this component has a TransferHandler that accepts drops.
dropMode - the drop mode to use
IllegalArgumentException - if the drop mode is unsupported or
null
getDropMode(),
getDropLocation(),
JComponent.setTransferHandler(javax.swing.TransferHandler) ,
TransferHandler
public final DropModegetDropMode()
setDropMode(javax.swing.DropMode)
public final JTree.DropLocation getDropLocation()
null if no location is to currently be shown.
This method is not meant for querying the drop location from a TransferHandler, as the drop location is only set after the TransferHandler's canImport has returned and has allowed for the location to be shown.
When this property changes, a property change event with name "dropLocation" is fired by the component.
setDropMode(javax.swing.DropMode),
TransferHandler.canImport(TransferHandler.TransferSupport)
public boolean isPathEditable(TreePathpath)
isEditable. This is invoked from the UI before editing begins to insure that the given path can be edited. This is provided as an entry point for subclassers to add filtered editing without having to resort to creating a new editor.
isEditable()
public StringgetToolTipText(MouseEvent event)
JComponent's
getToolTipText method in order to allow renderer's tips to be used if it has text set.
NOTE: For JTree to properly display tooltips of its renderers, JTree must be a registered component with the ToolTipManager. This can be done by invoking ToolTipManager.sharedInstance().registerComponent(tree). This is not done automatically!
getToolTipText in class
JComponent
event - the
MouseEvent that initiated the
ToolTip display
null if
event is null
public StringconvertValueToText(Object value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus)
value.toString, ignoring all other arguments. To control the conversion, subclass this method and use any of the arguments you need.
value - the
Object to convert to 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
String representation of the node's value
public int getRowCount()
isRootVisible() is
true. This returns
0 if the UI has not been set.
public void setSelectionPath(TreePathpath)
getExpandsSelectedPaths is true it is exposed (made viewable).
path - the
TreePath specifying the node to select
public void setSelectionPaths(TreePath[] paths)
getExpandsSelectedPaths is true it is exposed (made viewable).
paths - an array of
TreePath objects that specifies the nodes to select
public void setLeadSelectionPath(TreePathnewPath)
JTree, rather the UI will update it.
This is a bound property.
newPath - the new lead path
public void setAnchorSelectionPath(TreePathnewPath)
JTree, rather the UI will update it.
This is a bound property.
newPath - the new anchor path
public void setSelectionRow(int row)
row - the row to select, where 0 is the first row in the display
public void setSelectionRows(int[] rows)
rows is < 0 or >=
getRowCount, it will be ignored. If none of the elements in
rows are valid rows, the selection will be cleared. That is it will be as if
clearSelection was invoked.
rows - an array of ints specifying the rows to select, where 0 indicates the first row in the display
public void addSelectionPath(TreePathpath)
TreePath to the current selection. If any component of the path isn't viewable, and
getExpandsSelectedPaths is true it is made viewable.
Note that JTree does not allow duplicate nodes to exist as children under the same parent -- each sibling must be a unique object.
path - the
TreePath to add
public void addSelectionPaths(TreePath[] paths)
getExpandsSelectedPaths is true, it is made viewable.
Note that JTree does not allow duplicate nodes to exist as children under the same parent -- each sibling must be a unique object.
paths - an array of
TreePath objects that specifies the nodes to add
public void addSelectionRow(int row)
row - an integer specifying the row of the node to add, where 0 is the first row in the display
public void addSelectionRows(int[] rows)
rows - an array of ints specifying the rows to add, where 0 indicates the first row in the display
public ObjectgetLastSelectedPathComponent()
getSelectionModel().getSelectionPath().getLastPathComponent(). This is typically only useful if the selection has one path.
null if nothing is selected
TreePath.getLastPathComponent()
public TreePathgetLeadSelectionPath()
public TreePathgetAnchorSelectionPath()
public TreePathgetSelectionPath()
TreePath for the first selected node, or
null if nothing is currently selected
public TreePath[] getSelectionPaths()
TreePath objects indicating the selected nodes, or
null if nothing is currently selected
public int[] getSelectionRows()
TreeSelectionModel. If nothing is selected
null or an empty array will be returned, based on the
TreeSelectionModel implementation.
public int getSelectionCount()
public int getMinSelectionRow()
-1 is returned.
public int getMaxSelectionRow()
-1 is returned.
public int getLeadSelectionRow()
leadPath is
null
public boolean isPathSelected(TreePathpath)
path - a
TreePath identifying a node
public boolean isRowSelected(int row)
row - an integer specifying a display row, where 0 is the first row in the display
public Enumeration<TreePath > getExpandedDescendants(TreePath parent)
Enumeration of the descendants of the path
parent that are currently expanded. If
parent is not currently expanded, this will return
null. If you expand/collapse nodes while iterating over the returned
Enumeration this may not return all the expanded paths, or may return paths that are no longer expanded.
parent - the path which is to be examined
Enumeration of the descendents of
parent, or
null if
parent is not currently expanded
public boolean hasBeenExpanded(TreePathpath)
path has ever been expanded
public boolean isExpanded(TreePathpath)
path - the
TreePath specifying the node to check
public boolean isExpanded(int row)
row - the row to check, where 0 is the first row in the display
public boolean isCollapsed(TreePathpath)
path - the
TreePath to check
public boolean isCollapsed(int row)
row - the row to check, where 0 is the first row in the display
public void makeVisible(TreePathpath)
path - the
TreePath to make visible
public boolean isVisible(TreePathpath)
public RectanglegetPathBounds(TreePath path)
Rectangle that the specified node will be drawn into. Returns
null if any component in the path is hidden (under a collapsed parent).
Note:
This method returns a valid rectangle, even if the specified node is not currently displayed.
path - the
TreePath identifying the node
Rectangle the node is drawn in, or
null
public RectanglegetRowBounds(int row)
Rectangle that the node at the specified row is drawn in.
row - the row to be drawn, where 0 is the first row in the display
Rectangle the node is drawn in
public void scrollPathToVisible(TreePathpath)
JTree is contained in a
JScrollPane.
path - the
TreePath identifying the node to bring into view
public void scrollRowToVisible(int row)
JTree is contained in a
JScrollPane.
row - an integer specifying the row to scroll, where 0 is the first row in the display
public TreePathgetPathForRow(int row)
row is not visible, or a
TreeUI has not been set,
null is returned.
row - an integer specifying a row
TreePath to the specified node,
null if
row < 0 or
row >= getRowCount()
public int getRowForPath(TreePathpath)
path - the
TreePath identifying a node
public void expandPath(TreePathpath)
path - the
TreePath identifying a node
public void expandRow(int row)
If row is < 0 or >= getRowCount this will have no effect.
row - an integer specifying a display row, where 0 is the first row in the display
public void collapsePath(TreePathpath)
path - the
TreePath identifying a node
public void collapseRow(int row)
If row is < 0 or >= getRowCount this will have no effect.
row - an integer specifying a display row, where 0 is the first row in the display
public TreePathgetPathForLocation(int x, int y)
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
TreePath for the node at that location
public int getRowForLocation(int x,
int y)
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
getClosestRowForLocation(int, int)
public TreePathgetClosestPathForLocation(int x, int y)
null, otherwise it always returns a valid path. To test if the node is exactly at x, y, get the node's bounds and test x, y against that.
x - an integer giving the number of pixels horizontally from the left edge of the display area, minus any left margin
y - an integer giving the number of pixels vertically from the top of the display area, minus any top margin
TreePath for the node closest to that location,
null if nothing is viewable or there is no model
getPathForLocation(int, int),
getPathBounds(javax.swing.tree.TreePath)
public int getClosestRowForLocation(int x,
int y)
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
getRowForLocation(int, int),
getRowBounds(int)
public boolean isEditing()
getSelectionPath.
getSelectionPath()
public boolean stopEditing()
DefaultTreeCellEditor object saves any edits that are currently in progress on a cell. Other implementations may operate differently.) Has no effect if the tree isn't being edited.
Note:
To make edit-saves automatic whenever the user changes their position in the tree, usesetInvokesStopCellEditing(boolean).
public void cancelEditing()
public void startEditingAtPath(TreePathpath)
CellEditor does not allow editing for the specified item.
path - the
TreePath identifying a node
public TreePathgetEditingPath()
TreePath for the node being edited
public void setSelectionModel(TreeSelectionModelselectionModel)
null value is specified an empty
selectionModel is used, which does not allow selections.
This is a bound property.
selectionModel - the
TreeSelectionModel to use, or
null to disable selections
TreeSelectionModel
public TreeSelectionModelgetSelectionModel()
null value. If you don't want to allow anything to be selected set the selection model to
null, which forces an empty selection model to be used.
protected TreePath[] getPathBetweenRows(int index0, int index1)
10, and this method is invoked with
-1, 20, then the specified indices are constrained to the viewable set of rows, and this is treated as if invoked with
0, 9. On the other hand, if this were invoked with
-10, -1, then the specified indices do not bound the viewable set of rows, and an empty array is returned.
The parameters are not order dependent. That is, getPathBetweenRows(x, y) is equivalent to getPathBetweenRows(y, x).
An empty array is returned if the row count is 0, or the specified indices do not bound the viewable set of rows.
index0 - the first index in the range
index1 - the last index in the range
public void setSelectionInterval(int index0,
int index1)
10, and this method is invoked with
-1, 20, then the specified indices bounds the viewable range, and this is treated as if invoked with
0, 9. On the other hand, if this were invoked with
-10, -1, then the specified indices do not bound the viewable set of rows, and the selection is cleared.
The parameters are not order dependent. That is, setSelectionInterval(x, y) is equivalent to setSelectionInterval(y, x).
index0 - the first index in the range to select
index1 - the last index in the range to select
public void addSelectionInterval(int index0,
int index1)
10, and this method is invoked with
-1, 20, then the specified indices bounds the viewable range, and this is treated as if invoked with
0, 9. On the other hand, if this were invoked with
-10, -1, then the specified indices do not bound the viewable set of rows, and the selection is unchanged.
The parameters are not order dependent. That is, addSelectionInterval(x, y) is equivalent to addSelectionInterval(y, x).
index0 - the first index in the range to add to the selection
index1 - the last index in the range to add to the selection
public void removeSelectionInterval(int index0,
int index1)
10, and this method is invoked with
-1, 20, then the specified range bounds the viewable range, and this is treated as if invoked with
0, 9. On the other hand, if this were invoked with
-10, -1, then the specified range does not bound the viewable set of rows, and the selection is unchanged.
The parameters are not order dependent. That is, removeSelectionInterval(x, y) is equivalent to removeSelectionInterval(y, x).
index0 - the first row to remove from the selection
index1 - the last row to remove from the selection
public void removeSelectionPath(TreePathpath)
path - the
TreePath identifying a node
public void removeSelectionPaths(TreePath[] paths)
paths - an array of
TreePath objects that specifies the nodes to remove
public void removeSelectionRow(int row)
row from the current selection.
row - the row to remove
public void removeSelectionRows(int[] rows)
rows - an array of ints specifying display rows, where 0 is the first row in the display
public void clearSelection()
public boolean isSelectionEmpty()
public void addTreeExpansionListener(TreeExpansionListenertel)
TreeExpansion events.
tel - a TreeExpansionListener that will be notified when a tree node is expanded or collapsed (a "negative expansion")
public void removeTreeExpansionListener(TreeExpansionListenertel)
TreeExpansion events.
tel - the
TreeExpansionListener to remove
public TreeExpansionListener[] getTreeExpansionListeners()
TreeExpansionListeners added to this JTree with addTreeExpansionListener().
TreeExpansionListeners added or an empty array if no listeners have been added
public void addTreeWillExpandListener(TreeWillExpandListenertel)
TreeWillExpand events.
tel - a
TreeWillExpandListener that will be notified when a tree node will be expanded or collapsed (a "negative expansion")
public void removeTreeWillExpandListener(TreeWillExpandListenertel)
TreeWillExpand events.
tel - the
TreeWillExpandListener to remove
public TreeWillExpandListener[] getTreeWillExpandListeners()
TreeWillExpandListeners added to this JTree with addTreeWillExpandListener().
TreeWillExpandListeners added or an empty array if no listeners have been added
public void fireTreeExpanded(TreePathpath)
path parameter.
path - the
TreePath indicating the node that was expanded
EventListenerList
public void fireTreeCollapsed(TreePathpath)
path parameter.
path - the
TreePath indicating the node that was collapsed
EventListenerList
public void fireTreeWillExpand(TreePathpath) throws ExpandVetoException
path parameter.
path - the
TreePath indicating the node that was expanded
ExpandVetoException
EventListenerList
public void fireTreeWillCollapse(TreePathpath) throws ExpandVetoException
path parameter.
path - the
TreePath indicating the node that was expanded
ExpandVetoException
EventListenerList
public void addTreeSelectionListener(TreeSelectionListenertsl)
TreeSelection events.
tsl - the
TreeSelectionListener that will be notified when a node is selected or deselected (a "negative selection")
public void removeTreeSelectionListener(TreeSelectionListenertsl)
TreeSelection listener.
tsl - the
TreeSelectionListener to remove
public TreeSelectionListener[] getTreeSelectionListeners()
TreeSelectionListeners added to this JTree with addTreeSelectionListener().
TreeSelectionListeners added or an empty array if no listeners have been added
protected void fireValueChanged(TreeSelectionEvente)
e - the
TreeSelectionEvent to be fired; generated by the
TreeSelectionModel when a node is selected or deselected
EventListenerList
public void treeDidChange()
public void setVisibleRowCount(int newCount)
JScrollPane, and will adjust the preferred size and size of that scrollpane.
This is a bound property.
newCount - the number of rows to display
public int getVisibleRowCount()
public TreePathgetNextMatch(String prefix, int startingRow, Position .Bias bias)
TreePath into a String,
convertValueToText is used.
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.
IllegalArgumentException - if prefix is null or startingRow is out of bounds
public DimensiongetPreferredScrollableViewportSize()
JTree. The height is determined from
getVisibleRowCount and the width is the current preferred width.
getPreferredScrollableViewportSize in interface
Scrollable
Dimension object containing the preferred size
JComponent.getPreferredSize()
public int getScrollableUnitIncrement(RectanglevisibleRect, int orientation, int direction)
getScrollableUnitIncrement in interface
Scrollable
visibleRect - the view area visible within the viewport
orientation - either
SwingConstants.VERTICAL or
SwingConstants.HORIZONTAL
direction - less than zero to scroll up/left, greater than zero for down/right
JScrollBar.setUnitIncrement(int)
public int getScrollableBlockIncrement(RectanglevisibleRect, int orientation, int direction)
visibleRect, based on
orientation.
getScrollableBlockIncrement in interface
Scrollable
visibleRect - the view area visible within the viewport
orientation - either
SwingConstants.VERTICAL or
SwingConstants.HORIZONTAL
direction - less than zero to scroll up/left, greater than zero for down/right.
JScrollBar.setBlockIncrement(int)
public boolean getScrollableTracksViewportWidth()
getScrollableTracksViewportWidth in interface
Scrollable
Scrollable.getScrollableTracksViewportWidth()
public boolean getScrollableTracksViewportHeight()
getScrollableTracksViewportHeight in interface
Scrollable
Scrollable.getScrollableTracksViewportHeight()
protected void setExpandedState(TreePathpath, boolean state)
JTree. If
state is true, all parents of
path and path are marked as expanded. If
state is false, all parents of
path are marked EXPANDED, but
path itself is marked collapsed.
This will fail if a TreeWillExpandListener vetos it.
protected Enumeration<TreePath > getDescendantToggledPaths(TreePath parent)
Enumeration of
TreePaths that have been expanded that are descendants of
parent.
protected void removeDescendantToggledPaths(Enumeration<TreePath > toRemove)
TreePaths in
toRemove that have been expanded.
toRemove - an enumeration of the paths to remove; a value of
null is ignored
ClassCastException - if
toRemove contains an element that is not a
TreePath;
null values are ignored
protected void clearToggledPaths()
TreeExpansionListener events.
protected TreeModelListenercreateTreeModelListener()
TreeModelHandler. The returned object is responsible for updating the expanded state when the
TreeModel changes.
For more information on what expanded state means, see the JTree description above.
protected boolean removeDescendantSelectedPaths(TreePathpath, boolean includePath)
path. If
includePath is true and
path is selected, it will be removed from the selection.
protected StringparamString()
JTree. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be
null.
paramString in class
JComponent
JTree.
public AccessibleContextgetAccessibleContext()
getAccessibleContext in interface
Accessible
getAccessibleContext in class
Component