javax.swing.JTree — clojure-interop/javax.swing 1.0.5

A control that displays a set of hierarchical data as an outline. You can find task-oriented documentation and examples of using trees in How to Use Trees, a section in The Java Tutorial.

A specific node in a tree can be identified either by a TreePath (an object that encapsulates a node and all of its ancestors), or by its display row, where each row in the display area displays one node. An expanded node is a non-leaf node (as identified by TreeModel.isLeaf(node) returning false) that will displays its children when all its ancestors are expanded. A collapsed node is one which hides them. A hidden node is one which is under a collapsed ancestor. All of a viewable nodes parents are expanded, but may or may not be displayed. A displayed node is both viewable and in the display area, where it can be seen.

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

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

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

isVisible() makeVisible()

If you are interested in knowing when the selection changes implement the TreeSelectionListener interface and add the instance using the method addTreeSelectionListener. valueChanged will be invoked when the selection changes, that is if the user clicks twice on the same node valueChanged will only be invoked once.

If you are interested in detecting either double-click events or when a user clicks on a node, regardless of whether or not it was selected, we recommend you do the following:

final JTree tree = ...;

MouseListener ml = new MouseAdapter() { public void mousePressed(MouseEvent e) { int selRow = tree.getRowForLocation(e.getX(), e.getY()); TreePath selPath = tree.getPathForLocation(e.getX(), e.getY()); if(selRow != -1) { if(e.getClickCount() == 1) { mySingleClick(selRow, selPath); } else if(e.getClickCount() == 2) { myDoubleClick(selRow, selPath); } } } }; tree.addMouseListener(ml); NOTE: This example obtains both the path and row, but you only need to get the one you're interested in.

To use JTree to display compound nodes (for example, nodes containing both a graphic icon and text), subclass TreeCellRenderer and use setCellRenderer(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: 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 JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

*-anchor-selection-path-property clj

Static Constant.

Bound property name for anchor selection path.

type: java.lang.String

*-cell-editor-property clj

Static Constant.

Bound property name for cellEditor.

type: java.lang.String

*-cell-renderer-property clj

Static Constant.

Bound property name for cellRenderer.

type: java.lang.String

*-editable-property clj

Static Constant.

Bound property name for editable.

type: java.lang.String

*-expands-selected-paths-property clj

Static Constant.

Bound property name for expands selected paths property

type: java.lang.String

*-invokes-stop-cell-editing-property clj

Static Constant.

Bound property name for messagesStopCellEditing.

type: java.lang.String

*-large-model-property clj

Static Constant.

Bound property name for largeModel.

type: java.lang.String

*-lead-selection-path-property clj

Static Constant.

Bound property name for leadSelectionPath.

type: java.lang.String

*-root-visible-property clj

Static Constant.

Bound property name for rootVisible.

type: java.lang.String

*-row-height-property clj

Static Constant.

Bound property name for rowHeight.

type: java.lang.String

*-scrolls-on-expand-property clj

Static Constant.

Bound property name for scrollsOnExpand.

type: java.lang.String

*-selection-model-property clj

Static Constant.

Bound property name for selectionModel.

type: java.lang.String

*-shows-root-handles-property clj

Static Constant.

Bound property name for showsRootHandles.

type: java.lang.String

*-toggle-click-count-property clj

Static Constant.

Bound property name for toggleClickCount.

type: java.lang.String

*-tree-model-property clj

Static Constant.

Bound property name for treeModel.

type: java.lang.String

*-visible-row-count-property clj

Static Constant.

Bound property name for visibleRowCount.

type: java.lang.String

->j-tree clj

(->j-tree)

(->j-tree value)

(->j-tree root asks-allows-children)

Constructor.

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.

root - a TreeNode object - javax.swing.tree.TreeNode asks-allows-children - if false, any node without children is a leaf node; if true, only nodes that do not allow children are leaf nodes - boolean

add-selection-interval clj

(add-selection-interval this index-0 index-1)

Adds the specified rows (inclusive) to the selection. If the specified indices are within the viewable set of rows, or bound the viewable set of rows, then the specified indices are constrained by the viewable set of rows. If the indices are not within the viewable set of rows, or do not bound the viewable set of rows, then the selection is unchanged. For example, if the row count is 10, and this method is invoked with -1, 20, then the specified indices bounds the viewable range, and this is treated as if invoked with 0, 9. On the other hand, if this were invoked with -10, -1, then the specified indices do not bound the viewable set of rows, and the selection is unchanged.

The parameters are not order dependent. That is, addSelectionInterval(x, y) is equivalent to addSelectionInterval(y, x).

index-0 - the first index in the range to add to the selection - int index-1 - the last index in the range to add to the selection - int

add-selection-path clj

(add-selection-path this path)

Adds the node identified by the specified TreePath to the current selection. If any component of the path isn't viewable, and getExpandsSelectedPaths is true it is made viewable.

Note that JTree does not allow duplicate nodes to exist as children under the same parent -- each sibling must be a unique object.

path - the TreePath to add - javax.swing.tree.TreePath

add-selection-paths clj

(add-selection-paths this paths)

Adds each path in the array of paths to the current selection. If any component of any of the paths isn't viewable and getExpandsSelectedPaths is true, it is made viewable.

Note that JTree does not allow duplicate nodes to exist as children under the same parent -- each sibling must be a unique object.

paths - an array of TreePath objects that specifies the nodes to add - javax.swing.tree.TreePath[]

add-selection-row clj

(add-selection-row this row)

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

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

add-selection-rows clj

(add-selection-rows this rows)

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

rows - an array of ints specifying the rows to add, where 0 indicates the first row in the display - int[]

add-tree-expansion-listener clj

(add-tree-expansion-listener this tel)

Adds a listener for TreeExpansion events.

tel - a TreeExpansionListener that will be notified when a tree node is expanded or collapsed (a "negative expansion") - javax.swing.event.TreeExpansionListener

add-tree-selection-listener clj

(add-tree-selection-listener this tsl)

Adds a listener for TreeSelection events.

tsl - the TreeSelectionListener that will be notified when a node is selected or deselected (a "negative selection") - javax.swing.event.TreeSelectionListener

add-tree-will-expand-listener clj

(add-tree-will-expand-listener this tel)

Adds a listener for TreeWillExpand events.

tel - a TreeWillExpandListener that will be notified when a tree node will be expanded or collapsed (a "negative expansion") - javax.swing.event.TreeWillExpandListener

cancel-editing clj

(cancel-editing this)

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

clear-selection clj

(clear-selection this)

Clears the selection.

collapse-path clj

(collapse-path this path)

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

path - the TreePath identifying a node - javax.swing.tree.TreePath

collapse-row clj

(collapse-row this row)

Ensures that the node in the specified row is collapsed.

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

collapsed? clj

(collapsed? this 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.

path - the TreePath to check - javax.swing.tree.TreePath

returns: true if any of the nodes in the node's path are collapsed, false if all nodes in the path are expanded - boolean

convert-value-to-text clj

(convert-value-to-text this value selected expanded leaf row has-focus)

Called by the renderers to convert the specified value to text. This implementation returns value.toString, ignoring all other arguments. To control the conversion, subclass this method and use any of the arguments you need.

value - the Object to convert to text - java.lang.Object selected - true if the node is selected - boolean expanded - true if the node is expanded - boolean leaf - true if the node is a leaf node - boolean row - an integer specifying the node's display row, where 0 is the first row in the display - int has-focus - true if the node has the focus - boolean

returns: the String representation of the node's value - java.lang.String

editable? clj

(editable? this)

Returns true if the tree is editable.

returns: true if the tree is editable - boolean

editing? clj

(editing? this)

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

returns: true if the user is currently editing a node - boolean

expand-path clj

(expand-path this path)

Ensures that the node identified by the specified path is expanded and viewable. If the last item in the path is a leaf, this will have no effect.

path - the TreePath identifying a node - javax.swing.tree.TreePath

expand-row clj

(expand-row this row)

Ensures that the node in the specified row is expanded and viewable.

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

expanded? clj

(expanded? this path)

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

path - the TreePath specifying the node to check - javax.swing.tree.TreePath

returns: false if any of the nodes in the node's path are collapsed, true if all nodes in the path are expanded - boolean

fire-tree-collapsed clj

(fire-tree-collapsed this path)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the path parameter.

path - the TreePath indicating the node that was collapsed - javax.swing.tree.TreePath

fire-tree-expanded clj

(fire-tree-expanded this path)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the path parameter.

path - the TreePath indicating the node that was expanded - javax.swing.tree.TreePath

fire-tree-will-collapse clj

(fire-tree-will-collapse this path)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the path parameter.

path - the TreePath indicating the node that was expanded - javax.swing.tree.TreePath

throws: javax.swing.tree.ExpandVetoException

fire-tree-will-expand clj

(fire-tree-will-expand this path)

Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the path parameter.

path - the TreePath indicating the node that was expanded - javax.swing.tree.TreePath

throws: javax.swing.tree.ExpandVetoException

fixed-row-height? clj

(fixed-row-height? this)

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

returns: true if the height of each row is a fixed size - boolean

get-accessible-context clj

(get-accessible-context this)

Gets the AccessibleContext associated with this JTree. For JTrees, the AccessibleContext takes the form of an AccessibleJTree. A new AccessibleJTree instance is created if necessary.

returns: an AccessibleJTree that serves as the AccessibleContext of this JTree - javax.accessibility.AccessibleContext

get-anchor-selection-path clj

(get-anchor-selection-path this)

Returns the path identified as the anchor.

returns: path identified as the anchor - javax.swing.tree.TreePath

get-cell-editor clj

(get-cell-editor this)

Returns the editor used to edit entries in the tree.

returns: the TreeCellEditor in use, or null if the tree cannot be edited - javax.swing.tree.TreeCellEditor

get-cell-renderer clj

(get-cell-renderer this)

Returns the current TreeCellRenderer that is rendering each cell.

returns: the TreeCellRenderer that is rendering each cell - javax.swing.tree.TreeCellRenderer

get-closest-path-for-location clj

(get-closest-path-for-location this x y)

Returns the path to the node that is closest to x,y. If no nodes are currently viewable, or there is no model, returns null, otherwise it always returns a valid path. To test if the node is exactly at x, y, get the node's bounds and test x, y against that.

x - an integer giving the number of pixels horizontally from the left edge of the display area, minus any left margin - int y - an integer giving the number of pixels vertically from the top of the display area, minus any top margin - int

returns: the TreePath for the node closest to that location, null if nothing is viewable or there is no model - javax.swing.tree.TreePath

get-closest-row-for-location clj

(get-closest-row-for-location this x y)

Returns the row to the node that is closest to x,y. If no nodes are viewable or there is no model, returns -1. Otherwise, it always returns a valid row. To test if the returned object is exactly at x, y, get the bounds for the node at the returned row and test x, y against that.

x - an integer giving the number of pixels horizontally from the left edge of the display area, minus any left margin - int y - an integer giving the number of pixels vertically from the top of the display area, minus any top margin - int

returns: the row closest to the location, -1 if nothing is viewable or there is no model - int

get-drag-enabled? clj

(get-drag-enabled? this)

Returns whether or not automatic drag handling is enabled.

returns: the value of the dragEnabled property - boolean

get-drop-location clj

(get-drop-location this)

Returns the location that this component should visually indicate as the drop location during a DnD operation over the component, or null if no location is to currently be shown.

This method is not meant for querying the drop location from a TransferHandler, as the drop location is only set after the TransferHandler's canImport has returned and has allowed for the location to be shown.

When this property changes, a property change event with name "dropLocation" is fired by the component.

returns: the drop location - javax.swing.JTree$DropLocation

get-drop-mode clj

(get-drop-mode this)

Returns the drop mode for this component.

returns: the drop mode for this component - javax.swing.DropMode

get-editing-path clj

(get-editing-path this)

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

returns: the TreePath for the node being edited - javax.swing.tree.TreePath

get-expanded-descendants clj

(get-expanded-descendants this parent)

Returns an Enumeration of the descendants of the path parent that are currently expanded. If parent is not currently expanded, this will return null. If you expand/collapse nodes while iterating over the returned Enumeration this may not return all the expanded paths, or may return paths that are no longer expanded.

parent - the path which is to be examined - javax.swing.tree.TreePath

returns: an Enumeration of the descendents of parent, or null if parent is not currently expanded - java.util.Enumeration<javax.swing.tree.TreePath>

get-expands-selected-paths? clj

(get-expands-selected-paths? this)

Returns the expandsSelectedPaths property.

returns: true if selection changes result in the parent path being expanded - boolean

get-invokes-stop-cell-editing? clj

(get-invokes-stop-cell-editing? this)

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

returns: the indicator that tells what happens when editing is interrupted - boolean

get-last-selected-path-component clj

(get-last-selected-path-component this)

Returns the last path component of the selected path. This is a convenience method for getSelectionModel().getSelectionPath().getLastPathComponent(). This is typically only useful if the selection has one path.

returns: the last path component of the selected path, or null if nothing is selected - java.lang.Object

get-lead-selection-path clj

(get-lead-selection-path this)

Returns the path identified as the lead.

returns: path identified as the lead - javax.swing.tree.TreePath

get-lead-selection-row clj

(get-lead-selection-row this)

Returns the row index corresponding to the lead path.

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

get-max-selection-row clj

(get-max-selection-row this)

Returns the largest selected row. If the selection is empty, or none of the selected paths are viewable, -1 is returned.

returns: the largest selected row - int

get-min-selection-row clj

(get-min-selection-row this)

Returns the smallest selected row. If the selection is empty, or none of the selected paths are viewable, -1 is returned.

returns: the smallest selected row - int

get-model clj

(get-model this)

Returns the TreeModel that is providing the data.

returns: the TreeModel that is providing the data - javax.swing.tree.TreeModel

get-next-match clj

(get-next-match this prefix starting-row bias)

Returns the TreePath to the next tree element that begins with a prefix. To handle the conversion of a TreePath into a String, convertValueToText is used.

prefix - the string to test for a match - java.lang.String starting-row - the row for starting the search - int bias - the search direction, either Position.Bias.Forward or Position.Bias.Backward. - javax.swing.text.Position$Bias

returns: the TreePath of the next tree element that starts with the prefix; otherwise null - javax.swing.tree.TreePath

throws: java.lang.IllegalArgumentException - if prefix is null or startingRow is out of bounds

get-path-bounds clj

(get-path-bounds this path)

Returns the Rectangle that the specified node will be drawn into. Returns null if any component in the path is hidden (under a collapsed parent).

Note: This method returns a valid rectangle, even if the specified node is not currently displayed.

path - the TreePath identifying the node - javax.swing.tree.TreePath

returns: the Rectangle the node is drawn in, or null - java.awt.Rectangle

get-path-for-location clj

(get-path-for-location this x y)

Returns the path for the node at the specified location.

x - an integer giving the number of pixels horizontally from the left edge of the display area, minus any left margin - int y - an integer giving the number of pixels vertically from the top of the display area, minus any top margin - int

returns: the TreePath for the node at that location - javax.swing.tree.TreePath

get-path-for-row clj

(get-path-for-row this row)

Returns the path for the specified row. If row is not visible, or a TreeUI has not been set, null is returned.

row - an integer specifying a row - int

returns: the TreePath to the specified node, null if row < 0 or row >= getRowCount() - javax.swing.tree.TreePath

get-preferred-scrollable-viewport-size clj

(get-preferred-scrollable-viewport-size this)

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

returns: a Dimension object containing the preferred size - java.awt.Dimension

get-row-bounds clj

(get-row-bounds this row)

Returns the 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 - int

returns: the Rectangle the node is drawn in - java.awt.Rectangle

get-row-count clj

(get-row-count this)

Returns the number of viewable nodes. A node is viewable if all of its parents are expanded. The root is only included in this count if isRootVisible() is true. This returns 0 if the UI has not been set.

returns: the number of viewable nodes - int

get-row-for-location clj

(get-row-for-location this x y)

Returns the row for the specified location.

x - an integer giving the number of pixels horizontally from the left edge of the display area, minus any left margin - int y - an integer giving the number of pixels vertically from the top of the display area, minus any top margin - int

returns: the row corresponding to the location, or -1 if the location is not within the bounds of a displayed cell - int

get-row-for-path clj

(get-row-for-path this path)

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

path - the TreePath identifying a node - javax.swing.tree.TreePath

returns: an integer specifying the display row, where 0 is the first row in the display, or -1 if any of the elements in path are hidden under a collapsed parent. - int

get-row-height clj

(get-row-height this)

Returns the height of each row. If the returned value is less than or equal to 0 the height for each row is determined by the renderer.

returns: int

get-scrollable-block-increment clj

(get-scrollable-block-increment this visible-rect orientation direction)

Returns the amount for a block increment, which is the height or width of visibleRect, based on orientation.

visible-rect - the view area visible within the viewport - java.awt.Rectangle orientation - either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL - int direction - less than zero to scroll up/left, greater than zero for down/right. - int

returns: the "block" increment for scrolling in the specified direction - int

get-scrollable-tracks-viewport-height? clj

(get-scrollable-tracks-viewport-height? this)

Returns false to indicate that the height of the viewport does not determine the height of the table, unless the preferred height of the tree is smaller than the viewports height. In other words: ensure that the tree is never smaller than its viewport.

returns: whether the tree should track the height of the viewport - boolean

get-scrollable-tracks-viewport-width? clj

(get-scrollable-tracks-viewport-width? this)

Returns false to indicate that the width of the viewport does not determine the width of the table, unless the preferred width of the tree is smaller than the viewports width. In other words: ensure that the tree is never smaller than its viewport.

returns: whether the tree should track the width of the viewport - boolean

get-scrollable-unit-increment clj

(get-scrollable-unit-increment this visible-rect orientation direction)

Returns the amount to increment when scrolling. The amount is the height of the first displayed row that isn't completely in view or, if it is totally displayed, the height of the next row in the scrolling direction.

visible-rect - the view area visible within the viewport - java.awt.Rectangle orientation - either SwingConstants.VERTICAL or SwingConstants.HORIZONTAL - int direction - less than zero to scroll up/left, greater than zero for down/right - int

returns: the "unit" increment for scrolling in the specified direction - int

get-scrolls-on-expand? clj

(get-scrolls-on-expand? this)

Returns the value of the scrollsOnExpand property.

returns: the value of the scrollsOnExpand property - boolean

get-selection-count clj

(get-selection-count this)

Returns the number of nodes selected.

returns: the number of nodes selected - int

get-selection-model clj

(get-selection-model this)

Returns the model for selections. This should always return a non-null value. If you don't want to allow anything to be selected set the selection model to null, which forces an empty selection model to be used.

returns: javax.swing.tree.TreeSelectionModel

get-selection-path clj

(get-selection-path this)

Returns the path to the first selected node.

returns: the TreePath for the first selected node, or null if nothing is currently selected - javax.swing.tree.TreePath

get-selection-paths clj

(get-selection-paths this)

Returns the paths of all selected values.

returns: an array of TreePath objects indicating the selected nodes, or null if nothing is currently selected - javax.swing.tree.TreePath[]

get-selection-rows clj

(get-selection-rows this)

Returns all of the currently selected rows. This method is simply forwarded to the TreeSelectionModel. If nothing is selected null or an empty array will be returned, based on the TreeSelectionModel implementation.

returns: an array of integers that identifies all currently selected rows where 0 is the first row in the display - int[]

get-shows-root-handles? clj

(get-shows-root-handles? this)

Returns the value of the showsRootHandles property.

returns: the value of the showsRootHandles property - boolean

get-toggle-click-count clj

(get-toggle-click-count this)

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

returns: number of mouse clicks before node is expanded - int

get-tool-tip-text clj

(get-tool-tip-text this event)

Overrides JComponent's getToolTipText method in order to allow renderer's tips to be used if it has text set.

NOTE: For JTree to properly display tooltips of its renderers, JTree must be a registered component with the ToolTipManager. This can be done by invoking ToolTipManager.sharedInstance().registerComponent(tree). This is not done automatically!

event - the MouseEvent that initiated the ToolTip display - java.awt.event.MouseEvent

returns: a string containing the tooltip or null if event is null - java.lang.String

get-tree-expansion-listeners clj

(get-tree-expansion-listeners this)

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

returns: all of the TreeExpansionListeners added or an empty array if no listeners have been added - javax.swing.event.TreeExpansionListener[]

get-tree-selection-listeners clj

(get-tree-selection-listeners this)

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

returns: all of the TreeSelectionListeners added or an empty array if no listeners have been added - javax.swing.event.TreeSelectionListener[]

get-tree-will-expand-listeners clj

(get-tree-will-expand-listeners this)

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

returns: all of the TreeWillExpandListeners added or an empty array if no listeners have been added - javax.swing.event.TreeWillExpandListener[]

get-ui clj

(get-ui this)

Returns the L&F object that renders this component.

returns: the TreeUI object that renders this component - javax.swing.plaf.TreeUI

get-ui-class-id clj

(get-ui-class-id this)

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

returns: the string "TreeUI" - java.lang.String

get-visible-row-count clj

(get-visible-row-count this)

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

returns: the number of rows displayed - int

has-been-expanded? clj

(has-been-expanded? this path)

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

path - javax.swing.tree.TreePath

returns: true if the path has ever been expanded - boolean

large-model? clj

(large-model? this)

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

returns: true if a large model is suggested - boolean

make-visible clj

(make-visible this path)

Ensures that the node identified by path is currently viewable.

path - the TreePath to make visible - javax.swing.tree.TreePath

path-editable? clj

(path-editable? this path)

Returns isEditable. This is invoked from the UI before editing begins to insure that the given path can be edited. This is provided as an entry point for subclassers to add filtered editing without having to resort to creating a new editor.

path - javax.swing.tree.TreePath

returns: true if every parent node and the node itself is editable - boolean

path-selected? clj

(path-selected? this path)

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

path - a TreePath identifying a node - javax.swing.tree.TreePath

returns: true if the node is selected - boolean

remove-selection-interval clj

(remove-selection-interval this index-0 index-1)

Removes the specified rows (inclusive) from the selection. If the specified indices are within the viewable set of rows, or bound the viewable set of rows, then the specified indices are constrained by the viewable set of rows. If the specified indices are not within the viewable set of rows, or do not bound the viewable set of rows, then the selection is unchanged. For example, if the row count is 10, and this method is invoked with -1, 20, then the specified range bounds the viewable range, and this is treated as if invoked with 0, 9. On the other hand, if this were invoked with -10, -1, then the specified range does not bound the viewable set of rows, and the selection is unchanged.

The parameters are not order dependent. That is, removeSelectionInterval(x, y) is equivalent to removeSelectionInterval(y, x).

index-0 - the first row to remove from the selection - int index-1 - the last row to remove from the selection - int

remove-selection-path clj

(remove-selection-path this path)

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

path - the TreePath identifying a node - javax.swing.tree.TreePath

remove-selection-paths clj

(remove-selection-paths this paths)

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

paths - an array of TreePath objects that specifies the nodes to remove - javax.swing.tree.TreePath[]

remove-selection-row clj

(remove-selection-row this row)

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

row - the row to remove - int

remove-selection-rows clj

(remove-selection-rows this rows)

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

rows - an array of ints specifying display rows, where 0 is the first row in the display - int[]

remove-tree-expansion-listener clj

(remove-tree-expansion-listener this tel)

Removes a listener for TreeExpansion events.

tel - the TreeExpansionListener to remove - javax.swing.event.TreeExpansionListener

remove-tree-selection-listener clj

(remove-tree-selection-listener this tsl)

Removes a TreeSelection listener.

tsl - the TreeSelectionListener to remove - javax.swing.event.TreeSelectionListener

remove-tree-will-expand-listener clj

(remove-tree-will-expand-listener this tel)

Removes a listener for TreeWillExpand events.

tel - the TreeWillExpandListener to remove - javax.swing.event.TreeWillExpandListener

root-visible? clj

(root-visible? this)

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

returns: true if the root node of the tree is displayed - boolean

row-selected? clj

(row-selected? this row)

Returns true if the node identified by row is selected.

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

returns: true if the node is selected - boolean

scroll-path-to-visible clj

(scroll-path-to-visible this path)

Makes sure all the path components in path are expanded (except for the last path component) and scrolls so that the node identified by the path is displayed. Only works when this JTree is contained in a JScrollPane.

path - the TreePath identifying the node to bring into view - javax.swing.tree.TreePath

scroll-row-to-visible clj

(scroll-row-to-visible this row)

Scrolls the item identified by row until it is displayed. The minimum of amount of scrolling necessary to bring the row into view is performed. Only works when this JTree is contained in a JScrollPane.

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

selection-empty? clj

(selection-empty? this)

Returns true if the selection is currently empty.

returns: true if the selection is currently empty - boolean

set-anchor-selection-path clj

(set-anchor-selection-path this new-path)

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

This is a bound property.

new-path - the new anchor path - javax.swing.tree.TreePath

set-cell-editor clj

(set-cell-editor this cell-editor)

Sets the cell editor. A null value implies that the tree cannot be edited. If this represents a change in the cellEditor, the propertyChange method is invoked on all listeners.

This is a bound property.

cell-editor - the TreeCellEditor to use - javax.swing.tree.TreeCellEditor

set-cell-renderer clj

(set-cell-renderer this x)

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

This is a bound property.

x - the TreeCellRenderer that is to render each cell - javax.swing.tree.TreeCellRenderer

set-drag-enabled clj

(set-drag-enabled this b)

Turns on or off automatic drag handling. In order to enable automatic drag handling, this property should be set to true, and the tree's TransferHandler needs to be non-null. The default value of the dragEnabled property is false.

The job of honoring this property, and recognizing a user drag gesture, lies with the look and feel implementation, and in particular, the tree's TreeUI. When automatic drag handling is enabled, most look and feels (including those that subclass BasicLookAndFeel) begin a drag and drop operation whenever the user presses the mouse button over an item and then moves the mouse a few pixels. Setting this property to true can therefore have a subtle effect on how selections behave.

If a look and feel is used that ignores this property, you can still begin a drag and drop operation by calling exportAsDrag on the tree's TransferHandler.

b - whether or not to enable automatic drag handling - boolean

throws: java.awt.HeadlessException - if b is true and GraphicsEnvironment.isHeadless() returns true

set-drop-mode clj

(set-drop-mode this drop-mode)

Sets the drop mode for this component. For backward compatibility, the default for this property is DropMode.USE_SELECTION. Usage of one of the other modes is recommended, however, for an improved user experience. DropMode.ON, for instance, offers similar behavior of showing items as selected, but does so without affecting the actual selection in the tree.

JTree supports the following drop modes:

DropMode.USE_SELECTION
DropMode.ON
DropMode.INSERT
DropMode.ON_OR_INSERT

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

drop-mode - the drop mode to use - javax.swing.DropMode

throws: java.lang.IllegalArgumentException - if the drop mode is unsupported or null

set-editable clj

(set-editable this flag)

Determines whether the tree is editable. Fires a property change event if the new setting is different from the existing setting.

This is a bound property.

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

set-expands-selected-paths clj

(set-expands-selected-paths this new-value)

Configures the expandsSelectedPaths property. If true, any time the selection is changed, either via the TreeSelectionModel, or the cover methods provided by JTree, the TreePaths parents will be expanded to make them visible (visible meaning the parent path is expanded, not necessarily in the visible rectangle of the JTree). If false, when the selection changes the nodes parent is not made visible (all its parents expanded). This is useful if you wish to have your selection model maintain paths that are not always visible (all parents expanded).

This is a bound property.

new-value - the new value for expandsSelectedPaths - boolean

set-invokes-stop-cell-editing clj

(set-invokes-stop-cell-editing this new-value)

Determines what happens when editing is interrupted by selecting another node in the tree, a change in the tree's data, or by some other means. Setting this property to true causes the changes to be automatically saved when editing is interrupted.

Fires a property change for the INVOKES_STOP_CELL_EDITING_PROPERTY.

new-value - true means that stopCellEditing is invoked when editing is interrupted, and data is saved; false means that cancelCellEditing is invoked, and changes are lost - boolean

set-large-model clj

(set-large-model this new-value)

Specifies whether the UI should use a large model. (Not all UIs will implement this.) Fires a property change for the LARGE_MODEL_PROPERTY.

This is a bound property.

new-value - true to suggest a large model to the UI - boolean

set-lead-selection-path clj

(set-lead-selection-path this new-path)

Sets the path identifies as the lead. The lead may not be selected. The lead is not maintained by JTree, rather the UI will update it.

This is a bound property.

new-path - the new lead path - javax.swing.tree.TreePath

set-model clj

(set-model this new-model)

Sets the TreeModel that will provide the data.

This is a bound property.

new-model - the TreeModel that is to provide the data - javax.swing.tree.TreeModel

set-root-visible clj

(set-root-visible this root-visible)

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

This is a bound property.

root-visible - true if the root node of the tree is to be displayed - boolean

set-row-height clj

(set-row-height this row-height)

Sets the height of each cell, in pixels. If the specified value is less than or equal to zero the current cell renderer is queried for each row's height.

This is a bound property.

row-height - the height of each cell, in pixels - int

set-scrolls-on-expand clj

(set-scrolls-on-expand this new-value)

Sets the scrollsOnExpand property, which determines whether the tree might scroll to show previously hidden children. If this property is true (the default), when a node expands the tree can use scrolling to make the maximum possible number of the node's descendants visible. In some look and feels, trees might not need to scroll when expanded; those look and feels will ignore this property.

This is a bound property.

new-value - false to disable scrolling on expansion; true to enable it - boolean

set-selection-interval clj

(set-selection-interval this index-0 index-1)

Selects the rows in the specified interval (inclusive). If the specified indices are within the viewable set of rows, or bound the viewable set of rows, then the specified rows are constrained by the viewable set of rows. If the specified indices are not within the viewable set of rows, or do not bound the viewable set of rows, then the selection is cleared. For example, if the row count is 10, and this method is invoked with -1, 20, then the specified indices bounds the viewable range, and this is treated as if invoked with 0, 9. On the other hand, if this were invoked with -10, -1, then the specified indices do not bound the viewable set of rows, and the selection is cleared.

The parameters are not order dependent. That is, setSelectionInterval(x, y) is equivalent to setSelectionInterval(y, x).

index-0 - the first index in the range to select - int index-1 - the last index in the range to select - int

set-selection-model clj

(set-selection-model this selection-model)

Sets the tree's selection model. When a null value is specified an empty selectionModel is used, which does not allow selections.

This is a bound property.

selection-model - the TreeSelectionModel to use, or null to disable selections - javax.swing.tree.TreeSelectionModel

set-selection-path clj

(set-selection-path this path)

Selects the node identified by the specified path. If any component of the path is hidden (under a collapsed node), and getExpandsSelectedPaths is true it is exposed (made viewable).

path - the TreePath specifying the node to select - javax.swing.tree.TreePath

set-selection-paths clj

(set-selection-paths this paths)

Selects the nodes identified by the specified array of paths. If any component in any of the paths is hidden (under a collapsed node), and getExpandsSelectedPaths is true it is exposed (made viewable).

paths - an array of TreePath objects that specifies the nodes to select - javax.swing.tree.TreePath[]

set-selection-row clj

(set-selection-row this row)

Selects the node at the specified row in the display.

row - the row to select, where 0 is the first row in the display - int

set-selection-rows clj

(set-selection-rows this rows)

Selects the nodes corresponding to each of the specified rows in the display. If a particular element of rows is < 0 or >= getRowCount, it will be ignored. If none of the elements in rows are valid rows, the selection will be cleared. That is it will be as if clearSelection was invoked.

rows - an array of ints specifying the rows to select, where 0 indicates the first row in the display - int[]

set-shows-root-handles clj

(set-shows-root-handles this new-value)

Sets the value of the showsRootHandles property, which specifies whether the node handles should be displayed. The default value of this property depends on the constructor used to create the JTree. Some look and feels might not support handles; they will ignore this property.

This is a bound property.

new-value - true if root handles should be displayed; otherwise, false - boolean

set-toggle-click-count clj

(set-toggle-click-count this click-count)

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

This is a bound property.

click-count - int

set-ui clj

(set-ui this ui)

Sets the L&F object that renders this component.

This is a bound property.

ui - the TreeUI L&F object - javax.swing.plaf.TreeUI

set-visible-row-count clj

(set-visible-row-count this new-count)

Sets the number of rows that are to be displayed. This will only work if the tree is contained in a JScrollPane, and will adjust the preferred size and size of that scrollpane.

This is a bound property.

new-count - the number of rows to display - int

start-editing-at-path clj

(start-editing-at-path this path)

Selects the node identified by the specified path and initiates editing. The edit-attempt fails if the CellEditor does not allow editing for the specified item.

path - the TreePath identifying a node - javax.swing.tree.TreePath

stop-editing clj

(stop-editing this)

Ends the current editing session. (The DefaultTreeCellEditor object saves any edits that are currently in progress on a cell. Other implementations may operate differently.) Has no effect if the tree isn't being edited.

Note: To make edit-saves automatic whenever the user changes their position in the tree, use setInvokesStopCellEditing(boolean).

returns: true if editing was in progress and is now stopped, false if editing was not in progress - boolean

tree-did-change clj

(tree-did-change this)

Sent when the tree has changed enough that we need to resize the bounds, but not enough that we need to remove the expanded node set (e.g nodes were expanded or collapsed, or nodes were inserted into the tree). You should never have to invoke this, the UI will invoke this as it needs to.

update-ui clj

(update-ui this)

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

visible? clj

(visible? this path)

Returns true if the value identified by path is currently viewable, which means it is either the root or all of its parents are expanded. Otherwise, this method returns false.

path - javax.swing.tree.TreePath

returns: true if the node is viewable, otherwise false - boolean