org.kepler.gui.frame

Class TabbedKeplerGraphFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

ptolemy.gui.Top

ptolemy.actor.gui.TableauFrame

ptolemy.actor.gui.PtolemyFrame

ptolemy.vergil.basic.BasicGraphFrame

ptolemy.vergil.basic.ExtendedGraphFrame

ptolemy.vergil.actor.ActorGraphFrame

org.kepler.gui.KeplerGraphFrame

org.kepler.gui.frame.TabbedKeplerGraphFrame

All Implemented Interfaces:

java.awt.datatransfer.ClipboardOwner, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.awt.event.WindowFocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Printable, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, ImageExportable, ChangeListener, StatusHandler, HTMLExportable

public class TabbedKeplerGraphFrame
extends KeplerGraphFrame
implements javax.swing.event.ChangeListener

This is a graph editor frame that uses a tabbed pane to display multiple composite actors. TODO: go to actor in exception dialog does not switch tabs fix NamedObjId errors when closing (KGF calls dispose() twice, second time getModel() returns null) DONE: zoom and window position not saved in composite tabs fix: override of updateWindowAttributes() along with refactoring methods in BasicGraphFrame for getting the center, etc. support nested tabs for case/execution choice actors double-click on tab to make separate window frame close button closes tab instead of frame fix: remove _close() override add non-composites to tab: atomic actor source code difficult since not opened in graph frame does not save window size? see bug http://bugzilla.ecoinformatics.org/show_bug.cgi?id=5637 do not place in tabbed pane when no other composites open canvas scroll bars missing fix: update scrollbars to use selected sub-workflow in stateChanged() update outline tree when selected tab changes fix: refresh outline pane in stateChanged() change color of X for closing tab on rollover new in/out port buttons on toolbar place ports in top level instead of subwf fix: uncomment TabbedKeplerController.getGraphModel(), see next fix. one actor in composites rendered wrong when opened the first time fix: in _createGraphPane resize tab component on renames fix: call invalidate() in TabbedCompositeTabComponent.refreshName() cmd-l on composite not already opened should open in new window, not tab fix: added LookInsideTabbedComposite.actionIsRunning() rename tabs when composite names are changed rename tabs when parent composite is renamed delete tabs when composite is deleted delete tabs when composite parent is deleted ports are displayed wrong (probably controller) fix: updated ActorEditorGraphController to add port layout listener when using alternative actor controllers when tab changes, panner is repainted, but panner does not show actor highlight changes (same behavior in ptolemy; no fix) file->close / cmd-w should close selected tab open composite on one already opened set selected tab add X button to tabs to close close tab via button, then can't open again (need to close tableau?) frame title is wrong: seems to be set to last opened composite focus stops working (fix: use MultiCompositeController from CaseGraphFrame?) cmd-l on already opened composite should switch to tab clean up LookInsideAction, controller stuff

Author:

Daniel Crawl

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TabbedKeplerGraphFrame.TabbedKeplerController Specialized graph controller that handles multiple graph models.

Nested classes/interfaces inherited from class org.kepler.gui.KeplerGraphFrame

KeplerGraphFrame.Components, KeplerGraphFrame.ScrollBarListener

Nested classes/interfaces inherited from class ptolemy.vergil.actor.ActorGraphFrame

ActorGraphFrame.DebugMenuListener, ActorGraphFrame.InstantiateAttributeAction, ActorGraphFrame.InstantiateEntityAction

Nested classes/interfaces inherited from class ptolemy.vergil.basic.ExtendedGraphFrame

ExtendedGraphFrame.FullScreenAction

Nested classes/interfaces inherited from class ptolemy.vergil.basic.BasicGraphFrame

BasicGraphFrame.CopyAction, BasicGraphFrame.CutAction, BasicGraphFrame.EditPreferencesAction, BasicGraphFrame.ExportImageAction, BasicGraphFrame.FindAction, BasicGraphFrame.FolderFileFilter, BasicGraphFrame.MousePressedLayerAdapter, BasicGraphFrame.MoveToBackAction, BasicGraphFrame.MoveToFrontAction, BasicGraphFrame.PasteAction

Nested classes/interfaces inherited from class ptolemy.actor.gui.TableauFrame

TableauFrame.MenuItemListener

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

javax.swing.JFrame.AccessibleJFrame

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

java.awt.Frame.AccessibleAWTFrame

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

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

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 inherited from class org.kepler.gui.KeplerGraphFrame

_canvasPanel, _horizontalScrollBar, _verticalScrollBar, BACKGROUND_COLOR

Fields inherited from class ptolemy.vergil.actor.ActorGraphFrame

_controller, _createHierarchyAction, _debugMenu, _debugMenuListener, _exportDesignPatternAction, _importDesignPatternAction, _importLibraryAction, _instantiateAttributeAction, _instantiateEntityAction, _instantiatePortAction, _saveInLibraryAction

Fields inherited from class ptolemy.vergil.basic.BasicGraphFrame

_copyAction, _cutAction, _defaultLibrary, _dropTarget, _editMenu, _editPreferencesAction, _exportGIFAction, _exportHTMLAction, _exportPDFAction, _exportPNGAction, _findAction, _graphMenu, _graphPanner, _jgraph, _layoutAction, _layoutConfigDialogAction, _library, _libraryContextMenuCreator, _libraryModel, _libraryScrollPane, _moveToBackAction, _moveToFrontAction, _openGraphFrames, _palettePane, _pasteAction, _reloadAccessorsAction, _rightComponent, _splitPane, _toolbar, _topLibrary, _treeView, _treeViewModel, _treeViewScrollPane, _zoomFitAction, _zoomFlag, _zoomInAction, _zoomOutAction, _zoomResetAction, VERGIL_USER_LIBRARY_NAME

Fields inherited from class ptolemy.actor.gui.PtolemyFrame

_query

Fields inherited from class ptolemy.actor.gui.TableauFrame

_initialSaveAsFileName, _topPack, _viewMenu, aboutFile, helpFile

Fields inherited from class ptolemy.gui.Top

_CANCELED, _debugClosing, _directory, _DISCARDED, _exitResult, _EXPORT_MENU_INDEX, _FAILED, _fileFilter, _fileMenu, _fileMenuItems, _filenameFilter, _helpMenu, _helpMenuItems, _IMPORT_MENU_INDEX, _menubar, _NEW_MENU_INDEX, _SAVED, _statusBar, MAXIMUM_STATUS_MESSAGE_TIME

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
TabbedKeplerGraphFrame(CompositeActor entity, Tableau tableau) Construct a frame associated with the specified composite actor.
TabbedKeplerGraphFrame(CompositeActor entity, Tableau tableau, LibraryAttribute defaultLibrary) Construct a frame associated with the specified composite actor.

Method Summary

Modifier and Type	Method and Description
protected diva.graph.GraphPane	_createGraphPane(NamedObj entity) Create a new graph pane.
protected javax.swing.JComponent	_createRightComponent(NamedObj entity) Create the component that goes to the right of the library.
void	addComposite(CompositeEntity model, TabbedKeplerGraphTableau keplerGraphMultiCompositeTableau, LibraryAttribute defaultLibrary) Add a new tab for a model.
void	addMenu(javax.swing.JMenu menu) Add a menu to the menu bar.
void	addSubComposite(CompositeEntity composite) Create a new tab displaying the contents of a composite actor inside of an existing tab for a MultiCompositeActor.
void	changeExecuted(ChangeRequest change) Listen for name changes in the model.
void	dispose() Free resources when closing.
diva.graph.JGraph	getJGraph() Return the JGraph instance that this view uses to represent the ptolemy model.
NamedObj	getSelectedModel() Return the model associated with the selected tab.
void	removeComposite(NamedObj model) Remove a workflow from the frame.
void	removeMenu(javax.swing.JMenu menu) Remove a menu from the menu bar.
void	setSelectedTab(NamedObj model) Set the selected tab to the tab containing a specific model.
void	stateChanged(javax.swing.event.ChangeEvent event) React to a change in the state of the tabbed pane.
void	updateTabsForComposite(CompositeEntity composite) Update the nested tabs displayed for a composite actor.
void	updateWindowAttributes() Update the size, zoom and position of all the open tabs.

Methods inherited from class org.kepler.gui.KeplerGraphFrame

_addMenus, _getName, _initBasicGraphFrame, _initKeplerGraphFrame, _queryForSave, _saveAs, _updateHistory, addUpdater, clearUpdaters, fullScreen, getGraphController, getOpenFrames, getToolBar, removeUpdater, setModel, updateHistory

Methods inherited from class ptolemy.vergil.actor.ActorGraphFrame

_close, _createFileMenuItems, _initActorGraphFrame, importLibrary

Methods inherited from class ptolemy.vergil.basic.ExtendedGraphFrame

_initExtendedGraphFrame, cancelFullScreen

Methods inherited from class ptolemy.vergil.basic.BasicGraphFrame

_addLayoutMenu, _addReloadAccessorsMenu, _checkForImplied, _createDefaultLibrary, _createSizeAttribute, _createSizeAttribute, _deleteMoML, _exportDesignPattern, _finishExportDesignPattern, _getCenter, _getDirectory, _getGraphController, _getGraphModel, _getRightComponent, _getSelectionSet, _getVisibleCanvasRectangle, _getVisibleRectangle, _initBasicGraphFrameActions, _initBasicGraphFrameInitialization, _initBasicGraphFrameRightComponent, _initBasicGraphFrameRightComponentMouseListeners, _initBasicGraphFrameSetZoomAndPan, _initBasicGraphFrameSetZoomAndPane, _initBasicGraphFrameToolBarZoomButtons, _initLayoutGuiAction, _initReloadAccessorsAction, _isDesignPattern, _prepareExportDesignPattern, _saveAsFileDialogComponent, _saveAsJFileChooserComponent, _setBackgroundColor, _setCenter, _setDirectory, _setDropIntoEnabled, _updateWindowAttributes, _writeFile, _zoom, changeFailed, clearSelection, copy, createHierarchy, cut, delete, disposeSuper, expandAllLibraryRows, exportDesignPattern, getBasicGraphFrame, getBasicGraphFrame, getCenter, getContentSize, getFigureUnder, getFrame, getGraphPanner, getLastDirectory, getSelectionSet, getVisibleCanvasRectangle, getVisibleRectangle, importDesignPattern, lostOwnership, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, openComposite, openContainer, paste, print, redo, report, saveComponentInLibrary, setCenter, setJGraph, setLastDirectory, undo, writeHTML, writeImage, writeImage, zoom, zoomFit, zoomFit, zoomReset

Methods inherited from class ptolemy.actor.gui.PtolemyFrame

_clear, _help, _print, _saveAs, getEffigy, getModel

Methods inherited from class ptolemy.actor.gui.TableauFrame

_about, _confirmFile, _exit, _getDefaultIconImage, _read, _save, _saveAsHelper, getAlternateTopPack, getConfiguration, getDirectory, getEffigy, getTableau, isModified, pack, printPDF, setModified, setTableau

Methods inherited from class ptolemy.gui.Top

_getCurrentDirectory, _open, _openURL, _populateHistory, _printCrossPlatform, _printNative, _printPDF, _saveAsFileDialog, about, centerOnScreen, close, deferIfNecessary, exit, getCentering, hideMenuBar, isDisposed, isMenuPopulated, report, report, report, setBackground, setCentering, setDirectory, show, status, windowGainedFocus, windowLostFocus

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

TabbedKeplerGraphFrame

public TabbedKeplerGraphFrame(CompositeActor entity,
                              Tableau tableau)

Construct a frame associated with the specified composite actor. After constructing this, it is necessary to call setVisible(true) to make the frame appear. This is typically done by calling show() on the controlling tableau. This constructor results in a graph frame that obtains its library either from the model (if it has one) or the default library defined in the configuration.

Parameters:

entity - The model to put in this frame.

tableau - The tableau responsible for this frame.

See Also:

Tableau.show()

TabbedKeplerGraphFrame

public TabbedKeplerGraphFrame(CompositeActor entity,
                              Tableau tableau,
                              LibraryAttribute defaultLibrary)

Construct a frame associated with the specified composite actor. After constructing this, it is necessary to call setVisible(true) to make the frame appear. This is typically done by calling show() on the controlling tableau. This constructor results in a graph frame that obtains its library either from the model (if it has one), or the defaultLibrary argument (if it is non-null), or the default library defined in the configuration.

Parameters:

entity - The model to put in this frame.

tableau - The tableau responsible for this frame.

defaultLibrary - An attribute specifying the default library to use if the model does not have a library.

See Also:

Tableau.show()

Method Detail

addComposite

public void addComposite(CompositeEntity model,
                         TabbedKeplerGraphTableau keplerGraphMultiCompositeTableau,
                         LibraryAttribute defaultLibrary)

Add a new tab for a model.

addMenu

public void addMenu(javax.swing.JMenu menu)

Add a menu to the menu bar.

addSubComposite

public void addSubComposite(CompositeEntity composite)

Create a new tab displaying the contents of a composite actor inside of an existing tab for a MultiCompositeActor.

changeExecuted

public void changeExecuted(ChangeRequest change)

Listen for name changes in the model.

Specified by:

changeExecuted in interface ChangeListener

Overrides:

changeExecuted in class BasicGraphFrame

Parameters:

change - The change that has been executed.

dispose

public void dispose()

Free resources when closing.

Overrides:

dispose in class KeplerGraphFrame

getJGraph

public diva.graph.JGraph getJGraph()

Return the JGraph instance that this view uses to represent the ptolemy model.

Overrides:

getJGraph in class BasicGraphFrame

Returns:

the JGraph.

See Also:

BasicGraphFrame.setJGraph(JGraph)

getSelectedModel

public NamedObj getSelectedModel()

Return the model associated with the selected tab. If no tab is selected, returns the root model associated with this frame.

removeComposite

public void removeComposite(NamedObj model)

Remove a workflow from the frame.

removeMenu

public void removeMenu(javax.swing.JMenu menu)

Remove a menu from the menu bar.

setSelectedTab

public void setSelectedTab(NamedObj model)

Set the selected tab to the tab containing a specific model.

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent event)

React to a change in the state of the tabbed pane.

Parameters:

event - The event.

updateTabsForComposite

public void updateTabsForComposite(CompositeEntity composite)

Update the nested tabs displayed for a composite actor. This method removes tabs for sub-composites that no longer exist, and renames the tab titles to match the names of the sub-composites.

updateWindowAttributes

public void updateWindowAttributes()
                            throws IllegalActionException,
                                   NameDuplicationException

Update the size, zoom and position of all the open tabs. This method is typically called when closing the window or writing the moml file out.

Overrides:

updateWindowAttributes in class BasicGraphFrame

Throws:

IllegalActionException - If there is a problem getting a parameter.

NameDuplicationException - If there is a problem creating a parameter.

_createGraphPane

protected diva.graph.GraphPane _createGraphPane(NamedObj entity)

Create a new graph pane. Note that this method is called in constructor of the base class, so it must be careful to not reference local variables that may not have yet been created. This overrides the base class to create a specialized graph controller (an inner class).

Overrides:

_createGraphPane in class ActorGraphFrame

Parameters:

entity - The object to be displayed in the pane.

Returns:

The pane that is created.

_createRightComponent

protected javax.swing.JComponent _createRightComponent(NamedObj entity)

Create the component that goes to the right of the library. NOTE: This is called in the base class constructor, before things have been initialized. Hence, it cannot reference local variables.

Overrides:

_createRightComponent in class BasicGraphFrame

Parameters:

entity - The entity to display in the component.

Returns:

The component that goes to the right of the library.