Package ptolemy.actor.gui

Class ModelFrame

  • All Implemented Interfaces:
    java.awt.event.WindowFocusListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, ExecutionListener, StatusHandler
    Direct Known Subclasses:
    RunTableau.RunFrame
    public class ModelFrame
extends PtolemyFrame
implements ExecutionListener
    ModelFrame is a top-level window containing a Ptolemy II model control panel. It contains a ModelPane, and has a menu bar and a status bar for message reporting. This class is intended to be used with composite actors, which are executable models.
    Since:
    Ptolemy II 0.4
    Version:
    $Id$
    Author:
    Edward A. Lee
    See Also:
    ModelPane, Serialized Form
    Pt.AcceptedRating:
    Yellow (janneck)
    Pt.ProposedRating:
    Green (eal)

    • Nested Class Summary

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean _clear()
      Clear the current contents.
      protected boolean _close()
      Close the window.
      protected void _help()
      Display more detailed information than given by _about().
      void executionError​(Manager manager, java.lang.Throwable throwable)
      Report that an execution error has occurred.
      void executionFinished​(Manager manager)
      Report that execution of the model has finished.
      void managerStateChanged​(Manager manager)
      Report that a manager state has changed.
      ModelPane modelPane()
      Return the container into which to place placeable objects.
      void setBackground​(java.awt.Color background)
      Set background color.
      void setModel​(CompositeActor model)
      Set the associated model.

      • 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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, 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

      • ModelFrame

        public ModelFrame​(CompositeActor model)
        Construct a frame to control the specified Ptolemy II model. After constructing this, it is necessary to call setVisible(true) to make the frame appear. This creates an instance of ModelPane and puts it in a top-level window. This is typically done by calling show() on the controlling tableau.
        Parameters:
        model - The model to put in this frame, or null if none.
        See Also:
        ModelPane, Tableau.show(), ModelPane

      • ModelFrame

        public ModelFrame​(CompositeActor model,
                  Tableau tableau)
        Construct a frame to control the specified Ptolemy II model. After constructing this, it is necessary to call setVisible(true) to make the frame appear. This creates an instance of ModelPane and puts it in a top-level window. This is typically done by calling show() on the controlling tableau.
        Parameters:
        model - The model to put in this frame, or null if none.
        tableau - The tableau responsible for this frame, or null if none.
        See Also:
        ModelPane, Tableau.show()

      • ModelFrame

        public ModelFrame​(CompositeActor model,
                  Tableau tableau,
                  ModelPane pane)
        Construct a frame to control the specified Ptolemy II model. After constructing this, it is necessary to call setVisible(true) to make the frame appear. This creates an instance of ModelPane and puts it in a top-level window.
        Parameters:
        model - The model to put in this frame, or null if none.
        tableau - The tableau responsible for this frame, or null if none.
        pane - The model pane to place inside the frame.
        See Also:
        ModelPane, Tableau.show()

    • Method Detail

      • executionError

        public void executionError​(Manager manager,
                           java.lang.Throwable throwable)
        Report that an execution error has occurred. This method is called by the specified manager.
        Specified by:
        executionError in interface ExecutionListener
        Parameters:
        manager - The manager calling this method.
        throwable - The throwable being reported.

      • executionFinished

        public void executionFinished​(Manager manager)
        Report that execution of the model has finished.
        Specified by:
        executionFinished in interface ExecutionListener
        Parameters:
        manager - The manager calling this method.

      • managerStateChanged

        public void managerStateChanged​(Manager manager)
        Report that a manager state has changed. This method is called by the specified manager.
        Specified by:
        managerStateChanged in interface ExecutionListener
        Parameters:
        manager - The manager calling this method.
        See Also:
        Manager.getState()

      • modelPane

        public ModelPane modelPane()
        Return the container into which to place placeable objects. These are objects in a Ptolemy II model that have their own user interface, such as plotters.
        Returns:
        A container for graphical displays.

      • setBackground

        public void setBackground​(java.awt.Color background)
        Set background color. This overrides the base class to set the background of the contained ModelPane.
        Overrides:
        setBackground in class Top
        Parameters:
        background - The background color.

      • setModel

        public void setModel​(CompositeActor model)
        Set the associated model. This overrides the base class to add this object as an execution listener to the manager, if there is one.
        Parameters:
        model - The associated model.

      • _clear

        protected boolean _clear()
        Clear the current contents. First, check to see whether the contents have been modified, and if so, then prompt the user to save them. A return value of false indicates that the user has canceled the action. Then, if the user does not cancel, replace the model with a new, blank composite actor.
        Overrides:
        _clear in class PtolemyFrame
        Returns:
        False if the user cancels the clear.

      • _close

        protected boolean _close()
        Close the window. Override the base class to remove the execution listener from the manager, and to notify the contained ModelPane.
        Overrides:
        _close in class PtolemyFrame
        Returns:
        False if the user cancels on a save query.

      • _help

        protected void _help()
        Display more detailed information than given by _about(). This class displays information contained by Documentation attributes in the associated model.
        Overrides:
        _help in class PtolemyFrame
        See Also:
        Documentation