org.simbrain.util
Class StandardDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      org.simbrain.util.StandardDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

BackpropDialog, BackpropPropertiesDialog, BackpropTrainingDialog, CompetitiveDialog, CompetitivePropertiesDialog, DialogCoordinate, DialogGeneral, DialogGraphics, DialogOdorWorld, DialogOdorWorldEntity, DialogOdorWorldWall, DialogSammon, DialogScript, DialogTextWorld, ElmanDialog, HopfieldDialog, HopfieldPropertiesDialog, LMSDialog, LMSPropertiesDialog, LMSTrainingDialog, NetworkDialog, NeuronDialog, StandardNetworkDialog, SynapseDialog, WTADialog, WTAPropertiesDialog

public class StandardDialog
extends JDialog

StandardDialog implements a standard data entry dialog with "Ok" and "Cancel" buttons. Subclasses can override the isDataValid(), okButtonPressed(), and cancelButtonPressed() methods to perform implementation specific processing.

By default, the dialog is modal, and has a JPanel with a BorderLayout for its content pane.

Author:

David Fraser, Michael Harris

See Also:

Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

(package private) ActionListener

actionListener Action listener.

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

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, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

StandardDialog()
This method is the default constructor.

StandardDialog(Dialog parent, String title)
This method creates a StandardDialog with the given parent dialog and title.

StandardDialog(Frame parent, String title)
This method creates a StandardDialog with the given parent frame and title.

Method Summary

void	addButton(JButton theButton) Adds a new button to the panel.
protected void	closeDialogCancel() Overriden to perform specific clean up when dialog closed.
protected void	closeDialogOk() Overrideen to perform specific clean up when dialog closed.
void	commit() Commit any changes made.
Container	getContentPane() This method gets the content pane for adding components.
boolean	hasUserCancelled() This method returns true if the User cancelled the dialog otherwise false.
protected boolean	isValidData() This method is used to validate the current dialog box.
void	returnToCurrentPrefs() Returns fields changed to current preferences.
void	setAsDefault() Sets changed fields as current preferences.
void	setContentPane(Container contentPane) This method sets the content pane for adding components.

Methods inherited from class javax.swing.JDialog

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

Methods inherited from class java.awt.Dialog

addNotify, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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, removeNotify, 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, remove, 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

Field Detail

actionListener

ActionListener actionListener

Action listener.

Constructor Detail

StandardDialog

public StandardDialog()

This method is the default constructor.

StandardDialog

public StandardDialog(Frame parent,
                      String title)

This method creates a StandardDialog with the given parent frame and title.

Parameters:

parent - The parent frame for the dialog.

title - The title to display in the dialog.

StandardDialog

public StandardDialog(Dialog parent,
                      String title)

This method creates a StandardDialog with the given parent dialog and title.

Parameters:

parent - The parent dialog for the dialog.

title - The title to display in the dialog.

Method Detail

commit

public void commit()

Commit any changes made.

returnToCurrentPrefs

public void returnToCurrentPrefs()

Returns fields changed to current preferences.

setAsDefault

public void setAsDefault()

Sets changed fields as current preferences.

closeDialogOk

protected void closeDialogOk()

Overrideen to perform specific clean up when dialog closed.

closeDialogCancel

protected void closeDialogCancel()

Overriden to perform specific clean up when dialog closed.

getContentPane

public Container getContentPane()

This method gets the content pane for adding components. Components should not be added directly to the dialog.

Specified by:

getContentPane in interface RootPaneContainer

Overrides:

getContentPane in class JDialog

Returns:

the content pane for the dialog.

setContentPane

public void setContentPane(Container contentPane)

This method sets the content pane for adding components. Components should not be added directly to the dialog.

Specified by:

setContentPane in interface RootPaneContainer

Overrides:

setContentPane in class JDialog

Parameters:

contentPane - The content pane for the dialog.

hasUserCancelled

public boolean hasUserCancelled()

This method returns true if the User cancelled the dialog otherwise false. The dialog is cancelled if the "Cancel" button is pressed or the "Close" window button is pressed, or the "Escape" key is pressed. In other words, if the User has caused the dialog to close by any method other than by pressing the "Ok" button, this method will return true.

isValidData

protected boolean isValidData()

This method is used to validate the current dialog box. This method provides a default response of true. This method should be implemented by each dialog that extends this class.

Returns:

a boolean indicating if the data is valid. true indicates that all of the fields were validated correctly and false indicates the validation failed

addButton

public void addButton(JButton theButton)

Adds a new button to the panel.

Parameters:

theButton - button to be added