edu.udo.cs.yale.gui.operatortree
Class OperatorTree

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JTree
                  edu.udo.cs.yale.gui.operatortree.OperatorTree

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.TreeSelectionListener, javax.swing.Scrollable

public class OperatorTree
extends javax.swing.JTree
implements javax.swing.event.TreeSelectionListener, java.awt.event.MouseListener

Displays the experiment as a JTree. This is the main experiment view of the Yale GUI and can be used to edit experiments. New operators can be added by selecting a new operator from the context menu of the currently selected operator. This editor also supports cut and paste and restructuring via arrows to move an operator up and down.

Version:

$Id: OperatorTree.java,v 1.9 2006/08/03 14:39:37 ingomierswa Exp $

Author:

Ingo Mierswa

See Also:

OperatorTreeModel, Serialized Form

Nested Class Summary

private class	OperatorTree.AddAllBreakpointsAction Action for expanding the complete tree.
private class	OperatorTree.CollapseAllAction Action for collapsing the complete tree.
private class	OperatorTree.CopyAction Action for copying the selected operator.
private class	OperatorTree.CutAction Action for cutting the selected operator.
private class	OperatorTree.DeleteOperatorAction Action for deleting the selected operator.
private class	OperatorTree.ExpandAllAction Action for expanding the complete tree.
private class	OperatorTree.InfoOperatorAction Action for showing information about the selected operator.
private class	OperatorTree.NewBuildingBlockAction Action for adding a new building block.
private class	OperatorTree.NewOperatorAction Action for adding a new operator.
private class	OperatorTree.PasteAction Action for pasting the clip boad operator into the tree.
private class	OperatorTree.RemoveAllBreakpointsAction Action for expanding the complete tree.
private class	OperatorTree.RenameOperatorAction Action for renaming the selected operator.
private class	OperatorTree.SaveBuildingBlockAction Action for saving the selected operator as building block.
private class	OperatorTree.ToggleActivationItem Item for toggling the activation state of the selected operator.
private class	OperatorTree.ToggleBreakpointItem Items for toggling breakpoint states.
private class	OperatorTree.ToggleShowDisabledItem Item for toggling if disabled operator should be shown by the tree.

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

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

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

Field Summary

javax.swing.Action	ADD_ALL_BREAKPOINTS
private Operator	clipBoard The current clip board, i.e. the selected operator before cut or copy was applied.
private static int	CLIPBOARD_MODE_COPY Indicates the the current clip board is used for copying.
private static int	CLIPBOARD_MODE_CUT Indicates the the current clip board is used for cutting.
private static int	CLIPBOARD_MODE_EMPTY Indicates the the current clip board is empty.
private int	clipBoardMode The current clip board mode.
javax.swing.Action	COLLAPSE_ALL_ACTION
javax.swing.Action	COPY_ACTION
javax.swing.Action	CUT_ACTION
javax.swing.Action	DELETE_OPERATOR_ACTION
javax.swing.Action	EXPAND_ALL_ACTION
javax.swing.Action	INFO_OPERATOR_ACTION
private MainFrame	mainFrame The main frame.
javax.swing.Action	NEW_BUILDING_BLOCK_ACTION
javax.swing.Action	NEW_OPERATOR_ACTION
javax.swing.Action	PASTE_ACTION
javax.swing.Action	REMOVE_ALL_BREAKPOINTS
javax.swing.Action	RENAME_OPERATOR_ACTION
javax.swing.Action	SAVE_BUILDING_BLOCK_ACTION
private static long	serialVersionUID
OperatorTree.ToggleBreakpointItem[]	TOGGLE_BREAKPOINT
OperatorTree.ToggleShowDisabledItem	TOGGLE_SHOW_DISABLED
private OperatorTreeModel	treeModel The tree model of the operator tree.

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, 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

OperatorTree(MainFrame mainFrame)
Creates a new operator tree.

Method Summary

private void	addAllBreakpoints()
private void	addAllBreakpoints(Operator operator)
void	addOperatorMenuItems(javax.swing.JMenu menu) Adds the operator tree actions to the given menu.
void	collapseAll() Collapses the complete tree.
void	completeRefresh() This method fires a tree structure changed event for the root operator and causes the complete expension of the tree.
private javax.swing.JPopupMenu	createOperatorPopupMenu() Creates a new popup menu for the selected operator.
javax.swing.JPopupMenu	createOperatorTreePopupMenu()
private void	delete() The currently selected operator will be deleted.
private void	evaluateDoubleClick(int row, javax.swing.tree.TreePath path) Removes existing breakpoints or add a new breakpoint after the currently selected operator.
private void	evaluatePopup(java.awt.event.MouseEvent e) Checks if the given mouse event is a popup trigger and creates a new popup menu if necessary.
private void	evaluateSingleClick(int row, javax.swing.tree.TreePath path) Invokes the selection and causes an update of the conditional action list.
void	expandAll() Expands the complete tree.
Operator	getClipBoard() Returns the current clip board.
Operator	getSelectedOperator() Returns the currently selected operator, i.e. the last operation in the current selection path.
void	insert(Operator newOperator) The given operator will be inserted at the last position of the currently selected operator chain.
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	moveDown() The currently selected operator will be moved down a step.
void	moveUp() The currently selected operator will be moved up one step.
void	refresh() This method causes a refresh of the existing operators without restructuring.
void	refresh(javax.swing.tree.TreePath path) This method causes a refresh of the given path.
private void	removeAllBreakpoints()
private void	removeAllBreakpoints(Operator operator)
void	replace(Operator operator) The currently selected operator will be replaced by the given operator.
void	setOperator(Operator root) Creates a new operator tree model and expands the complete tree.
private void	toggleBreakpoint(int position, boolean state) This method toggles the breakpoint with the given position into the given state.
void	valueChanged(javax.swing.event.TreeSelectionEvent e) This method will be invoked after a user selection of an operator in the tree.

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, 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, 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, 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, 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, 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

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

NEW_OPERATOR_ACTION

public final javax.swing.Action NEW_OPERATOR_ACTION

NEW_BUILDING_BLOCK_ACTION

public final javax.swing.Action NEW_BUILDING_BLOCK_ACTION

CUT_ACTION

public final javax.swing.Action CUT_ACTION

COPY_ACTION

public final javax.swing.Action COPY_ACTION

PASTE_ACTION

public final javax.swing.Action PASTE_ACTION

DELETE_OPERATOR_ACTION

public final javax.swing.Action DELETE_OPERATOR_ACTION

RENAME_OPERATOR_ACTION

public final javax.swing.Action RENAME_OPERATOR_ACTION

INFO_OPERATOR_ACTION

public final javax.swing.Action INFO_OPERATOR_ACTION

SAVE_BUILDING_BLOCK_ACTION

public final javax.swing.Action SAVE_BUILDING_BLOCK_ACTION

TOGGLE_BREAKPOINT

public final OperatorTree.ToggleBreakpointItem[] TOGGLE_BREAKPOINT

TOGGLE_SHOW_DISABLED

public final OperatorTree.ToggleShowDisabledItem TOGGLE_SHOW_DISABLED

ADD_ALL_BREAKPOINTS

public final javax.swing.Action ADD_ALL_BREAKPOINTS

REMOVE_ALL_BREAKPOINTS

public final javax.swing.Action REMOVE_ALL_BREAKPOINTS

EXPAND_ALL_ACTION

public final javax.swing.Action EXPAND_ALL_ACTION

COLLAPSE_ALL_ACTION

public final javax.swing.Action COLLAPSE_ALL_ACTION

CLIPBOARD_MODE_EMPTY

private static int CLIPBOARD_MODE_EMPTY

Indicates the the current clip board is empty.

CLIPBOARD_MODE_CUT

private static int CLIPBOARD_MODE_CUT

Indicates the the current clip board is used for cutting.

CLIPBOARD_MODE_COPY

private static int CLIPBOARD_MODE_COPY

Indicates the the current clip board is used for copying.

mainFrame

private MainFrame mainFrame

The main frame. Used for conditional action updates and property table settings.

treeModel

private OperatorTreeModel treeModel

The tree model of the operator tree.

clipBoard

private Operator clipBoard

The current clip board, i.e. the selected operator before cut or copy was applied.

clipBoardMode

private int clipBoardMode

The current clip board mode. Must be one out of CLIPBOARD_MODE_EMPTY, CLIPBOARD_MODE_CUT, or CLIPBOARD_MODE_COPY.

Constructor Detail

OperatorTree

public OperatorTree(MainFrame mainFrame)

Creates a new operator tree.

Method Detail

setOperator

public void setOperator(Operator root)

Creates a new operator tree model and expands the complete tree.

getSelectedOperator

public Operator getSelectedOperator()

Returns the currently selected operator, i.e. the last operation in the current selection path.

getClipBoard

public Operator getClipBoard()

Returns the current clip board.

expandAll

public void expandAll()

Expands the complete tree.

collapseAll

public void collapseAll()

Collapses the complete tree.

completeRefresh

public void completeRefresh()

This method fires a tree structure changed event for the root operator and causes the complete expension of the tree. Since the complete tree will be restructured after invoking this method this method should only be invoked if a complete restructuring of the model occured, e.g. after changing view filter setting like filtering diabled operators. Whenever possible the method refresh() should be used instead which only causes a recursive refresh of the already existing operators.

refresh

public void refresh()

This method causes a refresh of the existing operators without restructuring.

refresh

public void refresh(javax.swing.tree.TreePath path)

This method causes a refresh of the given path.

moveDown

public void moveDown()

The currently selected operator will be moved down a step.

moveUp

public void moveUp()

The currently selected operator will be moved up one step.

delete

private void delete()

The currently selected operator will be deleted.

insert

public void insert(Operator newOperator)

The given operator will be inserted at the last position of the currently selected operator chain.

replace

public void replace(Operator operator)

The currently selected operator will be replaced by the given operator.

addAllBreakpoints

private void addAllBreakpoints()

addAllBreakpoints

private void addAllBreakpoints(Operator operator)

removeAllBreakpoints

private void removeAllBreakpoints()

removeAllBreakpoints

private void removeAllBreakpoints(Operator operator)

toggleBreakpoint

private void toggleBreakpoint(int position,
                              boolean state)

This method toggles the breakpoint with the given position into the given state.

valueChanged

public void valueChanged(javax.swing.event.TreeSelectionEvent e)

This method will be invoked after a user selection of an operator in the tree. Causes a property table update and an update of the conditional action container.

Specified by:

valueChanged in interface javax.swing.event.TreeSelectionListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

evaluateSingleClick

private void evaluateSingleClick(int row,
                                 javax.swing.tree.TreePath path)

Invokes the selection and causes an update of the conditional action list.

evaluateDoubleClick

private void evaluateDoubleClick(int row,
                                 javax.swing.tree.TreePath path)

Removes existing breakpoints or add a new breakpoint after the currently selected operator.

evaluatePopup

private void evaluatePopup(java.awt.event.MouseEvent e)

Checks if the given mouse event is a popup trigger and creates a new popup menu if necessary.

addOperatorMenuItems

public void addOperatorMenuItems(javax.swing.JMenu menu)

Adds the operator tree actions to the given menu.

createOperatorPopupMenu

private javax.swing.JPopupMenu createOperatorPopupMenu()

Creates a new popup menu for the selected operator.

createOperatorTreePopupMenu

public javax.swing.JPopupMenu createOperatorTreePopupMenu()