Class JXTree

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JTree
org.jdesktop.swingx.JXTree
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, Scrollable
Direct Known Subclasses:
JXTreeTable.TreeTableCellRenderer
@JavaBean public class JXTree extends JTree
Enhanced Tree component with support for SwingX rendering, highlighting, rollover and search functionality.

Rendering and Highlighting

As all SwingX collection views, a JXTree is a HighlighterClient (PENDING JW: formally define and implement, like in AbstractTestHighlighter), that is it provides consistent api to add and remove Highlighters which can visually decorate the rendering component. 


JXTree tree = new JXTree(new FileSystemModel());
// use system file icons and name to render
tree.setCellRenderer(new DefaultTreeRenderer(IconValues.FILE_ICON, 
     StringValues.FILE_NAME));
// highlight condition: file modified after a date     
HighlightPredicate predicate = new HighlightPredicate() {
   public boolean isHighlighted(Component renderer,
                    ComponentAdapter adapter) {
      File file = getUserObject(adapter.getValue());
      return file != null ? lastWeek invalid input: '<' file.lastModified : false;
   }
};
// highlight with foreground color 
tree.addHighlighter(new ColorHighlighter(predicate, null, Color.RED);
Note: for full functionality, a DefaultTreeRenderer must be installed as TreeCellRenderer. This is not done by default, because there are unresolved issues when editing. PENDING JW: still? Check! Note: to support the highlighting this implementation wraps the TreeCellRenderer set by client code with a DelegatingRenderer which applies the Highlighter after delegating the default configuration to the wrappee. As a side-effect, getCellRenderer does return the wrapper instead of the custom renderer. To access the latter, client code must call getWrappedCellRenderer.

Rollover

As all SwingX collection views, a JXTree supports per-cell rollover. If enabled, the component fires rollover events on enter/exit of a cell which by default is promoted to the renderer if it implements RolloverRenderer, that is simulates live behaviour. The rollover events can be used by client code as well, f.i. to decorate the rollover row using a Highlighter. 

JXTree tree = new JXTree();
tree.setRolloverEnabled(true);
tree.setCellRenderer(new DefaultTreeRenderer());
tree.addHighlighter(new ColorHighlighter(HighlightPredicate.ROLLOVER_ROW, 
     null, Color.RED);

Search

As all SwingX collection views, a JXTree is searchable. A search action is registered in its ActionMap under the key "find". The default behaviour is to ask the SearchFactory to open a search component on this component. The default keybinding is retrieved from the SearchFactory, typically ctrl-f (or cmd-f for Mac). Client code can register custom actions and/or bindings as appropriate.

JXTree provides api to vend a renderer-controlled String representation of cell content. This allows the Searchable and Highlighters to use WYSIWYM (What-You-See-Is-What-You-Match), that is pattern matching against the actual string as seen by the user.

Miscellaneous

  • Improved usability for editing: guarantees that the tree is the focusOwner if editing terminated by user gesture and guards against data corruption if focusLost while editing
  • Access methods for selection colors, for consistency with JXTable, JXList
  • Convenience methods and actions to expand, collapse all nodes
See Also:

  • Field Details

    • LOG

      private static final Logger LOG

    • EMPTY_INT_ARRAY

      private static final int[] EMPTY_INT_ARRAY
      Empty int array used in getSelectedRows().

    • EMPTY_TREEPATH_ARRAY

      private static final TreePath[] EMPTY_TREEPATH_ARRAY
      Empty TreePath used in getSelectedPath() if selection empty.

    • compoundHighlighter

      protected CompoundHighlighter compoundHighlighter
      Collection of active Highlighters.

    • highlighterChangeListener

      private ChangeListener highlighterChangeListener
      Listener to changes of Highlighters in collection.

    • delegatingRenderer

      private JXTree.DelegatingRenderer delegatingRenderer
      Wrapper around the installed renderer, needed to support Highlighters.

    • rolloverProducer

      private RolloverProducer rolloverProducer
      The RolloverProducer used if rollover is enabled.

    • linkController

      private TreeRolloverController<JXTree> linkController
      The RolloverController used if rollover is enabled.

    • overwriteIcons

      private boolean overwriteIcons

    • searchable

      private Searchable searchable

    • editorRemover

      private JXTree.CellEditorRemover editorRemover
      The propertyChangeListener responsible for terminating edits if focus lost.

    • editorListener

      private CellEditorListener editorListener
      The CellEditorListener responsible to force the focus back to the tree after terminating edits.

    • selectionForeground

      private Color selectionForeground
      Color of selected foreground. Added for consistent api across collection components.

    • selectionBackground

      private Color selectionBackground
      Color of selected background. Added for consistent api across collection components.

    • dataAdapter

      protected ComponentAdapter dataAdapter

  • Constructor Details

    • JXTree

      public JXTree()
      Constructs a JXTree with a sample model. The default model used by this tree defines a leaf node as any node without children.

    • JXTree

      public JXTree(Object[] value)
      Constructs a JXTree with each element of the specified array as the child of a new root node which is not displayed. By default, this tree defines a leaf node as any node without children. This version of the constructor simply invokes the super class version with the same arguments.
      Parameters:
      value - an array of objects that are children of the root.

    • JXTree

      public JXTree(Vector<?> value)
      Constructs a JXTree with each element of the specified Vector as the child of a new root node which is not displayed. By default, this tree defines a leaf node as any node without children. This version of the constructor simply invokes the super class version with the same arguments.
      Parameters:
      value - an Vector of objects that are children of the root.

    • JXTree

      public JXTree(Hashtable<?,?> value)
      Constructs a JXTree 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. This version of the constructor simply invokes the super class version with the same arguments.
      Parameters:
      value - a Hashtable containing objects that are children of the root.

    • JXTree

      public JXTree(TreeNode root)
      Constructs a JXTree 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. This version of the constructor simply invokes the super class version with the same arguments.
      Parameters:
      root - root node of this tree

    • JXTree

      public JXTree(TreeNode root, boolean asksAllowsChildren)
      Constructs a JXTree 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. This version of the constructor simply invokes the super class version with the same arguments.
      Parameters:
      root - root node of this tree
      asksAllowsChildren - if true, only nodes that do not allow children are leaf nodes; otherwise, any node without children is a leaf node;
      See Also:

    • JXTree

      public JXTree(TreeModel newModel)
      Constructs an instance of JXTree which displays the root node -- the tree is created using the specified data model. This version of the constructor simply invokes the super class version with the same arguments.
      Parameters:
      newModel - the TreeModel to use as the data model

  • Method Details

    • init

      private void init()
      Instantiates JXTree state which is new compared to super. Installs the Delegating renderer and editor, registers actions and keybindings. This must be called from each constructor.

    • createTreeModelListener

      protected TreeModelListener createTreeModelListener()
      Overrides:
      createTreeModelListener in class JTree

    • createFindAction

      private Action createFindAction()
      Creates and returns the action to invoke on a find request.
      Returns:
      the action to invoke on a find request.

    • doFind

      protected void doFind()
      Starts a search on this Tree's visible nodes. This implementation asks the SearchFactory to open a find widget on itself.

    • getSearchable

      public Searchable getSearchable()
      Returns a Searchable for this component, guaranteed to be not null. This implementation lazily creates a TreeSearchable if necessary.
      Returns:
      a not-null Searchable for this component.
      See Also:

    • setSearchable

      public void setSearchable(Searchable searchable)
      Sets the Searchable for this component. If null, a default Searchable will be created and used.
      Parameters:
      searchable - the Searchable to use for this component, may be null to indicate using the default.
      See Also:

    • getStringAt

      public String getStringAt(int row)
      Returns the string representation of the cell value at the given position.
      Parameters:
      row - the row index of the cell in view coordinates
      Returns:
      the string representation of the cell value as it will appear in the table.

    • getStringAt

      public String getStringAt(TreePath path)
      Returns the string representation of the cell value at the given position.
      Parameters:
      path - the TreePath representing the node.
      Returns:
      the string representation of the cell value as it will appear in the table, or null if the path is not visible.

    • getNextMatch

      public TreePath getNextMatch(String prefix, int startingRow, Position.Bias bias)
      Overridden to respect the string representation, if any. This takes over completely (as compared to super), internally messaging the Searchable.

      PENDING JW: re-visit once we support deep node search.

      Overrides:
      getNextMatch in class JTree

    • collapseAll

      public void collapseAll()
      Collapses all nodes in this tree.

    • expandAll

      public void expandAll()
      Expands all nodes in this tree.

      Note: it's not recommended to use this method on the EDT for large/deep trees because expansion can take a considerable amount of time.

    • expandRoot

      private void expandRoot()
      Expands the root path if a TreeModel has been set, does nothing if not.

    • getSelectionRows

      public int[] getSelectionRows()

      Overridden to always return a not-null array (following SwingX convention).

      Overrides:
      getSelectionRows in class JTree

    • getSelectionPaths

      public TreePath[] getSelectionPaths()

      Overridden to always return a not-null array (following SwingX convention).

      Overrides:
      getSelectionPaths in class JTree

    • getSelectionBackground

      public Color getSelectionBackground()
      Returns the background color for selected cells.
      Returns:
      the Color used for the background of selected list items
      See Also:

    • getSelectionForeground

      public Color getSelectionForeground()
      Returns the selection foreground color.
      Returns:
      the Color object for the foreground property
      See Also:

    • setSelectionForeground

      public void setSelectionForeground(Color selectionForeground)
      Sets the foreground color for selected cells. Cell renderers can use this color to render text and graphics for selected cells.

      The default value of this property is defined by the look and feel implementation.

      This is a JavaBeans bound property.

      Parameters:
      selectionForeground - the Color to use in the foreground for selected list items
      See Also:

    • setSelectionBackground

      public void setSelectionBackground(Color selectionBackground)
      Sets the background color for selected cells. Cell renderers can use this color to the fill selected cells.

      The default value of this property is defined by the look and feel implementation.

      This is a JavaBeans bound property.

      Parameters:
      selectionBackground - the Color to use for the background of selected cells
      See Also:

    • updateUI

      public void updateUI()

      Overridden to update selection background/foreground. Mimicking behaviour of ui-delegates for JTable, JList.

      Overrides:
      updateUI in class JTree

    • updateRendererEditorUI

      protected void updateRendererEditorUI()
      Quick fix for #1060-swingx: icons lost on toggling LAF

    • installSelectionColors

      private void installSelectionColors()
      Installs selection colors from UIManager.

      Note: this should be done in the UI delegate.

    • uninstallSelectionColors

      private void uninstallSelectionColors()
      Uninstalls selection colors.

      Note: this should be done in the UI delegate.

    • updateHighlighterUI

      protected void updateHighlighterUI()
      Updates highlighter after updateUI changes.
      See Also:

    • setRolloverEnabled

      public void setRolloverEnabled(boolean rolloverEnabled)
      Sets the property to enable/disable rollover support. If enabled, the list fires property changes on per-cell mouse rollover state, i.e. when the mouse enters/leaves a list cell.

      This can be enabled to show "live" rollover behaviour, f.i. the cursor over a cell rendered by a JXHyperlink.

      The default value is false.

      Parameters:
      rolloverEnabled - a boolean indicating whether or not the rollover functionality should be enabled.
      See Also:

    • isRolloverEnabled

      public boolean isRolloverEnabled()
      Returns a boolean indicating whether or not rollover support is enabled.
      Returns:
      a boolean indicating whether or not rollover support is enabled.
      See Also:

    • getLinkController

      protected TreeRolloverController<JXTree> getLinkController()
      Returns the RolloverController for this component. Lazyly creates the controller if necessary, that is the return value is guaranteed to be not null.

      PENDING JW: rename to getRolloverController

      Returns:
      the RolloverController for this tree, guaranteed to be not null.
      See Also:

    • createLinkController

      protected TreeRolloverController<JXTree> createLinkController()
      Creates and returns a RolloverController appropriate for this tree.
      Returns:
      a RolloverController appropriate for this tree.
      See Also:

    • createRolloverProducer

      protected RolloverProducer createRolloverProducer()
      Creates and returns the RolloverProducer to use with this tree.

      Returns:
      RolloverProducer to use with this tree
      See Also:

    • setHighlighters

      public void setHighlighters(Highlighter... highlighters)
      Sets the Highlighters to the table, replacing any old settings. None of the given Highlighters must be null.

      This is a bound property.

      Note: as of version #1.257 the null constraint is enforced strictly. To remove all highlighters use this method without param.

      Parameters:
      highlighters - zero or more not null highlighters to use for renderer decoration.
      Throws:
      NullPointerException - if array is null or array contains null values.
      See Also:

    • getHighlighters

      public Highlighter[] getHighlighters()
      Returns the Highlighters used by this table. Maybe empty, but guarantees to be never null.
      Returns:
      the Highlighters used by this table, guaranteed to never null.
      See Also:

    • addHighlighter

      public void addHighlighter(Highlighter highlighter)
      Appends a Highlighter to the end of the list of used Highlighters. The argument must not be null.

      Parameters:
      highlighter - the Highlighter to add, must not be null.
      Throws:
      NullPointerException - if Highlighter is null.
      See Also:

    • removeHighlighter

      public void removeHighlighter(Highlighter highlighter)
      Removes the given Highlighter.

      Does nothing if the Highlighter is not contained.

      Parameters:
      highlighter - the Highlighter to remove.
      See Also:

    • getCompoundHighlighter

      protected CompoundHighlighter getCompoundHighlighter()
      Returns the CompoundHighlighter assigned to the table, null if none. PENDING: open up for subclasses again?.
      Returns:
      the CompoundHighlighter assigned to the table.

    • getHighlighterChangeListener

      protected ChangeListener getHighlighterChangeListener()
      Returns the ChangeListener to use with highlighters. Lazily creates the listener.
      Returns:
      the ChangeListener for observing changes of highlighters, guaranteed to be not-null

    • createHighlighterChangeListener

      protected ChangeListener createHighlighterChangeListener()
      Creates and returns the ChangeListener observing Highlighters.

      Here: repaints the table on receiving a stateChanged.

      Returns:
      the ChangeListener defining the reaction to changes of highlighters.

    • setExpandedIcon

      public void setExpandedIcon(Icon expandedIcon)
      Sets the Icon to use for the handle of an expanded node.

      Note: this will only succeed if the current ui delegate is a BasicTreeUI otherwise it will do nothing.

      PENDING JW: incomplete api (no getter) and not a bound property.

      Parameters:
      expandedIcon - the Icon to use for the handle of an expanded node.

    • setCollapsedIcon

      public void setCollapsedIcon(Icon collapsedIcon)
      Sets the Icon to use for the handle of a collapsed node. Note: this will only succeed if the current ui delegate is a BasicTreeUI otherwise it will do nothing. PENDING JW: incomplete api (no getter) and not a bound property.
      Parameters:
      collapsedIcon - the Icon to use for the handle of a collapsed node.

    • setLeafIcon

      public void setLeafIcon(Icon leafIcon)
      Sets the Icon to use for a leaf node.

      Note: this will only succeed if current renderer is a DefaultTreeCellRenderer.

      PENDING JW: this (all setXXIcon) is old api pulled up from the JXTreeTable. Need to review if we really want it - problematic if sharing the same renderer instance across different trees. PENDING JW: incomplete api (no getter) and not a bound property.

      Parameters:
      leafIcon - the Icon to use for a leaf node.

    • setOpenIcon

      public void setOpenIcon(Icon openIcon)
      Sets the Icon to use for an open folder node. Note: this will only succeed if current renderer is a DefaultTreeCellRenderer. PENDING JW: incomplete api (no getter) and not a bound property.
      Parameters:
      openIcon - the Icon to use for an open folder node.

    • setClosedIcon

      public void setClosedIcon(Icon closedIcon)
      Sets the Icon to use for a closed folder node. Note: this will only succeed if current renderer is a DefaultTreeCellRenderer. PENDING JW: incomplete api (no getter) and not a bound property.
      Parameters:
      closedIcon - the Icon to use for a closed folder node.

    • setOverwriteRendererIcons

      public void setOverwriteRendererIcons(boolean overwrite)
      Property to control whether per-tree icons should be copied to the renderer on setCellRenderer.

      The default value is false. PENDING: should update the current renderer's icons when setting to true?

      Parameters:
      overwrite - a boolean to indicate if the per-tree Icons should be copied to the new renderer on setCellRenderer.
      See Also:

    • isOverwriteRendererIcons

      public boolean isOverwriteRendererIcons()
      Returns a boolean indicating whether the per-tree icons should be copied to the renderer on setCellRenderer.
      Returns:
      true if a TreeCellRenderer's icons will be overwritten with the tree's Icons, false if the renderer's icons will be unchanged.
      See Also:

    • getDelegatingRenderer

      private JXTree.DelegatingRenderer getDelegatingRenderer()

    • createDefaultCellRenderer

      protected TreeCellRenderer createDefaultCellRenderer()
      Creates and returns the default cell renderer to use. Subclasses may override to use a different type.

      This implementation returns a renderer of type DefaultTreeCellRenderer. Note: Will be changed to return a renderer of type DefaultTreeRenderer, once WrappingProvider is reasonably stable.

      Returns:
      the default cell renderer to use with this tree.

    • getCellRenderer

      public TreeCellRenderer getCellRenderer()

      Overridden to return the delegating renderer which is wrapped around the original to support highlighting. The returned renderer is of type DelegatingRenderer and guaranteed to not-null

      Overrides:
      getCellRenderer in class JTree
      See Also:

    • getWrappedCellRenderer

      public TreeCellRenderer getWrappedCellRenderer()
      Returns the renderer installed by client code or the default if none has been set.
      Returns:
      the wrapped renderer.
      See Also:

    • setCellRenderer

      public void setCellRenderer(TreeCellRenderer renderer)

      Overridden to wrap the given renderer in a DelegatingRenderer to support highlighting.

      Note: the wrapping implies that the renderer returned from the getCellRenderer is not the renderer as given here, but the wrapper. To access the original, use getWrappedCellRenderer.

      Overrides:
      setCellRenderer in class JTree
      See Also:

    • invalidateCellSizeCache

      public void invalidateCellSizeCache()
      Invalidates cell size caching in the ui delegate. May do nothing if there's no safe (i.e. without reflection) way to message the delegate.

      This implementation calls BasicTreeUI setLeftChildIndent with the old indent if available. Beware: clearing the cache is an undocumented implementation side-effect of the method. Revisit if we ever should have a custom ui delegate.

    • startEditingAtPath

      public void startEditingAtPath(TreePath path)

      Overridden to fix focus issues with editors. This method installs and updates the internal CellEditorRemover which terminates ongoing edits if appropriate. Additionally, it registers a CellEditorListener with the cell editor to grab the focus back to tree, if appropriate.

      Overrides:
      startEditingAtPath in class JTree
      See Also:

    • updateEditorListener

      private void updateEditorListener()
      Hack to grab focus after editing.

    • analyseFocus

      protected void analyseFocus()
      This is called from cell editor listener if edit terminated. Trying to analyse if we should grab the focus back to the tree after. Brittle ... we assume we are the first to get the event, so we can analyse the hierarchy before the editing component is removed.

    • isFocusOwnerDescending

      private boolean isFocusOwnerDescending()
      Returns a boolean to indicate if the current focus owner is descending from this table. Returns false if not editing, otherwise walks the focusOwner hierarchy, taking popups into account.

      PENDING: copied from JXTable ... should be somewhere in a utility class?

      Returns:
      a boolean to indicate if the current focus owner is contained.

    • removeNotify

      public void removeNotify()
      Overridden to release the CellEditorRemover, if any.
      Overrides:
      removeNotify in class JComponent

    • updateEditorRemover

      private void updateEditorRemover()
      Lazily creates and updates the internal CellEditorRemover.

    • setModel

      public void setModel(TreeModel newModel)

      Overridden to initialize the String conversion method of the model, if any.

      PENDING JW: remove - that is an outdated approach?

      Overrides:
      setModel in class JTree

    • getComponentAdapter

      protected ComponentAdapter getComponentAdapter()
      Returns:
      the unconfigured ComponentAdapter.

    • getComponentAdapter

      protected ComponentAdapter getComponentAdapter(int index)
      Convenience to access a configured ComponentAdapter. Note: the column index of the configured adapter is always 0.
      Parameters:
      index - the row index in view coordinates, must be valid.
      Returns:
      the configured ComponentAdapter.