| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
DefaultMutableTreeNode root = …;
Based on 24 examples
Based on 22 examples
public class JTree extends JComponent implements Scrollable, Accessible
A control that displays a set of hierarchical data as an outline. You can find task-oriented documentation and examples of using trees in How to Use Trees, a section in The Java Tutorial.
A specific node in a tree can be identified either by a
TreePath
(an object
that encapsulates a node and all of its ancestors), or by its
display row, where each row in the display area displays one node.
An expanded node is a non-leaf node (as identified by
TreeModel.isLeaf(node)
returning false) that will displays
its children when all its ancestors are expanded.
A collapsed
node is one which hides them. A hidden node is one which is
under a collapsed ancestor. All of a viewable nodes parents
are expanded, but may or may not be displayed. A displayed node
is both viewable and in the display area, where it can be seen.
The following JTree
methods use "visible" to mean "displayed":
isRootVisible()
setRootVisible()
scrollPathToVisible()
scrollRowToVisible()
getVisibleRowCount()
setVisibleRowCount()
The next group of JTree
methods use "visible" to mean
"viewable" (under an expanded parent):
isVisible()
makeVisible()
If you are interested in knowing when the selection changes implement
the TreeSelectionListener
interface and add the instance
using the method addTreeSelectionListener
.
valueChanged
will be invoked when the
selection changes, that is if the user clicks twice on the same
node valueChanged
will only be invoked once.
If you are interested in detecting either double-click events or when a user clicks on a node, regardless of whether or not it was selected, we recommend you do the following:
final JTree tree = ...; MouseListener ml = new MouseAdapter() { public void mousePressed(MouseEvent e) { int selRow = tree.getRowForLocation(e.getX(), e.getY()); TreePath selPath = tree.getPathForLocation(e.getX(), e.getY()); if(selRow != -1) { if(e.getClickCount() == 1) { mySingleClick(selRow, selPath); } else if(e.getClickCount() == 2) { myDoubleClick(selRow, selPath); } } } }; tree.addMouseListener(ml);NOTE: This example obtains both the path and row, but you only need to get the one you're interested in.
To use JTree
to display compound nodes
(for example, nodes containing both
a graphic icon and text), subclass {@link TreeCellRenderer} and use
{@link #setCellRenderer} to tell the tree to use it. To edit such nodes,
subclass {@link TreeCellEditor} and use {@link #setCellEditor}.
Like all JComponent
classes, you can use {@link InputMap} and
{@link ActionMap}
to associate an {@link Action} object with a {@link KeyStroke}
and execute the action under specified conditions.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans
package.
Please see {@link java.beans.XMLEncoder}.
Nested Class Summary | |
---|---|
protected class |
This class implements accessibility support for the JTree class. |
static class |
A subclass of TransferHandler.DropLocation representing
a drop location for a JTree . |
static class |
DynamicUtilTreeNode can wrap
vectors/hashtables/arrays/strings and
create the appropriate children tree nodes as necessary. |
protected static class |
EmptySelectionModel is a TreeSelectionModel
that does not allow anything to be selected. |
protected class |
Listens to the model and updates the expandedState
accordingly when nodes are removed, or changed. |
protected class |
Handles creating a new TreeSelectionEvent with the
JTree as the
source and passing it off to all the listeners. |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Field Summary | |
---|---|
static String |
ANCHOR_SELECTION_PATH_PROPERTY
Bound property name for anchor selection path. |
protected transient TreeCellEditor |
cellEditor
Editor for the entries. |
protected transient TreeCellRenderer |
cellRenderer
The cell used to draw nodes. |
static String |
CELL_EDITOR_PROPERTY
Bound property name for cellEditor . |
static String |
CELL_RENDERER_PROPERTY
Bound property name for cellRenderer . |
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 |
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 |
INVOKES_STOP_CELL_EDITING_PROPERTY
Bound property name for messagesStopCellEditing . |
protected boolean |
largeModel
Is this tree a large model? This is a code-optimization setting. |
static String |
LARGE_MODEL_PROPERTY
Bound property name for largeModel . |
static String |
LEAD_SELECTION_PATH_PROPERTY
Bound property name for leadSelectionPath . |
protected boolean |
rootVisible
True if the root node is displayed, false if its children are the highest visible nodes. |
static String |
ROOT_VISIBLE_PROPERTY
Bound property name for rootVisible . |
protected int |
rowHeight
Height to use for each display row. |
static String |
ROW_HEIGHT_PROPERTY
Bound property name for rowHeight . |
protected boolean |
scrollsOnExpand
If true, when a node is expanded, as many of the descendants are scrolled to be visible. |
static String |
SCROLLS_ON_EXPAND_PROPERTY
Bound property name for scrollsOnExpand . |
protected transient TreeSelectionModel |
selectionModel
Models the set of selected nodes in this tree. |
protected transient JTree.TreeSelectionRedirector |
selectionRedirector
Creates a new event and passed it off the selectionListeners . |
static String |
SELECTION_MODEL_PROPERTY
Bound property name for selectionModel. |
protected boolean |
showsRootHandles
True if handles are displayed at the topmost level of the tree. |
static String |
SHOWS_ROOT_HANDLES_PROPERTY
Bound property name for showsRootHandles . |
protected int |
toggleClickCount
Number of mouse clicks before a node is expanded. |
static String |
TOGGLE_CLICK_COUNT_PROPERTY
Bound property name for toggleClickCount . |
protected transient TreeModel |
treeModel
The model that defines the tree displayed by this object. |
protected transient TreeModelListener |
treeModelListener
Updates the expandedState . |
static String |
TREE_MODEL_PROPERTY
Bound property name for treeModel . |
protected int |
visibleRowCount
Number of rows to make visible at one time. |
static String |
VISIBLE_ROW_COUNT_PROPERTY
Bound property name for visibleRowCount . |
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Constructor Summary | |
---|---|
JTree() Returns a JTree with a sample model.
|
|
Returns a JTree created from a Hashtable
which does not display with root.
|
|
Returns a JTree with each element of the
specified array as the
child of a new root node which is not displayed.
|
|
Returns an instance of JTree which displays the root node
-- the tree is created using the specified data model.
|
|
Returns a JTree with the specified
TreeNode as its root,
which displays the root node.
|
|
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.
|
|
Returns a JTree with each element of the specified
Vector as the
child of a new root node which is not displayed.
|
Method Summary | |
---|---|
void |
addSelectionInterval(int index0, int index1) Adds the paths between index0 and index1, inclusive, to the selection. |
void |
addSelectionPath(TreePath path) Adds the node identified by the specified TreePath
to the current selection.
|
void |
addSelectionPaths(TreePath[] paths) Adds each path in the array of paths to the current selection. |
void |
addSelectionRow(int row) Adds the path at the specified row to the current selection. |
void |
addSelectionRows(int[] rows) Adds the paths at each of the specified rows to the current selection. |
void |
Adds a listener for TreeExpansion events.
|
void |
Adds a listener for TreeSelection events.
|
void |
Adds a listener for TreeWillExpand events.
|
void |
Cancels the current editing session. |
void |
Clears the selection. |
protected void |
Clears the cache of toggled tree paths. |
void |
collapsePath(TreePath path) Ensures that the node identified by the specified path is collapsed and viewable. |
void |
collapseRow(int row) Ensures that the node in the specified row is collapsed. |
String |
convertValueToText(Object value, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus) Called by the renderers to convert the specified value to text. |
protected static TreeModel |
createTreeModel(Object value) Returns a TreeModel wrapping the specified object.
|
protected TreeModelListener |
Creates and returns an instance of TreeModelHandler .
|
void |
expandPath(TreePath path) Ensures that the node identified by the specified path is expanded and viewable. |
void |
expandRow(int row) Ensures that the node in the specified row is expanded and viewable. |
void |
fireTreeCollapsed(TreePath path) Notifies all listeners that have registered interest for notification on this event type. |
void |
fireTreeExpanded(TreePath path) Notifies all listeners that have registered interest for notification on this event type. |
void |
fireTreeWillCollapse(TreePath path) Notifies all listeners that have registered interest for notification on this event type. |
void |
fireTreeWillExpand(TreePath path) Notifies all listeners that have registered interest for notification on this event type. |
protected void |
Notifies all listeners that have registered interest for notification on this event type. |
AccessibleContext |
Gets the AccessibleContext associated with this JTree. |
TreePath |
Returns the path identified as the anchor. |
TreeCellEditor |
Returns the editor used to edit entries in the tree. |
TreeCellRenderer |
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 |
Creates and returns a sample TreeModel .
|
protected Enumeration |
getDescendantToggledPaths(TreePath parent) Returns an Enumeration of TreePaths
that have been expanded that
are descendants of parent .
|
boolean |
Returns whether or not automatic drag handling is enabled. |
JTree.DropLocation |
Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, or if no location is to currently be shown. |
DropMode |
Returns the drop mode for this component. |
TreePath |
Returns the path to the element that is currently being edited. |
Enumeration |
getExpandedDescendants(TreePath parent) Returns an Enumeration of the descendants of the
path parent that
are currently expanded.
|
boolean |
Returns the expandsSelectedPaths property.
|
boolean |
Returns the indicator that tells what happens when editing is interrupted. |
Object |
Returns the last path component in the first node of the current selection. |
TreePath |
Returns the path identified as the lead. |
int |
Returns the row index corresponding to the lead path. |
int |
Returns the last selected row. |
int |
Gets the first selected row. |
TreeModel |
getModel() Returns the TreeModel that is providing the data.
|
TreePath |
getNextMatch(String prefix, int startingRow, Position.Bias bias) Returns the TreePath to the next tree element that begins with a prefix. |
protected TreePath[] |
getPathBetweenRows(int index0, int index1) Returns JTreePath instances representing the path
between index0 and index1 (including index1).
|
Rectangle |
getPathBounds(TreePath path) Returns the Rectangle that the specified node will be drawn
into.
|
TreePath |
getPathForLocation(int x, int y) Returns the path for the node at the specified location. |
TreePath |
getPathForRow(int row) Returns the path for the specified row. |
Dimension |
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 |
Returns the number of rows that are currently being displayed. |
int |
getRowForLocation(int x, int y) Returns the row for the specified location. |
int |
getRowForPath(TreePath path) Returns the row that displays the node identified by the specified path. |
int |
Returns the height of each row. |
int |
getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction) Returns the amount for a block increment, which is the height or width of visibleRect , based on orientation .
|
boolean |
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 |
Returns false to indicate that the width of the viewport does not determine the width of the table, unless the preferred width of the tree is smaller than the viewports width. |
int |
getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) Returns the amount to increment when scrolling. |
boolean |
Returns the value of the scrollsOnExpand property.
|
int |
Returns the number of nodes selected. |
TreeSelectionModel |
Returns the model for selections. |
TreePath |
Returns the path to the first selected node. |
TreePath[] |
Returns the paths of all selected values. |
int[] |
Returns all of the currently selected rows. |
boolean |
Returns the value of the showsRootHandles property.
|
int |
Returns the number of mouse clicks needed to expand or close a node. |
String |
getToolTipText(MouseEvent event) Overrides JComponent 's getToolTipText
method in order to allow
renderer's tips to be used if it has text set.
|
TreeExpansionListener[] |
Returns an array of all the TreeExpansionListener s added
to this JTree with addTreeExpansionListener().
|
TreeSelectionListener[] |
Returns an array of all the TreeSelectionListener s added
to this JTree with addTreeSelectionListener().
|
TreeWillExpandListener[] |
Returns an array of all the TreeWillExpandListener s added
to this JTree with addTreeWillExpandListener().
|
TreeUI |
getUI() Returns the L&F object that renders this component. |
String |
Returns the name of the L&F class that renders this component. |
int |
Returns the number of rows that are displayed in the display area. |
boolean |
hasBeenExpanded(TreePath path) Returns true if the node identified by the path has ever been expanded. |
boolean |
isCollapsed(int row) Returns true if the node at the specified display row is collapsed. |
boolean |
isCollapsed(TreePath path) Returns true if the value identified by path is currently collapsed, this will return false if any of the values in path are currently not being displayed. |
boolean |
Returns true if the tree is editable. |
boolean |
Returns true if the tree is being edited. |
boolean |
isExpanded(int row) Returns true if the node at the specified display row is currently expanded. |
boolean |
isExpanded(TreePath path) Returns true if the node identified by the path is currently expanded, |
boolean |
Returns true if the height of each display row is a fixed size. |
boolean |
Returns true if the tree is configured for a large model. |
boolean |
isPathEditable(TreePath path) Returns isEditable .
|
boolean |
isPathSelected(TreePath path) Returns true if the item identified by the path is currently selected. |
boolean |
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 |
Returns true if the selection is currently empty. |
boolean |
Returns true if the value identified by path is currently viewable, which means it is either the root or all of its parents are expanded. |
void |
makeVisible(TreePath path) Ensures that the node identified by path is currently viewable. |
protected String |
Returns a string representation of this JTree .
|
protected boolean |
removeDescendantSelectedPaths(TreePath path, boolean includePath) Removes any paths in the selection that are descendants of path .
|
protected void |
removeDescendantToggledPaths(Enumeration toRemove) Removes any descendants of the TreePaths in
toRemove
that have been expanded.
|
void |
removeSelectionInterval(int index0, int index1) Removes the nodes between index0 and index1, inclusive, from the selection. |
void |
removeSelectionPath(TreePath path) Removes the node identified by the specified path from the current selection. |
void |
removeSelectionPaths(TreePath[] paths) Removes the nodes identified by the specified paths from the current selection. |
void |
removeSelectionRow(int row) Removes the row at the index row from the current
selection.
|
void |
removeSelectionRows(int[] rows) Removes the rows that are selected at each of the specified rows. |
void |
Removes a listener for TreeExpansion events.
|
void |
Removes a TreeSelection listener.
|
void |
Removes a listener for TreeWillExpand events.
|
void |
scrollPathToVisible(TreePath path) Makes sure all the path components in path are expanded (except for the last path component) and scrolls so that the node identified by the path is displayed. |
void |
scrollRowToVisible(int row) Scrolls the item identified by row until it is displayed. |
void |
setAnchorSelectionPath(TreePath newPath) Sets the path identified as the anchor. |
void |
setCellEditor(TreeCellEditor cellEditor) Sets the cell editor. |
void |
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 dropMode) Sets the drop mode for this component. |
void |
setEditable(boolean flag) Determines whether the tree is editable. |
protected void |
setExpandedState(TreePath path, boolean state) Sets the expanded state of this 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 newPath) Sets the path identifies as the lead. |
void |
Sets the TreeModel that will provide the data.
|
void |
setRootVisible(boolean rootVisible) Determines whether or not the root node from the TreeModel is visible.
|
void |
setRowHeight(int rowHeight) Sets the height of each cell, in pixels. |
void |
setScrollsOnExpand(boolean newValue) Sets the scrollsOnExpand property,
which determines whether the
tree might scroll to show previously hidden children.
|
void |
setSelectionInterval(int index0, int index1) Selects the nodes between index0 and index1, inclusive. |
void |
setSelectionModel(TreeSelectionModel selectionModel) Sets the tree's selection model. |
void |
setSelectionPath(TreePath path) Selects the node identified by the specified path. |
void |
setSelectionPaths(TreePath[] paths) Selects the nodes identified by the specified array of paths. |
void |
setSelectionRow(int row) Selects the node at the specified row in the display. |
void |
setSelectionRows(int[] rows) Selects the nodes corresponding to each of the specified rows in the display. |
void |
setShowsRootHandles(boolean newValue) Sets the value of the showsRootHandles property,
which specifies whether the node handles should be displayed.
|
void |
setToggleClickCount(int clickCount) Sets the number of mouse clicks before a node will expand or close. |
void |
Sets the L&F object that renders this component. |
void |
setVisibleRowCount(int newCount) Sets the number of rows that are to be displayed. |
void |
startEditingAtPath(TreePath path) Selects the node identified by the specified path and initiates editing. |
boolean |
Ends the current editing session. |
void |
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.
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String ANCHOR_SELECTION_PATH_PROPERTY
protected transient TreeCellEditor cellEditor
null
(tree is not editable).
protected transient TreeCellRenderer cellRenderer
null
, the UI uses a default
cellRenderer
.
public static final String CELL_EDITOR_PROPERTY
cellEditor
.
public static final String CELL_RENDERER_PROPERTY
cellRenderer
.
protected boolean editable
public static final String EDITABLE_PROPERTY
editable
.
public static final String EXPANDS_SELECTED_PATHS_PROPERTY
protected boolean invokesStopCellEditing
stopCellEditing
is invoked, and changes are saved. If false,
cancelCellEditing
is invoked, and changes
are discarded. Default is false.
public static final String INVOKES_STOP_CELL_EDITING_PROPERTY
messagesStopCellEditing
.
protected boolean largeModel
This value is only a suggestion to the UI. Not all UIs will take advantage of it. Default value is false.
public static final String LARGE_MODEL_PROPERTY
largeModel
.
public static final String LEAD_SELECTION_PATH_PROPERTY
leadSelectionPath
.
protected boolean rootVisible
public static final String ROOT_VISIBLE_PROPERTY
rootVisible
.
protected int rowHeight
public static final String ROW_HEIGHT_PROPERTY
rowHeight
.
protected boolean scrollsOnExpand
public static final String SCROLLS_ON_EXPAND_PROPERTY
scrollsOnExpand
.
protected transient TreeSelectionModel selectionModel
protected transient JTree.TreeSelectionRedirector selectionRedirector
selectionListeners
.
public static final String SELECTION_MODEL_PROPERTY
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.
public static final String SHOWS_ROOT_HANDLES_PROPERTY
showsRootHandles
.
protected int toggleClickCount
public static final String TOGGLE_CLICK_COUNT_PROPERTY
toggleClickCount
.
protected transient TreeModel treeModel
protected transient TreeModelListener treeModelListener
expandedState
.
public static final String TREE_MODEL_PROPERTY
treeModel
.
protected int visibleRowCount
Scrollable
interface. It determines the preferred
size of the display area.
public static final String VISIBLE_ROW_COUNT_PROPERTY
visibleRowCount
.
Constructor Detail |
---|
public JTree()
JTree
with a sample model.
The default model used by the tree defines a leaf node as any node
without children.
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
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 Object
spublic JTree(TreeModel newModel)
JTree
which displays the root node
-- the tree is created using the specified data model.
newModel
- the TreeModel
to use as the data modelpublic JTree(TreeNode root)
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
objectpublic JTree(TreeNode root, 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
objectasksAllowsChildren
- if false, any node without children is a
leaf node; if true, only nodes that do not allow
children are leaf nodespublic 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
Method Detail |
---|
public void addSelectionInterval(int index0, int index1)
index0
- an integer specifying a display row, where 0 is the
first row in the displayindex1
- an integer specifying a second display rowpublic void addSelectionPath(TreePath path)
TreePath
to the current selection. If any component of the path isn't
viewable, and getExpandsSelectedPaths
is true it is
made viewable.
Note that JTree
does not allow duplicate nodes to
exist as children under the same parent -- each sibling must be
a unique object.
path
- the TreePath
to addpublic void addSelectionPaths(TreePath[] paths)
getExpandsSelectedPaths
is true, it is
made viewable.
Note that JTree
does not allow duplicate nodes to
exist as children under the same parent -- each sibling must be
a unique object.
paths
- an array of TreePath
objects that specifies
the nodes to addpublic void addSelectionRow(int row)
row
- an integer specifying the row of the node to add,
where 0 is the first row in the displaypublic void addSelectionRows(int[] rows)
rows
- an array of ints specifying the rows to add,
where 0 indicates the first row in the displaypublic void addTreeExpansionListener(TreeExpansionListener tel)
TreeExpansion
events.
tel
- a TreeExpansionListener that will be notified when
a tree node is expanded or collapsed (a "negative
expansion")public void addTreeSelectionListener(TreeSelectionListener tsl)
TreeSelection
events.
tsl
- the TreeSelectionListener
that will be notified
when a node is selected or deselected (a "negative
selection")public void addTreeWillExpandListener(TreeWillExpandListener tel)
TreeWillExpand
events.
tel
- a TreeWillExpandListener
that will be notified
when a tree node will be expanded or collapsed (a "negative
expansion")public void cancelEditing()
public void clearSelection()
protected void clearToggledPaths()
TreeExpansionListener
events.
public void collapsePath(TreePath path)
path
- the TreePath
identifying a nodepublic 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 displaypublic String convertValueToText(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 textselected
- true if the node is selectedexpanded
- true if the node is expandedleaf
- true if the node is a leaf noderow
- an integer specifying the node's display row, where 0 is
the first row in the displayhasFocus
- true if the node has the focusString
representation of the node's valueprotected static TreeModel createTreeModel(Object value)
TreeModel
wrapping the specified object.
If the object is:Object
s,
Hashtable
, or
Vector
value
- the Object
used as the foundation for
the TreeModel
TreeModel
wrapping the specified objectprotected TreeModelListener createTreeModelListener()
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.
public void expandPath(TreePath path)
path
- the TreePath
identifying a nodepublic 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 displaypublic void fireTreeCollapsed(TreePath path)
path
parameter.
path
- the TreePath
indicating the node that was
collapsedpublic void fireTreeExpanded(TreePath path)
path
parameter.
path
- the TreePath
indicating the node that was
expandedpublic void fireTreeWillCollapse(TreePath path) throws ExpandVetoException
path
parameter.
path
- the TreePath
indicating the node that was
expandedExpandVetoException
public void fireTreeWillExpand(TreePath path) throws ExpandVetoException
path
parameter.
path
- the TreePath
indicating the node that was
expandedExpandVetoException
protected void fireValueChanged(TreeSelectionEvent e)
e
- the TreeSelectionEvent
to be fired;
generated by the
TreeSelectionModel
when a node is selected or deselectedpublic AccessibleContext getAccessibleContext()
getAccessibleContext
in class JComponent
public TreePath getAnchorSelectionPath()
public TreeCellEditor getCellEditor()
TreeCellEditor
in use,
or null
if the tree cannot be editedpublic TreeCellRenderer getCellRenderer()
TreeCellRenderer
that is rendering each cell.
TreeCellRenderer
that is rendering each cellpublic TreePath getClosestPathForLocation(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 marginy
- an integer giving the number of pixels vertically from
the top of the display area, minus any top marginTreePath
for the node closest to that location,
null
if nothing is viewable or there is no modelpublic 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 marginy
- an integer giving the number of pixels vertically from
the top of the display area, minus any top marginprotected static TreeModel getDefaultTreeModel()
TreeModel
.
Used primarily for beanbuilders to show something interesting.
TreeModel
protected Enumeration getDescendantToggledPaths(TreePath parent)
Enumeration
of TreePaths
that have been expanded that
are descendants of parent
.
parent
public boolean getDragEnabled()
public final JTree.DropLocation getDropLocation()
This method is not meant for querying the drop location
from a {@code TransferHandler}, as the drop location is only
set after the {@code 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.
public final DropMode getDropMode()
public TreePath getEditingPath()
TreePath
for the node being editedpublic Enumeration 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 examinedEnumeration
of the descendents of
parent
, or null
if
parent
is not currently expandedpublic boolean getExpandsSelectedPaths()
expandsSelectedPaths
property.
public boolean getInvokesStopCellEditing()
public Object getLastSelectedPathComponent()
Object
in the first selected node's
TreePath
,
or null
if nothing is selectedpublic TreePath getLeadSelectionPath()
public int getLeadSelectionRow()
leadPath
is null
public int getMaxSelectionRow()
public int getMinSelectionRow()
public TreeModel getModel()
TreeModel
that is providing the data.
TreeModel
that is providing the datapublic TreePath getNextMatch(String prefix, int startingRow, Position.Bias bias)
TreePath
into a String, convertValueToText
is used.
prefix
- the string to test for a matchstartingRow
- the row for starting the searchbias
- the search direction, either
Position.Bias.Forward or Position.Bias.Backward.protected TreePath[] getPathBetweenRows(int index0, int index1)
JTreePath
instances representing the path
between index0 and index1 (including index1).
Returns null
if there is no tree.
index0
- an integer specifying a display row, where 0 is the
first row in the displayindex1
- an integer specifying a second display rowTreePath
objects, one for each
node between index0 and index1, inclusive; or null
if there is no treepublic Rectangle getPathBounds(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 nodeRectangle
the node is drawn in,
or null
public TreePath getPathForLocation(int x, int y)
x
- an integer giving the number of pixels horizontally from
the left edge of the display area, minus any left marginy
- an integer giving the number of pixels vertically from
the top of the display area, minus any top marginTreePath
for the node at that locationpublic TreePath getPathForRow(int row)
row
is
not visible, null
is returned.
row
- an integer specifying a rowTreePath
to the specified node,
null
if row < 0
or row > getRowCount()
public Dimension getPreferredScrollableViewportSize()
JTree
. The height is
determined from getVisibleRowCount
and the width
is the current preferred width.
Dimension
object containing the preferred sizepublic Rectangle getRowBounds(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
displayRectangle
the node is drawn inpublic int getRowCount()
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 marginy
- an integer giving the number of pixels vertically from
the top of the display area, minus any top marginpublic int getRowForPath(TreePath path)
path
- the TreePath
identifying a nodepublic int getRowHeight()
public int getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
visibleRect
, based on orientation
.
visibleRect
- the view area visible within the viewportorientation
- either SwingConstants.VERTICAL
or SwingConstants.HORIZONTAL
direction
- less than zero to scroll up/left,
greater than zero for down/right.public boolean getScrollableTracksViewportHeight()
public boolean getScrollableTracksViewportWidth()
public int getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
visibleRect
- the view area visible within the viewportorientation
- either SwingConstants.VERTICAL
or SwingConstants.HORIZONTAL
direction
- less than zero to scroll up/left,
greater than zero for down/rightpublic boolean getScrollsOnExpand()
scrollsOnExpand
property.
scrollsOnExpand
propertypublic int getSelectionCount()
public TreeSelectionModel getSelectionModel()
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.
public TreePath getSelectionPath()
TreePath
for the first selected node,
or null
if nothing is currently selectedpublic TreePath[] getSelectionPaths()
TreePath
objects indicating the selected
nodes, or null
if nothing is currently selectedpublic int[] getSelectionRows()
TreeSelectionModel
.
If nothing is selected null
or an empty array will
be returned, based on the TreeSelectionModel
implementation.
public boolean getShowsRootHandles()
showsRootHandles
property.
showsRootHandles
propertypublic int getToggleClickCount()
public String getToolTipText(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
displaynull
if event
is nullpublic TreeExpansionListener[] getTreeExpansionListeners()
TreeExpansionListener
s added
to this JTree with addTreeExpansionListener().
TreeExpansionListener
s added or an empty
array if no listeners have been addedpublic TreeSelectionListener[] getTreeSelectionListeners()
TreeSelectionListener
s added
to this JTree with addTreeSelectionListener().
TreeSelectionListener
s added or an empty
array if no listeners have been addedpublic TreeWillExpandListener[] getTreeWillExpandListeners()
TreeWillExpandListener
s added
to this JTree with addTreeWillExpandListener().
TreeWillExpandListener
s added or an empty
array if no listeners have been addedpublic TreeUI getUI()
TreeUI
object that renders this componentpublic String getUIClassID()
getUIClassID
in class JComponent
public int getVisibleRowCount()
public boolean hasBeenExpanded(TreePath path)
path
path
has ever been expandedpublic boolean isCollapsed(int row)
row
- the row to check, where 0 is the first row in the
displaypublic boolean isCollapsed(TreePath path)
path
- the TreePath
to checkpublic boolean isEditable()
public boolean isEditing()
getSelectionPath
.
public boolean isExpanded(int row)
row
- the row to check, where 0 is the first row in the
displaypublic boolean isExpanded(TreePath path)
path
- the TreePath
specifying the node to checkpublic boolean isFixedRowHeight()
public boolean isLargeModel()
public boolean isPathEditable(TreePath path)
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.
path
public boolean isPathSelected(TreePath path)
path
- a TreePath
identifying a nodepublic boolean isRootVisible()
public boolean isRowSelected(int row)
row
- an integer specifying a display row, where 0 is the first
row in the displaypublic boolean isSelectionEmpty()
public boolean isVisible(TreePath path)
path
public void makeVisible(TreePath path)
path
- the TreePath
to make visibleprotected String paramString()
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
.protected boolean removeDescendantSelectedPaths(TreePath path, boolean includePath)
path
. If includePath
is true and
path
is selected, it will be removed from the selection.
path
includePath
protected void removeDescendantToggledPaths(Enumeration toRemove)
TreePaths
in
toRemove
that have been expanded.
toRemove
public void removeSelectionInterval(int index0, int index1)
index0
- an integer specifying a display row, where 0 is the
first row in the displayindex1
- an integer specifying a second display rowpublic void removeSelectionPath(TreePath path)
path
- the TreePath
identifying a nodepublic void removeSelectionPaths(TreePath[] paths)
paths
- an array of TreePath
objects that
specifies the nodes to removepublic void removeSelectionRow(int row)
row
from the current
selection.
row
- the row to removepublic void removeSelectionRows(int[] rows)
rows
- an array of ints specifying display rows, where 0 is
the first row in the displaypublic void removeTreeExpansionListener(TreeExpansionListener tel)
TreeExpansion
events.
tel
- the TreeExpansionListener
to removepublic void removeTreeSelectionListener(TreeSelectionListener tsl)
TreeSelection
listener.
tsl
- the TreeSelectionListener
to removepublic void removeTreeWillExpandListener(TreeWillExpandListener tel)
TreeWillExpand
events.
tel
- the TreeWillExpandListener
to removepublic void scrollPathToVisible(TreePath path)
JTree
is contained in a JScrollPane
.
path
- the TreePath
identifying the node to
bring into viewpublic 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 displaypublic void setAnchorSelectionPath(TreePath newPath)
JTree
, rather the UI will
update it.
newPath
- the new anchor pathpublic void setCellEditor(TreeCellEditor cellEditor)
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.
cellEditor
- the TreeCellEditor
to usepublic void setCellRenderer(TreeCellRenderer x)
TreeCellRenderer
that will be used to
draw each cell.
x
- the TreeCellRenderer
that is to render each cellpublic void setDragEnabled(boolean b)
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 {@code TreeUI}. When automatic drag handling is enabled, most look and feels (including those that subclass {@code 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 {@code 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 {@code exportAsDrag} on the tree's {@code TransferHandler}.
b
- whether or not to enable automatic drag handlingpublic final void setDropMode(DropMode dropMode)
DropMode.USE_SELECTION
.
Usage of one of the other modes is recommended, however, for an
improved user experience. DropMode.ON
, for instance,
offers similar behavior of showing items as selected, but does so without
affecting the actual selection in the tree.
JTree
supports the following drop modes:
DropMode.USE_SELECTION
DropMode.ON
DropMode.INSERT
DropMode.ON_OR_INSERT
The drop mode is only meaningful if this component has a
TransferHandler
that accepts drops.
dropMode
- the drop mode to usepublic void setEditable(boolean flag)
flag
- a boolean value, true if the tree is editableprotected void setExpandedState(TreePath path, 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.
path
state
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 TreePath
s parents will be
expanded to make them visible (visible meaning the parent path is
expanded, not necessarily in the visible rectangle of the
JTree
). If false, when the selection
changes the nodes parent is not made visible (all its parents expanded).
This is useful if you wish to have your selection model maintain paths
that are not always visible (all parents expanded).
newValue
- the new value for expandsSelectedPaths
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 lostpublic void setLargeModel(boolean newValue)
newValue
- true to suggest a large model to the UIpublic void setLeadSelectionPath(TreePath newPath)
JTree
,
rather the UI will update it.
newPath
- the new lead pathpublic void setModel(TreeModel newModel)
TreeModel
that will provide the data.
newModel
- the TreeModel
that is to provide the datapublic void setRootVisible(boolean rootVisible)
TreeModel
is visible.
rootVisible
- true if the root node of the tree is to be displayedpublic void setRowHeight(int rowHeight)
rowHeight
- the height of each cell, in pixelspublic 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.
newValue
- false
to disable scrolling on expansion;
true
to enable itpublic void setSelectionInterval(int index0, int index1)
index0
- an integer specifying a display row, where 0 is the
first row in the displayindex1
- an integer specifying a second display rowpublic void setSelectionModel(TreeSelectionModel selectionModel)
null
value is
specified an empty
selectionModel
is used, which does not allow selections.
selectionModel
- the TreeSelectionModel
to use,
or null
to disable selectionspublic void setSelectionPath(TreePath path)
getExpandsSelectedPaths
is true it is
exposed (made viewable).
path
- the TreePath
specifying the node to selectpublic void setSelectionPaths(TreePath[] paths)
getExpandsSelectedPaths
is true
it is exposed (made viewable).
paths
- an array of TreePath
objects that specifies
the nodes to selectpublic void setSelectionRow(int row)
row
- the row to select, where 0 is the first row in
the displaypublic 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 displaypublic 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.
newValue
- true
if root handles should be displayed;
otherwise, false
public void setToggleClickCount(int clickCount)
clickCount
public void setUI(TreeUI ui)
ui
- the TreeUI
L&F objectpublic void setVisibleRowCount(int newCount)
JScrollPane
,
and will adjust the preferred size and size of that scrollpane.
newCount
- the number of rows to displaypublic void startEditingAtPath(TreePath path)
CellEditor
does not allow
editing for the specified item.
path
- the TreePath
identifying a nodepublic 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, use {@link #setInvokesStopCellEditing}.
public void treeDidChange()
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
| |||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |