org.jdesktop.swingx
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

public class JXTree
extends JTree

JXTree. PENDING: support filtering/sorting.

See Also:

Serialized Form

Nested Class Summary

class	JXTree.CellEditorRemover This class tracks changes in the keyboard focus state.
class	JXTree.DelegatingRenderer A decorator for the original TreeCellRenderer.
protected static class	JXTree.TreeAdapter
class	JXTree.TreeRolloverController<T extends JTree> listens to rollover properties.
class	JXTree.TreeSearchable A searchable targetting the visible rows of a JXTree.
protected class	JXTree.XTreeModelHandler Listens to the model and updates the expandedState accordingly when nodes are removed, or changed.

Nested classes/interfaces inherited from class javax.swing.JTree

JTree.AccessibleJTree, JTree.DynamicUtilTreeNode, JTree.EmptySelectionModel, JTree.TreeModelHandler, JTree.TreeSelectionRedirector

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.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected CompoundHighlighter	compoundHighlighter
protected ComponentAdapter	dataAdapter
protected FilterPipeline	filters

Fields inherited from class javax.swing.JTree

ANCHOR_SELECTION_PATH_PROPERTY, CELL_EDITOR_PROPERTY, CELL_RENDERER_PROPERTY, cellEditor, cellRenderer, editable, EDITABLE_PROPERTY, EXPANDS_SELECTED_PATHS_PROPERTY, INVOKES_STOP_CELL_EDITING_PROPERTY, invokesStopCellEditing, LARGE_MODEL_PROPERTY, largeModel, LEAD_SELECTION_PATH_PROPERTY, ROOT_VISIBLE_PROPERTY, rootVisible, ROW_HEIGHT_PROPERTY, rowHeight, SCROLLS_ON_EXPAND_PROPERTY, scrollsOnExpand, SELECTION_MODEL_PROPERTY, selectionModel, selectionRedirector, SHOWS_ROOT_HANDLES_PROPERTY, showsRootHandles, TOGGLE_CLICK_COUNT_PROPERTY, toggleClickCount, TREE_MODEL_PROPERTY, treeModel, treeModelListener, VISIBLE_ROW_COUNT_PROPERTY, 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

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

JXTree()
Constructs a JXTree with a sample model.

JXTree(Hashtable value)
Constructs a JXTree created from a Hashtable which does not display with root.

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.

JXTree(TreeModel newModel)
Constructs an instance of JXTree which displays the root node -- the tree is created using the specified data model.

JXTree(TreeNode root)
Constructs a JXTree with the specified TreeNode as its root, which displays the root node.

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.

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.

Method Summary

void	addHighlighter(Highlighter highlighter) Adds a Highlighter.
protected void	analyseFocus() This is called from cell editor listener if edit terminated.
void	collapseAll() Collapses all nodes in the tree table.
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 TreeCellRenderer	createDefaultCellRenderer() Creates and returns the default cell renderer to use.
protected JXTree.TreeRolloverController	createLinkController()
protected RolloverProducer	createRolloverProducer() creates and returns the RolloverProducer to use with this tree.
protected TreeModelListener	createTreeModelListener() Creates and returns an instance of TreeModelHandler.
protected void	doFind()
void	expandAll() Expands all nodes in the tree table.
TreeCellRenderer	getCellRenderer() Returns the current TreeCellRenderer that is rendering each cell.
protected ComponentAdapter	getComponentAdapter()
protected ComponentAdapter	getComponentAdapter(int index) Convenience to access a configured ComponentAdapter.
Highlighter[]	getHighlighters() Returns the Highlighters used by this tree.
protected JXTree.TreeRolloverController	getLinkController()
Searchable	getSearchable()
TreePath[]	getSelectionPaths() overridden to always return a not-null array (following SwingX convention).
int[]	getSelectionRows() overridden to always return a not-null array (following SwingX convention).
String	getStringAt(int row) Returns the string representation of the cell value at the given position.
String	getStringAt(TreePath path) Returns the string representation of the cell value at the given position.
protected Method	getValueConversionMethod(TreeModel model) Tries to find and return a method for Object --> to String conversion on the model by reflection.
TreeCellRenderer	getWrappedCellRenderer() Returns the renderer installed by client code or the default if none has been set.
boolean	isOverwriteRendererIcons() Returns a boolean indicating whether the per-tree icons should be copied to the renderer on setCellRenderer.
boolean	isRolloverEnabled() returns the rolloverEnabled property.
void	removeHighlighter(Highlighter highlighter) Removes the given Highlighter.
void	removeNotify() Overridden to release the CellEditorRemover, if any.
void	setCellRenderer(TreeCellRenderer renderer) Sets the TreeCellRenderer that will be used to draw each cell.
void	setClosedIcon(Icon closedIcon) Sets the Icon to use for a closed folder node.
void	setCollapsedIcon(Icon collapsedIcon) Sets the Icon to use for the handle of a collapsed node.
void	setExpandedIcon(Icon expandedIcon) Sets the Icon to use for the handle of an expanded node.
void	setHighlighters(Highlighter... highlighters) Sets the Highlighters to the table, replacing any old settings.
void	setLeafIcon(Icon leafIcon) Sets the Icon to use for a leaf node.
void	setModel(TreeModel newModel) Sets the TreeModel that will provide the data.
void	setOpenIcon(Icon openIcon) Sets the Icon to use for an open folder node.
void	setOverwriteRendererIcons(boolean overwrite) Property to control whether per-tree icons should be copied to the renderer on setCellRenderer.
void	setRolloverEnabled(boolean rolloverEnabled) Property to enable/disable rollover support.
void	setSearchable(Searchable searchable) sets the Searchable for this editor.
void	startEditingAtPath(TreePath path) Selects the node identified by the specified path and initiates editing.

Methods inherited from class javax.swing.JTree

addSelectionInterval, addSelectionPath, addSelectionPaths, addSelectionRow, addSelectionRows, addTreeExpansionListener, addTreeSelectionListener, addTreeWillExpandListener, cancelEditing, clearSelection, clearToggledPaths, collapsePath, collapseRow, createTreeModel, expandPath, expandRow, fireTreeCollapsed, fireTreeExpanded, fireTreeWillCollapse, fireTreeWillExpand, fireValueChanged, getAccessibleContext, getAnchorSelectionPath, getCellEditor, getClosestPathForLocation, getClosestRowForLocation, getDefaultTreeModel, getDescendantToggledPaths, getDragEnabled, getEditingPath, getExpandedDescendants, getExpandsSelectedPaths, getInvokesStopCellEditing, getLastSelectedPathComponent, getLeadSelectionPath, getLeadSelectionRow, getMaxSelectionRow, getMinSelectionRow, getModel, getNextMatch, getPathBetweenRows, getPathBounds, getPathForLocation, getPathForRow, getPreferredScrollableViewportSize, getRowBounds, getRowCount, getRowForLocation, getRowForPath, getRowHeight, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollsOnExpand, getSelectionCount, getSelectionModel, getSelectionPath, getShowsRootHandles, getToggleClickCount, getToolTipText, getTreeExpansionListeners, getTreeSelectionListeners, getTreeWillExpandListeners, getUI, getUIClassID, getVisibleRowCount, hasBeenExpanded, isCollapsed, isCollapsed, isEditable, isEditing, isExpanded, isExpanded, isFixedRowHeight, isLargeModel, isPathEditable, isPathSelected, isRootVisible, isRowSelected, isSelectionEmpty, isVisible, makeVisible, paramString, removeDescendantSelectedPaths, removeDescendantToggledPaths, removeSelectionInterval, removeSelectionPath, removeSelectionPaths, removeSelectionRow, removeSelectionRows, removeTreeExpansionListener, removeTreeSelectionListener, removeTreeWillExpandListener, scrollPathToVisible, scrollRowToVisible, setAnchorSelectionPath, setCellEditor, setDragEnabled, setEditable, setExpandedState, setExpandsSelectedPaths, setInvokesStopCellEditing, setLargeModel, setLeadSelectionPath, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionInterval, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, stopEditing, treeDidChange, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

filters

protected FilterPipeline filters

compoundHighlighter

protected CompoundHighlighter compoundHighlighter

dataAdapter

protected ComponentAdapter dataAdapter

Constructor Detail

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.