Package adams.gui.goe.actorpathtree

Class ActorPathTree<T extends ActorPathNode>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

adams.gui.core.BaseTree

adams.gui.core.DragAndDropTree

adams.gui.core.dotnotationtree.DotNotationTree<T>

adams.gui.goe.actorpathtree.ActorPathTree<T>

Type Parameters:

T - the type of node to use

All Implemented Interfaces:

DragGestureListener, DragSourceListener, DropTargetListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, Scrollable

Direct Known Subclasses:

CallableActorsTree, EventsTree

public class ActorPathTree<T extends ActorPathNode>
extends DotNotationTree<T>

Displays actor paths in a tree structure.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.gui.core.DragAndDropTree

DragAndDropTree.DropMenu, DragAndDropTree.DropPosition

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	Description
protected Tree	m_FlowTree	the underlying flow.

Fields inherited from class adams.gui.core.dotnotationtree.DotNotationTree

m_Compress, m_Filter, m_InfoNodeGenerators, m_Items, m_PopupMenuHandler, m_Search, m_SelectionMode, m_Sorted

Fields inherited from class adams.gui.core.DragAndDropTree

m_ColorCueLine, m_CueLineExtension, m_DragSource, m_DropTarget, m_ExpansionDelay, m_ExpansionExecutor, m_NodeDroppedListeners, m_Offset, m_RectCueLine, m_SourceNode

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
ActorPathTree()	Initializes the tree with no classes.

Method Summary

Modifier and Type	Method	Description
void	addItem(String item)	Adds the item, if necessary.
protected String	checkClassname(T node, String classname)	Processes the classname, returns null if not suitable to be added to the node.
protected String	checkIconClassname(T node, String classname)	Processes the classname for the icon, returns null if not suitable to be added to the node.
ActorPathNode	findNodeByName(String name)	Selects the node (containing a classname) identified by the label of the node.
protected TreeCellRenderer	getDefaultRenderer()	Returns the default renderer to use.
String	getFirstItem()	Returns the first stored item.
Tree	getFlowTree()	Returns the underlying flow.
protected String	getRootNodeLabel()	Returns the label used for the root node.
boolean	hasItem(String item)	Checks whether the item is among the stored ones.
protected void	initialize()	Initializes the members.
protected String	maskEscapedDots(String s)	Masks the escaped dots to avoid splitting on the dot.
protected T	newNode(String label)	Creates a new node with the specified label.
protected T	newNodeInstance(String label)	Returns a new instance of a node.
protected void	postAddLeaf(T node, String item)	Post-processes a leaf after being added, i.e., info node generators are applied.
void	selectNodeByName(String name)	Selects the node (containing a classname) identified by the name.
void	setFlowTree(Tree value)	Sets the underlying flow.
void	setItems(List<String> items)	Displays the specified items.
void	setSelectedItem(String item)	The item to select initially.
protected String	unmaskEscapedDots(String s)	Un-masks the masked escaped dots.

Methods inherited from class adams.gui.core.dotnotationtree.DotNotationTree

addInfoNodeGenerator, addItem, addItems, addItems, addItems, applyItemFilter, applySearchFilter, buildTree, canStartDrag, compress, compress, expandAfterSearch, findItem, findItem, findRoot, getCompress, getFilter, getPopupMenuHandler, getRootPart, getSearch, getSelectedItem, getSelectedItems, getSelectionMode, getSeparator, getTreeModel, hasRootNodeLabel, isDragEnabled, isSorted, main, newTreeNodes, numItems, postBuildTree, removeInfoNodeGenerator, setCompress, setFilter, setItems, setItems, setPopupMenuHandler, setSearch, setSelectedItems, setSelectionMode, setSorted, showPopup, splitItem

Methods inherited from class adams.gui.core.DragAndDropTree

addNodeDroppedListener, canDrop, doDrop, dragDropEnd, dragEnter, dragEnter, dragExit, dragExit, dragGestureRecognized, dragOver, dragOver, drop, dropActionChanged, dropActionChanged, getDropMenuActionCaption, getDropMenuActionIcon, getExpansionDelay, isDropEnabled, newNodeCollection, notifyNodeDroppedListeners, removeNodeDroppedListener, selectCursor, setExpansionDelay, showDropMenu

Methods inherited from class adams.gui.core.BaseTree

collapse, collapseAll, collapseAll, collapseAll, collapseRoot, expand, expand, expandAll, expandAll, expandAll, expandRoot, getCommonAncestor, getExpandedState, getExpandedStateList, getExpandedTreePaths, getExpandedTreePaths, getFirstVisibleRow, getLastVisibleRow, getParentDialog, getParentFrame, getParentInternalFrame, isRootSelected, redraw, redraw, setExpandedState, setExpandedStateList, setExpandedTreePaths, setExpandedTreePaths, toggleAll, toggleAll, toPlainText, toPlainText, toString, toString

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, getPreferredScrollableViewportSize, 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, 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, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

m_FlowTree

protected Tree m_FlowTree

the underlying flow.

Constructor Detail

ActorPathTree

public ActorPathTree()

Initializes the tree with no classes.

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class DotNotationTree<T extends ActorPathNode>

setFlowTree

public void setFlowTree(Tree value)

Sets the underlying flow.

Parameters:

value - the flow

getFlowTree

public Tree getFlowTree()

Returns the underlying flow.

Returns:

the flow

getDefaultRenderer

protected TreeCellRenderer getDefaultRenderer()

Returns the default renderer to use.

Overrides:

getDefaultRenderer in class DotNotationTree<T extends ActorPathNode>

Returns:

the renderer

maskEscapedDots

protected String maskEscapedDots(String s)

Masks the escaped dots to avoid splitting on the dot.

Parameters:

s - the string to process

Returns:

the processed string

unmaskEscapedDots

protected String unmaskEscapedDots(String s)

Un-masks the masked escaped dots.

Parameters:

s - the string to process

Returns:

the processed string

setItems

public void setItems(List<String> items)

Displays the specified items.

Overrides:

setItems in class DotNotationTree<T extends ActorPathNode>

Parameters:

items - the items to display

hasItem

public boolean hasItem(String item)

Checks whether the item is among the stored ones.

Overrides:

hasItem in class DotNotationTree<T extends ActorPathNode>

Parameters:

item - the item to look for

Returns:

true if already present

addItem

public void addItem(String item)

Adds the item, if necessary.

Overrides:

addItem in class DotNotationTree<T extends ActorPathNode>

Parameters:

item - the item to add

getFirstItem

public String getFirstItem()

Returns the first stored item.

Overrides:

getFirstItem in class DotNotationTree<T extends ActorPathNode>

Returns:

the item or null if no items stored

setSelectedItem

public void setSelectedItem(String item)

The item to select initially.

Overrides:

setSelectedItem in class DotNotationTree<T extends ActorPathNode>

Parameters:

item - the item to select

getRootNodeLabel

protected String getRootNodeLabel()

Returns the label used for the root node.

Overrides:

getRootNodeLabel in class DotNotationTree<T extends ActorPathNode>

Returns:

the label

newNodeInstance

protected T newNodeInstance(String label)

Returns a new instance of a node.

Parameters:

label - the label to use

Returns:

the new node

See Also:

newNode(String)

newNode

protected T newNode(String label)

Creates a new node with the specified label.

Overrides:

newNode in class DotNotationTree<T extends ActorPathNode>

Parameters:

label - the label to use for the node

Returns:

the new node

See Also:

newNodeInstance(String)

checkIconClassname

protected String checkIconClassname(T node,
                                    String classname)

Processes the classname for the icon, returns null if not suitable to be added to the node.

Default implementation just returns the provided classname.

Parameters:

node - the node currently processed

classname - the classname to process

Returns:

null if not acceptable, otherwise the classname

checkClassname

protected String checkClassname(T node,
                                String classname)

Processes the classname, returns null if not suitable to be added to the node.

Default implementation just returns the provided classname.

Parameters:

node - the node to process

classname - the classname to process

Returns:

null if not acceptable, otherwise the classname

postAddLeaf

protected void postAddLeaf(T node,
                           String item)

Post-processes a leaf after being added, i.e., info node generators are applied.

Overrides:

postAddLeaf in class DotNotationTree<T extends ActorPathNode>

Parameters:

node - the node to process

item - the full item string

See Also:

DotNotationTree.m_InfoNodeGenerators

findNodeByName

public ActorPathNode findNodeByName(String name)

Selects the node (containing a classname) identified by the label of the node.

Parameters:

name - the label of the node

Returns:

the node, null if not found

selectNodeByName

public void selectNodeByName(String name)

Selects the node (containing a classname) identified by the name.

Parameters:

name - the label of the node