xdev.ui

Class XdevTree

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

xdev.ui.XdevTree

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, Persistable, XdevFocusCycleComponent

@BeanSettings(useXdevCustomizer=true)
public class XdevTree
extends JTree
implements XdevFocusCycleComponent, Persistable

The standard tree in XDEV. Based on JTree.

Since:

2.0

Author:

XDEV Software

See Also:

JTree, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	XdevTree.XdevTreeUI

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

JTree.AccessibleJTree, JTree.DropLocation, 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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSED_FOLDER_ICON_PROPERTY
static String	HOLE_LINE_TREE_PROPERTY
static String	LEAF_ICON_PROPERTY
static String	OPEN_FOLDER_ICON_PROPERTY
static String	PAINT_TREE_LINES_PROPERTY

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

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

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface xdev.ui.XdevFocusCycleComponent

TAB_INDEX_PROPERTY

Fields inherited from interface xdev.ui.persistence.Persistable

VALUE_SEPARATOR

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
XdevTree() Constructs a XdevTree that is initialized with DefaultTreeModel and a DefaultXdevTreeManager.
XdevTree(TreeModel model) Constructs a XdevTree that is initialized with model as the data model and a DefaultXdevTreeManager.
XdevTree(XdevTreeNode root) Constructs a XdevTree that is initialized with XdevTreeModel and a DefaultXdevTreeManager.

Method Summary

Modifier and Type	Method and Description
void	collapseAll() Ensures that all nodes in this XdevTree are collapsed.
void	collapseNode(XdevTreeNode node) Ensures that the node is collapsed and viewable.
void	collapsePath(Collection<?> path) Ensures that the node identified by the specified path is collapsed and viewable.
void	expandAll() Expand all nodes of this XdevTree.
void	expandAll(TreeNode node) Expand all nodes which the DefaultMutableTreeNode contains.
void	expandNode(XdevTreeNode node) Ensures that the node is expanded and viewable.
void	expandPath(List<?> path) Ensures that the node identified by the specified path is expanded and viewable.
Icon	getClosedFolderIcon() Returns the Icon of the closed folder nodes.
boolean	getHoleLineTree() Gets the holeLineTree property.
Icon	getLeafIcon() Returns the Icon of the leaf nodes.
XdevTreeNode	getNodeAt(int x, int y) Returns the XdevTreeNode at the specified location.
Icon	getOpenFolderIcon() Returns the Icon of the open folder nodes.
boolean	getPaintTreeLines() Gets the paintTreeLines property.
String	getPersistentId() Uses the name of the component as a persistent id.
Dimension	getPreferredScrollableViewportSize()
XdevTreeNode	getRoot() Returns the root of the tree.
XdevTreeNode	getSelectedNode() Returns the first selected XdevTreeNode.
List<DefaultMutableTreeNode>	getSelectedNodes() Returns a List of all selected nodes.
int	getSelectionMode() Returns the current selection mode.
List<?>	getSelectionPathAsList()
List<List<?>>	getSelectionPathsAsList()
int	getTabIndex() Returns the tabindex assigned to this component.
XdevTreeManager	getTreeManager() Returns the XdevTreeManager of this XdevTree.
boolean	isPersistenceEnabled() Flag, indicates, if the gui state for this component should be persisted.
void	loadPersistentState(String persistentState) Restores this Components persistent state.
String	savePersistentState() Generates a String representation of this Components persistent state and returns it for being stored.
void	setClosedFolderIcon(Icon closedFolderIcon) Sets the Icon which render the closed folder nodes.
void	setDefaultTreeManager() Sets a DefaultXdevTreeManager as tree manager for this XdevTree.
void	setForeground(Color fg)
void	setHoleLineTree(boolean holeLineTree) Sets the hole line tree property.
void	setLeafIcon(Icon leafIcon) Sets the Icon which render the leaf nodes.
void	setModel(VirtualTable vt, String rootsColumnName, Object rootsID, String idColumnName, String ownerColumnName, String captionColumnName, String dataColumnName) Creates a tree model for this tree containing data of the VirtualTable vt by creating XdevTreeNodes out of VirtualTable.VirtualTableRows.
void	setModel(VirtualTable vt, String rootsColumnName, Object rootsID, String idColumnName, String ownerColumnName, String captionColumnName, String dataColumnName, boolean multipleRoots) Creates a tree model for this tree containing data of the VirtualTable vt by creating XdevTreeNodes out of VirtualTable.VirtualTableRows.
void	setOpenFolderIcon(Icon openFolderIcon) Sets the Icon which render the open folder nodes.
void	setPaintTreeLines(boolean paintTreeLines) Sets the paintTreeLines property.
void	setPersistenceEnabled(boolean persistenceEnabled) Sets the persistenceEnabled flag.
void	setRoot(TreeNode root)
void	setSelectedNode(XdevTreeNode node) Selects the node identified by the given node.
void	setSelectedNodes(Collection<? extends DefaultMutableTreeNode> nodes) Selects all nodes identified by the given Collection.
void	setSelectionMode(int mode) Sets the selection model, which must be one of SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION in TreeSelectionModel.
void	setSelectionPath(Collection<?> path) Selects the node identified by the given path.
void	setSelectionPaths(Collection<?> path) Sets the selection by creating TreePaths out of path .
void	setTabIndex(int tabIndex) Sets the tabindex of this component.
void	setTreeManager(XdevTreeManager manager) Sets the tree manager for this XdevTree.
String	toString()
void	updateUI()

Methods inherited from class javax.swing.JTree

addSelectionInterval, addSelectionPath, addSelectionPaths, addSelectionRow, addSelectionRows, addTreeExpansionListener, addTreeSelectionListener, addTreeWillExpandListener, cancelEditing, clearSelection, clearToggledPaths, collapsePath, collapseRow, convertValueToText, createTreeModel, createTreeModelListener, expandPath, expandRow, fireTreeCollapsed, fireTreeExpanded, fireTreeWillCollapse, fireTreeWillExpand, fireValueChanged, getAccessibleContext, getAnchorSelectionPath, getCellEditor, getCellRenderer, getClosestPathForLocation, getClosestRowForLocation, getDefaultTreeModel, getDescendantToggledPaths, getDragEnabled, getDropLocation, getDropMode, getEditingPath, getExpandedDescendants, getExpandsSelectedPaths, getInvokesStopCellEditing, getLastSelectedPathComponent, getLeadSelectionPath, getLeadSelectionRow, getMaxSelectionRow, getMinSelectionRow, getModel, getNextMatch, getPathBetweenRows, getPathBounds, getPathForLocation, getPathForRow, getRowBounds, getRowCount, getRowForLocation, getRowForPath, getRowHeight, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollsOnExpand, getSelectionCount, getSelectionModel, getSelectionPath, getSelectionPaths, getSelectionRows, 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, setCellRenderer, setDragEnabled, setDropMode, setEditable, setExpandedState, setExpandsSelectedPaths, setInvokesStopCellEditing, setLargeModel, setLeadSelectionPath, setModel, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionInterval, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, startEditingAtPath, stopEditing, treeDidChange

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, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, 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, 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, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

HOLE_LINE_TREE_PROPERTY

public static final String HOLE_LINE_TREE_PROPERTY

See Also:

Constant Field Values

PAINT_TREE_LINES_PROPERTY

public static final String PAINT_TREE_LINES_PROPERTY

See Also:

Constant Field Values

OPEN_FOLDER_ICON_PROPERTY

public static final String OPEN_FOLDER_ICON_PROPERTY

See Also:

Constant Field Values

CLOSED_FOLDER_ICON_PROPERTY

public static final String CLOSED_FOLDER_ICON_PROPERTY

See Also:

Constant Field Values

LEAF_ICON_PROPERTY

public static final String LEAF_ICON_PROPERTY

See Also:

Constant Field Values

Constructor Detail

XdevTree

public XdevTree()

Constructs a XdevTree that is initialized with DefaultTreeModel and a DefaultXdevTreeManager.

See Also:

XdevTree(TreeModel)

XdevTree

public XdevTree(XdevTreeNode root)

Constructs a XdevTree that is initialized with XdevTreeModel and a DefaultXdevTreeManager.

Parameters:

root - a XdevTreeNode object that is the root of the tree

See Also:

XdevTree(TreeModel), XdevTreeNode

XdevTree

public XdevTree(TreeModel model)

Constructs a XdevTree that is initialized with model as the data model and a DefaultXdevTreeManager.

Parameters:

model - the TreeModel to use as the data model

See Also:

JTree(TreeModel), setDefaultTreeManager(), DefaultXdevTreeManager

Method Detail

setRoot

public void setRoot(TreeNode root)

getRoot

public XdevTreeNode getRoot()

Returns the root of the tree.

Returns:

the root of the tree or null if this XdevTree has no nodes or the root is not a instance of XdevTreeNode

getTreeManager

public XdevTreeManager getTreeManager()

Returns the XdevTreeManager of this XdevTree.

Returns:

the XdevTreeManager of this XdevTree. If no valid tree manager is available null is returned

setTreeManager

public void setTreeManager(XdevTreeManager manager)

Sets the tree manager for this XdevTree.
If the given manager is null the method setDefaultTreeManager() is called.

Parameters:

manager - the new XdevTreeManager

setDefaultTreeManager

public void setDefaultTreeManager()

Sets a DefaultXdevTreeManager as tree manager for this XdevTree.

See Also:

JTree.setCellRenderer(TreeCellRenderer), XdevTreeRenderer, DefaultXdevTreeManager

setModel

public void setModel(VirtualTable vt,
                     String rootsColumnName,
                     Object rootsID,
                     String idColumnName,
                     String ownerColumnName,
                     String captionColumnName,
                     String dataColumnName)

Creates a tree model for this tree containing data of the VirtualTable vt by creating XdevTreeNodes out of VirtualTable.VirtualTableRows.

This is a synonym for:

 setModel(vt,rootsColumnName,rootsID,idColumnName,ownerColumnName,captionColumnName,dataColumnName,
                false);
 

For a detailed description see VirtualTable.createTree(String, Object, String, String, String, String, boolean)

Parameters:

vt - the data source

rootsColumnName - the column name for the root condition

rootsID - the value for the root condition

idColumnName - the id column name

ownerColumnName - the referenced owner column name

captionColumnName - the column name for the caption of the nodes

dataColumnName - the data column name, or null if the VirtualTable.VirtualTableRows should be used as data object

setModel

public void setModel(VirtualTable vt,
                     String rootsColumnName,
                     Object rootsID,
                     String idColumnName,
                     String ownerColumnName,
                     String captionColumnName,
                     String dataColumnName,
                     boolean multipleRoots)

Creates a tree model for this tree containing data of the VirtualTable vt by creating XdevTreeNodes out of VirtualTable.VirtualTableRows.

For a detailed description see VirtualTable.createTree(String, Object, String, String, String, String, boolean)

Parameters:

vt - the data source

rootsColumnName - the column name for the root condition

rootsID - the value for the root condition

idColumnName - the id column name

ownerColumnName - the referenced owner column name

captionColumnName - the column name for the caption of the nodes

dataColumnName - the data column name, or null if the VirtualTable.VirtualTableRows should be used as data object

multipleRoots - true for a dummy root with multiple sub-roots, or false for a single root

Since:

3.1

setSelectionMode

public void setSelectionMode(int mode)

Sets the selection model, which must be one of SINGLE_TREE_SELECTION, CONTIGUOUS_TREE_SELECTION or DISCONTIGUOUS_TREE_SELECTION in TreeSelectionModel.

This may change the selection if the current selection is not valid for the new mode. For example, if three TreePaths are selected when the mode is changed to SINGLE_TREE_SELECTION, only one TreePath will remain selected. It is up to the particular implementation to decide what TreePath remains selected.

Parameters:

mode - the new selection mode

See Also:

TreeSelectionModel.setSelectionMode(int)

getSelectionMode

public int getSelectionMode()

Returns the current selection mode.
Possible values in TreeSelectionModel:

• SINGLE_TREE_SELECTION
• CONTIGUOUS_TREE_SELECTION
• DISCONTIGUOUS_TREE_SELECTION

Returns:

the selection mode as int

See Also:

TreeSelectionModel

getSelectionPathAsList

public List<?> getSelectionPathAsList()

Returns:

the objects of the selected path as a list, or null if nothing is selected

setSelectionPath

public void setSelectionPath(Collection<?> path)

Selects the node identified by the given path. If the given path is null the selection is canceled.

Parameters:

path - the Collection with the paths specifying the selection

See Also:

JTree.clearSelection()

getSelectionPathsAsList

public List<List<?>> getSelectionPathsAsList()

Returns:

the objects of the selected paths as lists, or null if nothing is selected

setSelectionPaths

public void setSelectionPaths(Collection<?> path)
                       throws IllegalArgumentException

Sets the selection by creating TreePaths out of path .
Each element of path should be either a TreePath or a Collection.

If path is null or empty the selection is cleared.

Parameters:

path - the path elements

Throws:

IllegalArgumentException - if an element of path isn't either a TreePath nor a List

getSelectedNode

public XdevTreeNode getSelectedNode()

Returns the first selected XdevTreeNode.

Returns:

the first selected XdevTreeNode. If the selected node is not a XdevTreeNode or no node is selected null is returned.

See Also:

TreePath

setSelectedNode

public void setSelectedNode(XdevTreeNode node)

Selects the node identified by the given node. If the given node is null the selection is canceled.

Parameters:

node - the XdevTreeNode specifying the selection

See Also:

JTree.clearSelection()

getSelectedNodes

public List<DefaultMutableTreeNode> getSelectedNodes()

Returns a List of all selected nodes.

setSelectedNodes

public void setSelectedNodes(Collection<? extends DefaultMutableTreeNode> nodes)

Selects all nodes identified by the given Collection. If the given Collection is null the selection is canceled.

Parameters:

nodes - the Collection specifying the selection

See Also:

JTree.clearSelection()

expandPath

public void expandPath(List<?> 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.

Parameters:

path - the path to expand

expandNode

public void expandNode(XdevTreeNode node)

Ensures that the node is expanded and viewable.

Parameters:

node - the XdevTreeNode to expand

See Also:

JTree.expandPath(TreePath)

expandAll

public void expandAll()

Expand all nodes of this XdevTree.

See Also:

#expandAll(DefaultMutableTreeNode)

expandAll

public void expandAll(TreeNode node)

Expand all nodes which the DefaultMutableTreeNode contains.

Parameters:

node - the DefaultMutableTreeNode identifying the nodes

See Also:

JTree.expandPath(TreePath)

collapsePath

public void collapsePath(Collection<?> path)

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

Parameters:

path - the path to collapse

collapseNode

public void collapseNode(XdevTreeNode node)

Ensures that the node is collapsed and viewable.

Parameters:

node - the XdevTreeNode to collapse

collapseAll

public void collapseAll()

Ensures that all nodes in this XdevTree are collapsed.

See Also:

JTree.collapseRow(int)

getNodeAt

public XdevTreeNode getNodeAt(int x,
                              int y)

Returns the XdevTreeNode at the specified location.

Parameters:

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

y - an integer giving the number of pixels vertically from the top of the display area, minus any top margin

Returns:

the XdevTreeNode for the node at that location. If no valid node is available null is returned.

setHoleLineTree

public void setHoleLineTree(boolean holeLineTree)

Sets the hole line tree property.

Parameters:

holeLineTree - true if a tree line should always cover the whole width of the tree, false otherwise

getHoleLineTree

public boolean getHoleLineTree()

Gets the holeLineTree property.

Returns:

the value of the holeLineTree property

See Also:

setHoleLineTree(boolean)

setPaintTreeLines

public void setPaintTreeLines(boolean paintTreeLines)

Sets the paintTreeLines property. If true the tree line is painted. The default value for the paintTreeLines property is true.

Parameters:

paintTreeLines - if true the tree line is painted

See Also:

getPaintTreeLines()

getPaintTreeLines

public boolean getPaintTreeLines()

Gets the paintTreeLines property.

Returns:

the value of the paintTreeLines property

See Also:

setPaintTreeLines(boolean)

updateUI

public void updateUI()

Overrides:

updateUI in class JTree

getOpenFolderIcon

public Icon getOpenFolderIcon()

Returns the Icon of the open folder nodes.

Returns:

the Icon of the open folder nodes

setOpenFolderIcon

public void setOpenFolderIcon(Icon openFolderIcon)

Sets the Icon which render the open folder nodes.

Parameters:

openFolderIcon - the new open folder icon

getClosedFolderIcon

public Icon getClosedFolderIcon()

Returns the Icon of the closed folder nodes.

Returns:

the Icon of the closed folder nodes

setClosedFolderIcon

public void setClosedFolderIcon(Icon closedFolderIcon)

Sets the Icon which render the closed folder nodes.

Parameters:

closedFolderIcon - the new closed folder icon

getLeafIcon

public Icon getLeafIcon()

Returns the Icon of the leaf nodes.

Returns:

the Icon of the leaf nodes

setLeafIcon

public void setLeafIcon(Icon leafIcon)

Sets the Icon which render the leaf nodes.

Parameters:

leafIcon - the new leaf icon

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

Specified by:

getPreferredScrollableViewportSize in interface Scrollable

Overrides:

getPreferredScrollableViewportSize in class JTree

toString

public String toString()

Overrides:

toString in class Component

getTabIndex

public int getTabIndex()

Returns the tabindex assigned to this component. The tabindex defines the position of the component in the focus cycle.

Specified by:

getTabIndex in interface XdevFocusCycleComponent

Returns:

tabindex of this component

setTabIndex

public void setTabIndex(int tabIndex)

Sets the tabindex of this component. The tabindex defines the position of the component in the focus cycle.

To exclude this component from the focus cycle set tabindex to -1.

Specified by:

setTabIndex in interface XdevFocusCycleComponent

Parameters:

tabIndex - to be set

loadPersistentState

public void loadPersistentState(String persistentState)

Restores this Components persistent state.

By calling this method, the passed state information get interpreted and applied on the affected attributes.

Specified by:

loadPersistentState in interface Persistable

Parameters:

persistentState - String representation for the persistent state of the Component.

See Also:

savePersistentState()

savePersistentState

public String savePersistentState()

Generates a String representation of this Components persistent state and returns it for being stored.

Persisted properties:

• Expanded tree nodes

Specified by:

savePersistentState in interface Persistable

Returns:

a String containing persistent state

getPersistentId

public String getPersistentId()

Uses the name of the component as a persistent id.

If no name is specified the name of the class will be used. This will work only for one persistent instance of the class!

Return a persistent id for this Component.

The following requirements have to be met for the persistent id:

• it has to be unique within the current application
• it has to be indentical across multiple invocations of the application

Specified by:

getPersistentId in interface Persistable

Returns:

a persistent id

isPersistenceEnabled

public boolean isPersistenceEnabled()

Flag, indicates, if the gui state for this component should be persisted.

Specified by:

isPersistenceEnabled in interface Persistable

Returns:

true if a instance of type Persistable is to be persisted.

setPersistenceEnabled

public void setPersistenceEnabled(boolean persistenceEnabled)

Sets the persistenceEnabled flag.

Parameters:

persistenceEnabled - the state for this instance

setForeground

public void setForeground(Color fg)

Overrides:

setForeground in class JComponent