ptolemy.actor.gui
Class PtolemyDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      ptolemy.actor.gui.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, 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: PtolemyDialog.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Rowland R Johnson

See Also:

Serialized Form

Accepted Rating:

Red (rowland)

Proposed Rating:

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

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected javax.swing.JButton	_cancelButton The cancel button.
protected Configuration	_configuration The configuration that corresponds with this dialog.
private javax.swing.JComponent	_contents
private DialogTableau	_dialogTableau
private boolean	_dirty The following is true if any of the values have been changed but not applied.
protected javax.swing.JButton	_helpButton The help button.
private java.awt.Frame	_owner
private Entity	_target

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

PtolemyDialog(java.lang.String title, DialogTableau dialogTableau, java.awt.Frame owner, Entity target, Configuration configuration)
Construct a PtolemyDialog.

Method Summary

protected void	_cancel() Cancel this dialog, saving if necessary.
private javax.swing.JPanel	_createButtonsPanel() Create the buttons panel.
protected abstract void	_createExtendedButtons(javax.swing.JPanel _buttons) Created extended buttons.
private void	_deiconify()
protected abstract java.net.URL	_getHelpURL() Get the URL that is the help for this dialog.
private void	_iconify()
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, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, 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.

_contents

private javax.swing.JComponent _contents

_dirty

private boolean _dirty

The following is true if any of the values have been changed but not applied.

_dialogTableau

private DialogTableau _dialogTableau

_owner

private java.awt.Frame _owner

_target

private Entity _target

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.

getTarget

public Entity getTarget()

Return the target.

Returns:

The target.

See Also:

setTarget(Entity)

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()

_createButtonsPanel

private javax.swing.JPanel _createButtonsPanel()

Create the buttons panel.

_deiconify

private void _deiconify()

_iconify

private void _iconify()