Package ptolemy.actor.gui

Class PtolemyDialog

  • All Implemented Interfaces:
    java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
    Direct Known Subclasses:
    GTIngredientsEditor, OpenInstanceDialog, PortConfigurerDialog, SearchResultsDialog, UnitConstraintsDialog, UnitSolverDialog
    public abstract class PtolemyDialog
extends javax.swing.JFrame
implements java.awt.event.ActionListener
    Ptolemy specific dialog.
    Since:
    Ptolemy II 4.0
    Version:
    $Id$
    Author:
    Rowland R Johnson
    See Also:
    Serialized Form
    Pt.AcceptedRating:
    Red (rowland)
    Pt.ProposedRating:
    Red (rowland)

    • 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected javax.swing.JButton _cancelButton
      The cancel button.
      protected Configuration _configuration
      The configuration that corresponds with this dialog.
      protected javax.swing.JButton _helpButton
      The help button.

      • Fields inherited from class javax.swing.JFrame

        accessibleContext, 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.image.ImageObserver

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

      • Fields inherited from interface javax.swing.WindowConstants

        DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void _cancel()
      Cancel this dialog, saving if necessary.
      protected abstract void _createExtendedButtons​(javax.swing.JPanel _buttons)
      Created extended buttons.
      protected abstract java.net.URL _getHelpURL()
      Get the URL that is the help for this dialog.
      protected boolean _isDirty()
      Return true if any of the values have been changed, but the state has not yet been saved.
      protected void _processButtonPress​(java.lang.String button)
      Process button presses.
      protected void _setDirty​(boolean dirty)
      Set the boolean that determines if the GUI has a change that has not applied to the system.
      protected void _showHelp()
      Display the help URL.
      void actionPerformed​(java.awt.event.ActionEvent aEvent)
      If the action event is a JButton, process the button press.
      Entity getTarget()
      Return the target.
      void saveIfRequired()
      If necessary save any state.
      void setContents​(javax.swing.JComponent contents)
      Set the contents of this dialog.
      void setScrollableContents​(javax.swing.JComponent contents)
      Set the contents of this dialog.
      void setTarget​(Entity entity)
      Set the target of this dialog.

      • 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, setBackground, 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, dispose, 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, pack, 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, show, 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

    • Field Detail

      • _configuration

        protected Configuration _configuration
        The configuration that corresponds with this dialog. The configuration is used to properly display the help text.

      • _helpButton

        protected javax.swing.JButton _helpButton
        The help button.

      • _cancelButton

        protected javax.swing.JButton _cancelButton
        The cancel button.

    • Constructor Detail

      • PtolemyDialog

        public PtolemyDialog​(java.lang.String title,
                     DialogTableau dialogTableau,
                     java.awt.Frame owner,
                     Entity target,
                     Configuration configuration)
        Construct a PtolemyDialog.
        Parameters:
        title - The title of the PtolemyDialog.
        dialogTableau - The dialogTableau, used to set the title.
        owner - The frame.
        target - The model
        configuration - a Configuration object

    • Method Detail

      • actionPerformed

        public void actionPerformed​(java.awt.event.ActionEvent aEvent)
        If the action event is a JButton, process the button press.
        Specified by:
        actionPerformed in interface java.awt.event.ActionListener
        Parameters:
        aEvent - The event.

      • saveIfRequired

        public void saveIfRequired()
        If necessary save any state. In this base class, do nothing. Derived classes should extend this method so that the _cancel() method save state if necessary.

      • setContents

        public void setContents​(javax.swing.JComponent contents)
        Set the contents of this dialog.
        Parameters:
        contents - The contents.

      • setScrollableContents

        public void setScrollableContents​(javax.swing.JComponent contents)
        Set the contents of this dialog.
        Parameters:
        contents - The contents.

      • setTarget

        public void setTarget​(Entity entity)
        Set the target of this dialog.
        Parameters:
        entity - Target of this dialog.
        See Also:
        getTarget()

      • _cancel

        protected void _cancel()
        Cancel this dialog, saving if necessary.

      • _createExtendedButtons

        protected abstract void _createExtendedButtons​(javax.swing.JPanel _buttons)
        Created extended buttons.
        Parameters:
        _buttons - The buttons to be created.

      • _getHelpURL

        protected abstract java.net.URL _getHelpURL()
        Get the URL that is the help for this dialog.
        Returns:
        URL that is the help for this dialog.

      • _isDirty

        protected boolean _isDirty()
        Return true if any of the values have been changed, but the state has not yet been saved.
        Returns:
        True if values have been changed but not saved.

      • _processButtonPress

        protected void _processButtonPress​(java.lang.String button)
        Process button presses. The button semantics are
        Commit - Apply and then cancel the dialog.
        Apply - make the changes that have been expressed thus far.
        Help - Show the associated help.
        Cancel - Remove the dialog without making any pending changes.
        Parameters:
        button - The name of the button to process.

      • _setDirty

        protected void _setDirty​(boolean dirty)
        Set the boolean that determines if the GUI has a change that has not applied to the system.
        Parameters:
        dirty - True if the GUI has a change that has not been applied.

      • _showHelp

        protected void _showHelp()
        Display the help URL.
        See Also:
        _getHelpURL()