Package ptolemy.gui

Class ComponentDialog

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
    Direct Known Subclasses:
    BreakpointConfigurerDialog, EditParametersDialog, RenameDialog
    public class ComponentDialog
extends javax.swing.JDialog
    This class is a modal dialog box that contains an arbitrary component. It can be used, for example, to put an instance of Query in a top-level dialog box. The general way to use this class is to create the component that you wish to have contained in the dialog. Then pass that component to the constructor of this class. The dialog is modal, so the statement that creates the dialog will not return until the user dismisses the dialog. The method buttonPressed() can then be called to find out whether the user clicked the OK button or the Cancel button (or any other button specified in the constructor). Then you can access the component to determine what values were set by the user.

    If the component that is added implements the CloseListener interface, then that component is notified when this dialog closes.

    Since:
    Ptolemy II 0.4
    Version:
    $Id$
    Author:
    Edward A. Lee
    See Also:
    CloseListener, Serialized Form
    Pt.AcceptedRating:
    Yellow (janneck)
    Pt.ProposedRating:
    Yellow (eal)

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JDialog

        javax.swing.JDialog.AccessibleJDialog

      • Nested classes/interfaces inherited from class java.awt.Dialog

        java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType

      • 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 java.lang.String _buttonPressed
      The label of the button pushed to dismiss the dialog.
      protected ptolemy.gui.ComponentDialog.PropChangeListener _propChangeListener
      A reference to the PropertyChangeListener.
      protected ptolemy.gui.ComponentDialog.WindowClosingAdapter _windowClosingAdapter
      A reference to the WindowClosingAdapter.
      java.awt.Component contents
      The component contained by this dialog.

      • Fields inherited from class javax.swing.JDialog

        accessibleContext, rootPane, rootPaneCheckingEnabled

      • Fields inherited from class java.awt.Dialog

        DEFAULT_MODALITY_TYPE

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      ComponentDialog​(java.awt.Frame owner, java.lang.String title, java.awt.Component component)
      Construct a dialog with the specified owner, title, and component.
      ComponentDialog​(java.awt.Frame owner, java.lang.String title, java.awt.Component component, java.lang.String[] buttons)
      Construct a dialog with the specified owner, title, component, and buttons.
      ComponentDialog​(java.awt.Frame owner, java.lang.String title, java.awt.Component component, java.lang.String[] buttons, java.lang.String message)
      Construct a dialog with the specified owner, title, component, buttons, and message.
      ComponentDialog​(java.awt.Frame owner, java.lang.String title, java.awt.Component component, java.lang.String[] buttons, java.lang.String message, boolean resizable)
      Construct a dialog with the specified owner, title, component, buttons, and message.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void _handleClosing()
      If the contents of this dialog implements the CloseListener interface, then notify it that the window has closed, unless notification has already been done (it is guaranteed to be done only once).
      java.lang.String buttonPressed()
      Return the label of the button that triggered closing the dialog, or an empty string if none.
      void dispose()  
      void setMessage​(java.lang.String message)
      Change the message that was specified in the constructor to read as specified.

      • Methods inherited from class javax.swing.JDialog

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

      • Methods inherited from class java.awt.Dialog

        addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

      • 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, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, remove, 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

    • Field Detail

      • contents

        public java.awt.Component contents
        The component contained by this dialog.

      • _buttonPressed

        protected java.lang.String _buttonPressed
        The label of the button pushed to dismiss the dialog.

      • _windowClosingAdapter

        protected ptolemy.gui.ComponentDialog.WindowClosingAdapter _windowClosingAdapter
        A reference to the WindowClosingAdapter.

      • _propChangeListener

        protected ptolemy.gui.ComponentDialog.PropChangeListener _propChangeListener
        A reference to the PropertyChangeListener.

    • Constructor Detail

      • ComponentDialog

        public ComponentDialog​(java.awt.Frame owner,
                       java.lang.String title,
                       java.awt.Component component)
        Construct a dialog with the specified owner, title, and component. An "OK" and a "Cancel" button are added to the dialog. The dialog is placed relative to the owner.
        Parameters:
        owner - The object that, per the user, appears to be generating the dialog.
        title - The title of the dialog.
        component - The component to insert in the dialog.

      • ComponentDialog

        public ComponentDialog​(java.awt.Frame owner,
                       java.lang.String title,
                       java.awt.Component component,
                       java.lang.String[] buttons)
        Construct a dialog with the specified owner, title, component, and buttons. The first button is the "default" in that it is the one activated by "Enter" or "Return" keys. If the last argument is null, then an "OK" and a "Cancel" button will be created. The dialog is placed relative to the owner.
        Parameters:
        owner - The object that, per the user, appears to be generating the dialog.
        title - The title of the dialog.
        component - The component to insert in the dialog.
        buttons - An array of labels for buttons at the bottom of the dialog.

      • ComponentDialog

        public ComponentDialog​(java.awt.Frame owner,
                       java.lang.String title,
                       java.awt.Component component,
                       java.lang.String[] buttons,
                       java.lang.String message)
        Construct a dialog with the specified owner, title, component, buttons, and message. The message is placed above the component. The first button is the "default" in that it is the one activated by "Enter" or "Return" keys. If the buttons argument is null, then an "OK" and a "Cancel" button will be created. The dialog is placed relative to the owner.
        Parameters:
        owner - The object that, per the user, appears to be generating the dialog.
        title - The title of the dialog.
        component - The component to insert in the dialog.
        buttons - An array of labels for buttons at the bottom of the dialog.
        message - A message to place above the component, or null if no message is needed.

      • ComponentDialog

        public ComponentDialog​(java.awt.Frame owner,
                       java.lang.String title,
                       java.awt.Component component,
                       java.lang.String[] buttons,
                       java.lang.String message,
                       boolean resizable)
        Construct a dialog with the specified owner, title, component, buttons, and message. The message is placed above the component. The first button is the "default" in that it is the one activated by "Enter" or "Return" keys. If the buttons argument is null, then an "OK" and a "Cancel" button will be created. The dialog is placed relative to the owner.
        Parameters:
        owner - The object that, per the user, appears to be generating the dialog.
        title - The title of the dialog.
        component - The component to insert in the dialog.
        buttons - An array of labels for buttons at the bottom of the dialog.
        message - A message to place above the component, or null if no message is needed.
        resizable - True to allow the dialog to be resized.

    • Method Detail

      • buttonPressed

        public java.lang.String buttonPressed()
        Return the label of the button that triggered closing the dialog, or an empty string if none.
        Returns:
        The label of the button pressed.

      • dispose

        public void dispose()
        Overrides:
        dispose in class java.awt.Window

      • setMessage

        public void setMessage​(java.lang.String message)
        Change the message that was specified in the constructor to read as specified. If no message was specified in the constructor, then do nothing.
        Parameters:
        message - The new message.

      • _handleClosing

        protected void _handleClosing()
        If the contents of this dialog implements the CloseListener interface, then notify it that the window has closed, unless notification has already been done (it is guaranteed to be done only once).