arlut.csd.JTree

Class treeControl

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

arlut.csd.JTree.treeControl

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.AdjustmentListener, java.awt.event.FocusListener, java.awt.event.MouseWheelListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class treeControl
extends javax.swing.JPanel
implements java.awt.event.AdjustmentListener, java.awt.event.ActionListener, java.awt.event.FocusListener, java.awt.event.MouseWheelListener

This component allows the display of a tree structured graph of nodes, each node being a small image and a line of text. Nodes with children can be opened or closed, allowing the child nodes to be made visible or hidden. Each node can be selected and can have a pop-up menu attached. Nodes can be dragged, with both 'drag-tween' and 'drag on' drag supported.

Author:

Jonathan Abbey

See Also:

treeCallback, treeNode, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	treeControl.myKeyListener
private class	treeControl.treeControlAction

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static int	borderSpace
(package private) java.awt.Rectangle	bounding_rect
(package private) treeCallback	callback
(package private) treeCanvas	canvas
(package private) treeDragDropCallback	dCallback
(package private) static boolean	debug
static int	DRAG_ICON
static int	DRAG_LINE
static int	DRAG_NONE
(package private) treeNode	dragAboveNode
(package private) treeNode	dragBelowNode
(package private) int	dragMode
(package private) treeNode	dragNode
(package private) treeNode	dragOverNode
(package private) javax.swing.JScrollBar	hbar
(package private) boolean	hbar_visible
(package private) int	maxWidth
(package private) treeMenu	menu
(package private) treeNode	menuedNode
(package private) int	minWidth
(package private) treeNode	oldNode
(package private) treeNode	root
(package private) int	row_height
(package private) java.util.Vector	rows
(package private) treeNode	selectedNode
(package private) javax.swing.JScrollBar	vbar
(package private) boolean	vbar_visible

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

Constructors

Constructor and Description
treeControl(java.awt.Font font, java.awt.Color fgColor, java.awt.Color bgColor, treeCallback callback, java.awt.Image[] images) Constructor
treeControl(java.awt.Font font, java.awt.Color fgColor, java.awt.Color bgColor, treeCallback callback, java.awt.Image[] images, treeMenu menu) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Handle notification from popupmenus and from key board navigation actions
void	adjustmentValueChanged(java.awt.event.AdjustmentEvent e) Handles scrollbar events.
private void	adjustScrollbars() Check to see whether we need scrollbars in our current component size, set the min/max/visible parameters This method is intended to be called from reShape().
(package private) void	breakdownTree(treeNode node) Helper function to break down links in a tree to speed GC.
private void	clearStacks(treeNode node) Helper method to force recalculation of childStacks.
void	clearTree() Clear out the tree.
void	contractNode(treeNode node, boolean repaint) close the given node
void	contractNode(treeNode node, boolean repaint, boolean doCallback) close the given node
void	deleteNode(treeNode node, boolean repaint) Removes a node from the tree, along with all its children.
void	destroyTree() Call this on the GUI thread to break apart and destroy this tree.
void	dispose() Method to be called after this treeControl is removed from use and visibility.
(package private) void	doubleClickNode(treeNode node) Used to trigger the default action in the callback.
void	dumpRows() Internal diagnostic method, prints the structure of this tree to System.err.
void	expandNode(treeNode node, boolean repaint) open the given node
void	expandNode(treeNode node, boolean repaint, boolean doCallback) open the given node
void	focusGained(java.awt.event.FocusEvent e)
void	focusLost(java.awt.event.FocusEvent e)
treeNode	getRoot() Get access to the root of the treeCanvas's tree of nodes.
private void	getVisibleDescendantRange(treeNode node, Range range) Calculates the rows that are visible at and below node, so that contractNode() can remove all nodes in that range from visibility
private void	initializeKeyboardActions()
void	insertNode(treeNode newNode, boolean repaint) Inserts a new node into the tree.
private int	makeDescendantsVisible(treeNode node, int row) recursive routine to make descendant nodes visible.
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e)
treeNode	moveNode(treeNode node, treeNode parent, treeNode insertAfter, boolean repaint) Moves a node (possibly the root of an extensive subtree) from one location in the tree to another.
(package private) void	moveSelection(treeNode node) This method deselects the currently selected node (if any) and selects the paramater node.
void	refresh() Recalculate and redraw the tree.
(package private) void	refreshTree() Redraw the canvas.
void	removeChildren(treeNode node, boolean repaint) Removes all children of the specified node from the tree.
private void	reShape() This method recalculates the general parameters of our tree's display.
void	resize(int x, int y, int width, int height) This method is called when our size is changed.
private void	scrollToSelectedRow() This method scrolls the treeCanvas so that the selected row is visible.
void	selectNode(treeNode node) Mark a node as selected, issuing a callback to the client reporting the selection.
void	setBounds(int x, int y, int width, int height) Called when we are being resized by our container.
void	setDrag(treeDragDropCallback dCallback, int mode) This method is used to set the drag behavior of the tree.
void	setMinimumWidth(int minWidth) Sets the minimum width the treeControl will demand in a sliding pane.
void	setRoot(treeNode root) Clear the tree and establish a new root node.
(package private) void	transientSelectNode(treeNode node) Select a node without issuing a callback to the client.
(package private) void	transientUnselectNode(treeNode node) Deselect a node without issuing a callback to the client.
private void	tryMatchString(java.lang.String matchOn) This method is used by the myKeyListener on this tree to advance the selection mark in response to data entry keyboard input from the user.
void	unselectAllNodes(boolean anySelected) Deselect all nodes, issuing a callback to the client reporting the deselection.
(package private) void	unselectNode(treeNode node, boolean anySelected) Deselect a node, issuing a callback to the client reporting the deselection.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, 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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, 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, 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, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

debug

static final boolean debug

See Also:

Constant Field Values

borderSpace

static final int borderSpace

See Also:

Constant Field Values

DRAG_NONE

public static final int DRAG_NONE

See Also:

Constant Field Values

DRAG_ICON

public static final int DRAG_ICON

See Also:

Constant Field Values

DRAG_LINE

public static final int DRAG_LINE

See Also:

Constant Field Values

root

treeNode root

callback

treeCallback callback

canvas

treeCanvas canvas

selectedNode

treeNode selectedNode

dCallback

treeDragDropCallback dCallback

dragMode

int dragMode

oldNode

treeNode oldNode

dragNode

treeNode dragNode

dragOverNode

treeNode dragOverNode

dragBelowNode

treeNode dragBelowNode

dragAboveNode

treeNode dragAboveNode

menu

treeMenu menu

hbar

javax.swing.JScrollBar hbar

vbar

javax.swing.JScrollBar vbar

bounding_rect

java.awt.Rectangle bounding_rect

hbar_visible

boolean hbar_visible

vbar_visible

boolean vbar_visible

minWidth

int minWidth

maxWidth

int maxWidth

row_height

int row_height

rows

java.util.Vector rows

menuedNode

treeNode menuedNode

Constructor Detail

treeControl

public treeControl(java.awt.Font font,
           java.awt.Color fgColor,
           java.awt.Color bgColor,
           treeCallback callback,
           java.awt.Image[] images,
           treeMenu menu)

Constructor

Parameters:

font - Font for text in the Tree Canvas

fgColor - Foreground color for text in the treeCanvas

bgColor - Background color for text in the treeCanvas

callback - Object to receive notification of events

images - Array of images to be used in the canvas; nodes refer to images by index

menu - Popup menu to attach to the treeControl

treeControl

public treeControl(java.awt.Font font,
           java.awt.Color fgColor,
           java.awt.Color bgColor,
           treeCallback callback,
           java.awt.Image[] images)

Constructor

Parameters:

font - Font for text in the Tree Canvas

fgColor - Foreground color for text in the treeCanvas

bgColor - Background color for text in the treeCanvas

callback - Object to receive notification of events

images - Array of images to be used in the canvas; nodes refer to images by index

Method Detail

setDrag

public void setDrag(treeDragDropCallback dCallback,
           int mode)

This method is used to set the drag behavior of the tree.

Parameters:

dCallback - DragDrop manager object

mode - A binary or'ing of of treeControl.DRAG_NONE, treeControl.DRAG_ICON, and treeControl.DRAG_LINE.

See Also:

treeDragDropCallback

destroyTree

public void destroyTree()

Call this on the GUI thread to break apart and destroy this tree.

clearTree

public void clearTree()

Clear out the tree.

setRoot

public void setRoot(treeNode root)

Clear the tree and establish a new root node.

setMinimumWidth

public void setMinimumWidth(int minWidth)

Sets the minimum width the treeControl will demand in a sliding pane.

insertNode

public void insertNode(treeNode newNode,
              boolean repaint)

Inserts a new node into the tree. newNode's prevSibling is checked first. If it is non-null, newNode is inserted after newNode.prevSibling, regardless of what newNode.parent says. If prevSibling is null, newNode is made the first child of its requested parent.

Parameters:

newNode - The node to be inserted. Properties of the node determine where the node is inserted.

repaint - If true, immediately re-render and refresh the treeCanvas.

deleteNode

public void deleteNode(treeNode node,
              boolean repaint)

Removes a node from the tree, along with all its children. Any child nodes attached to the node to be deleted will be unlinked from one another. If you want to be able to re-insert the deleted node elsewhere in the tree, you probably should use moveNode() instead.

Parameters:

node - The node to be removed.

repaint - If true, immediately re-render and refresh the treeCanvas.

moveNode

public treeNode moveNode(treeNode node,
                treeNode parent,
                treeNode insertAfter,
                boolean repaint)

Moves a node (possibly the root of an extensive subtree) from one location in the tree to another.

Note that this method is currently implemented in a fairly simplistic manner, using the deleteNode and insertNode primitives, cloning nodes as they are copied into the new location in the tree. This works reliably, but this might not be the best implementation for moving large sub-trees.

Parameters:

node - The node to be moved.

parent - Parent node to insert this node under, null if this is a top-level node

insertAfter - sibling to insert this node after

repaint - If true, immediately re-render and refresh the treeCanvas after moving the node.

Returns:

a reference to a copy of the node in its new location

removeChildren

public void removeChildren(treeNode node,
                  boolean repaint)

Removes all children of the specified node from the tree.

Parameters:

node - The node whose children should be removed

repaint - If true, immediately re-render and refresh the treeCanvas.

breakdownTree

void breakdownTree(treeNode node)

Helper function to break down links in a tree to speed GC. breakdownTree will disassociate all nodes in an unlinked tree, so new nodes will need to be assembled in order to be resubmitted to the tree.

clearStacks

private void clearStacks(treeNode node)

Helper method to force recalculation of childStacks. This method should be called on the child of a node, not on the node itself, lest clearStacks recurse along the node's siblings.. not that that will cause any great hardship, but it would slow things down a very little bit.

getRoot

public treeNode getRoot()

Get access to the root of the treeCanvas's tree of nodes.

refresh

public void refresh()

Recalculate and redraw the tree.

dumpRows

public void dumpRows()

Internal diagnostic method, prints the structure of this tree to System.err.

expandNode

public void expandNode(treeNode node,
              boolean repaint)

open the given node

expandNode

public void expandNode(treeNode node,
              boolean repaint,
              boolean doCallback)

open the given node

makeDescendantsVisible

private int makeDescendantsVisible(treeNode node,
                         int row)

recursive routine to make descendant nodes visible. will not expand any contracted nodes, but will add any nodes reachable without passing below a contracted node to the visibility

Parameters:

row - the row to match the node to.

Returns:

the row number of the last descendant made visible

contractNode

public void contractNode(treeNode node,
                boolean repaint)

close the given node

contractNode

public void contractNode(treeNode node,
                boolean repaint,
                boolean doCallback)

close the given node

getVisibleDescendantRange

private void getVisibleDescendantRange(treeNode node,
                             Range range)

Calculates the rows that are visible at and below node, so that contractNode() can remove all nodes in that range from visibility

Parameters:

node - The node of the subtree we need to examine

range - We encode the range below node in the Range object

transientSelectNode

void transientSelectNode(treeNode node)

Select a node without issuing a callback to the client.

Used to implement highlighting during drag-and-drop.

doubleClickNode

void doubleClickNode(treeNode node)

Used to trigger the default action in the callback.

selectNode

public void selectNode(treeNode node)

Mark a node as selected, issuing a callback to the client reporting the selection.

This method does not deselect other nodes.

Parameters:

node - The node to select

moveSelection

void moveSelection(treeNode node)

This method deselects the currently selected node (if any) and selects the paramater node.

Parameters:

node - The node to select

transientUnselectNode

void transientUnselectNode(treeNode node)

Deselect a node without issuing a callback to the client.

Used to implement highlighting during drag-and-drop.

Parameters:

node - The node to deselect

unselectNode

void unselectNode(treeNode node,
                boolean anySelected)

Deselect a node, issuing a callback to the client reporting the deselection.

Parameters:

anySelected - If true, the client will be told that some node will remain selected after this operation is completed

node - The node to deselect

unselectAllNodes

public void unselectAllNodes(boolean anySelected)

Deselect all nodes, issuing a callback to the client reporting the deselection.

Parameters:

anySelected - If true, the client will be told that some node will remain selected after this operation is completed.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Handle notification from popupmenus and from key board navigation actions

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - The event we're receiving as an ActionListener

scrollToSelectedRow

private void scrollToSelectedRow()

This method scrolls the treeCanvas so that the selected row is visible. This method returns true if a scroll (and redraw) was performed, false otherwise.

adjustmentValueChanged

public void adjustmentValueChanged(java.awt.event.AdjustmentEvent e)

Handles scrollbar events.

Specified by:

adjustmentValueChanged in interface java.awt.event.AdjustmentListener

resize

public void resize(int x,
          int y,
          int width,
          int height)

This method is called when our size is changed. We need to know this so we can update the scrollbars and what-not.

setBounds

public void setBounds(int x,
             int y,
             int width,
             int height)

Called when we are being resized by our container.

Overrides:

setBounds in class java.awt.Component

reShape

private void reShape()

This method recalculates the general parameters of our tree's display. That is, it calculates whether or not we need scroll bars, adds or deletes the scroll bars, and scales the column positions to match the general rendering parameters.

adjustScrollbars

private void adjustScrollbars()

Check to see whether we need scrollbars in our current component size, set the min/max/visible parameters

This method is intended to be called from reShape().

refreshTree

void refreshTree()

Redraw the canvas.

dispose

public void dispose()

Method to be called after this treeControl is removed from use and visibility.

focusGained

public void focusGained(java.awt.event.FocusEvent e)

Specified by:

focusGained in interface java.awt.event.FocusListener

focusLost

public void focusLost(java.awt.event.FocusEvent e)

Specified by:

focusLost in interface java.awt.event.FocusListener

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

initializeKeyboardActions

private void initializeKeyboardActions()

tryMatchString

private void tryMatchString(java.lang.String matchOn)

This method is used by the myKeyListener on this tree to advance the selection mark in response to data entry keyboard input from the user.