ptolemy.vergil.actor

Class ActorGraphFrame

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

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

Direct Known Subclasses:

ActorGraphDBFrame, CaseGraphFrame, NavigableActorGraphFrame

public class ActorGraphFrame
extends ExtendedGraphFrame

This is a graph editor frame for ptolemy models. Given a composite entity and an instance of ActorGraphTableau, it creates an editor and populates the menus and toolbar. This overrides the base class to associate with the editor an instance of ActorEditorGraphController.

Since:

Ptolemy II 2.0

Version:

$Id$

Author:

Steve Neuendorffer, Contributor: Edward A. Lee, KIELER Layout: Christian Motika <cmot@informatik.uni-kiel.de>

See Also:

ActorEditorGraphController, Serialized Form

Pt.AcceptedRating:

Red (johnr)

Pt.ProposedRating:

Red (neuendor)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ActorGraphFrame.DebugMenuListener Listener for debug menu commands.
static class	ActorGraphFrame.InstantiateAttributeAction An action to instantiate an attribute given a class name.
static class	ActorGraphFrame.InstantiateEntityAction An action to instantiate an entity given a class name.

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

Modifier and Type	Field and Description
protected ActorEditorGraphController	_controller The graph controller.
protected javax.swing.Action	_createHierarchyAction The action for creating a level of hierarchy.
protected javax.swing.JMenu	_debugMenu Debug menu for this frame.
protected ActorGraphFrame.DebugMenuListener	_debugMenuListener Listener for debug menu commands.
protected javax.swing.Action	_exportDesignPatternAction The action for exporting a design pattern.
protected javax.swing.Action	_importDesignPatternAction The action for importing a design pattern.
protected javax.swing.Action	_importLibraryAction The action for importing a library of components.
protected javax.swing.Action	_instantiateAttributeAction The action for instantiating an attribute.
protected javax.swing.Action	_instantiateEntityAction The action for instantiating an entity.
protected javax.swing.Action	_instantiatePortAction The action for instantiating a port.
protected javax.swing.Action	_saveInLibraryAction The action for saving the current model in a library.

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, BACKGROUND_COLOR, 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
ActorGraphFrame(CompositeEntity entity, Tableau tableau) Construct a frame associated with the specified Ptolemy II model.
ActorGraphFrame(CompositeEntity entity, Tableau tableau, LibraryAttribute defaultLibrary) Construct a frame associated with the specified Ptolemy II model.

Method Summary

Modifier and Type	Method and Description
protected void	_addMenus() Create the menus that are used by this frame.
protected boolean	_close() If the ptolemy model associated with this frame is a top-level composite actor, use its manager to stop it.
protected javax.swing.JMenuItem[]	_createFileMenuItems() Create the items in the File menu.
protected GraphPane	_createGraphPane(NamedObj entity) Create a new graph pane.
protected void	_initActorGraphFrame() Initialize this class.
void	dispose() Dispose of this frame.
static java.io.File	importLibrary(java.io.File lastDirectory, java.awt.Frame frame, Configuration configuration) Import a library by first opening a file chooser dialog and then importing the specified library.

Methods inherited from class ptolemy.vergil.basic.ExtendedGraphFrame

_initExtendedGraphFrame, cancelFullScreen, fullScreen

Methods inherited from class ptolemy.vergil.basic.BasicGraphFrame

_addLayoutMenu, _addReloadAccessorsMenu, _checkForImplied, _createDefaultLibrary, _createRightComponent, _createSizeAttribute, _createSizeAttribute, _deleteMoML, _exportDesignPattern, _finishExportDesignPattern, _getCenter, _getDirectory, _getGraphController, _getGraphModel, _getRightComponent, _getSelectionSet, _getVisibleCanvasRectangle, _getVisibleRectangle, _initBasicGraphFrame, _initBasicGraphFrameActions, _initBasicGraphFrameInitialization, _initBasicGraphFrameRightComponent, _initBasicGraphFrameRightComponentMouseListeners, _initBasicGraphFrameSetZoomAndPan, _initBasicGraphFrameSetZoomAndPane, _initBasicGraphFrameToolBarZoomButtons, _initLayoutGuiAction, _initReloadAccessorsAction, _isDesignPattern, _prepareExportDesignPattern, _saveAsFileDialogComponent, _saveAsJFileChooserComponent, _setBackgroundColor, _setCenter, _setDirectory, _setDropIntoEnabled, _updateWindowAttributes, _writeFile, _zoom, changeExecuted, changeFailed, clearSelection, copy, createHierarchy, cut, delete, disposeSuper, expandAllLibraryRows, exportDesignPattern, getBasicGraphFrame, getBasicGraphFrame, getCenter, getContentSize, getFigureUnder, getFrame, getGraphPanner, getJGraph, 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, updateWindowAttributes, writeHTML, writeImage, writeImage, zoom, zoomFit, zoomFit, zoomReset

Methods inherited from class ptolemy.actor.gui.PtolemyFrame

_clear, _help, _print, _saveAs, getEffigy, getModel, setModel

Methods inherited from class ptolemy.actor.gui.TableauFrame

_about, _confirmFile, _exit, _getDefaultIconImage, _getName, _read, _save, _saveAs, _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, _queryForSave, _saveAsFileDialog, _updateHistory, 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

Field Detail

_controller

protected ActorEditorGraphController _controller

The graph controller. This is created in _createGraphPane().

_debugMenu

protected javax.swing.JMenu _debugMenu

Debug menu for this frame.

_createHierarchyAction

protected javax.swing.Action _createHierarchyAction

The action for creating a level of hierarchy.

_exportDesignPatternAction

protected javax.swing.Action _exportDesignPatternAction

The action for exporting a design pattern.

_saveInLibraryAction

protected javax.swing.Action _saveInLibraryAction

The action for saving the current model in a library.

_importDesignPatternAction

protected javax.swing.Action _importDesignPatternAction

The action for importing a design pattern.

_importLibraryAction

protected javax.swing.Action _importLibraryAction

The action for importing a library of components.

_instantiateAttributeAction

protected javax.swing.Action _instantiateAttributeAction

The action for instantiating an attribute.

_instantiateEntityAction

protected javax.swing.Action _instantiateEntityAction

The action for instantiating an entity.

_instantiatePortAction

protected javax.swing.Action _instantiatePortAction

The action for instantiating a port.

_debugMenuListener

protected ActorGraphFrame.DebugMenuListener _debugMenuListener

Listener for debug menu commands.

Constructor Detail

ActorGraphFrame

public ActorGraphFrame(CompositeEntity entity,
                       Tableau tableau)

Construct a frame associated with the specified Ptolemy II model. 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()

ActorGraphFrame

public ActorGraphFrame(CompositeEntity entity,
                       Tableau tableau,
                       LibraryAttribute defaultLibrary)

Construct a frame associated with the specified Ptolemy II model. 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

dispose

public void dispose()

Dispose of this frame. Override this dispose() method to unattach any listeners that may keep this model from getting garbage collected. This method invokes the dispose() method of the superclass, ExtendedGraphFrame.

Overrides:

dispose in class ExtendedGraphFrame

importLibrary

public static java.io.File importLibrary(java.io.File lastDirectory,
                                         java.awt.Frame frame,
                                         Configuration configuration)

Import a library by first opening a file chooser dialog and then importing the specified library. See UserActorLibrary.openLibrary(Configuration, File) for information on the file format. This method opens up a new blank graph viewer so that the new library is visible.

Parameters:

lastDirectory - The last directory opened, usually the value of getDirectory().

frame - The frame of the owner of the file chooser.

configuration - The Ptolemy configuration.

Returns:

the last directory opened.

_initActorGraphFrame

protected void _initActorGraphFrame()

Initialize this class. In this base class, the help file is set, and various actions are instantiated.

_addMenus

protected void _addMenus()

Create the menus that are used by this frame. It is essential that _createGraphPane() be called before this.

Overrides:

_addMenus in class ExtendedGraphFrame

_close

protected boolean _close()

If the ptolemy model associated with this frame is a top-level composite actor, use its manager to stop it. Remove the listeners that this frame registered with the ptolemy model. Also remove the listeners our graph model has created.

Overrides:

_close in class ExtendedGraphFrame

Returns:

True if the close completes, and false otherwise.

_createFileMenuItems

protected javax.swing.JMenuItem[] _createFileMenuItems()

Create the items in the File menu. A null element in the array represents a separator in the menu.

Overrides:

_createFileMenuItems in class BasicGraphFrame

Returns:

The items in the File menu.

_createGraphPane

protected 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.

Specified by:

_createGraphPane in class BasicGraphFrame

Parameters:

entity - The object to be displayed in the pane.

Returns:

The pane that is created.