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.genericframe.GenericJDialog

org.simbrain.util.StandardDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, GenericFrame

Direct Known Subclasses:

AddEffectorDialog, AddNeuronsDialog, AddSensorDialog, BPTTCreationDialog, CompetitiveGroupCreationDialog, CompetitiveNetworkCreationDialog, CompetitiveTrainingDialog, ConnectionDialog, DataPointColoringDialog, DictionarySelector, EntityDialog, ESNCreationDialog, ESNTrainingDialog, FeedForwardCreationDialog, HopfieldCreationDialog, HopfieldEditTrainDialog, KwtaCreationDialog, KwtaPropertiesDialog, LayoutDialog, LMSCreationDialog, NetworkDialog, NeuronDialog, NeuronGroupCreationDialog, OdorWorldDialog, ProjectionPreferencesDialog, QuickConnectPreferencesPanel.QuickConnectDialog, ScatterPlotDialog, SOMGroupCreationDialog, SOMNetworkCreationDialog, SOMTrainingDialog, SRNCreationDialog, SupervisedTrainingDialog, SynapseDialog, SynapseGroupDialog, TextDialog, WorkspaceDialog, WTACreationDialog

public class StandardDialog
extends GenericJDialog

StandardDialog implements a standard data entry dialog with "Ok" and "Cancel" buttons. Special functionality associated with Simbrain has also been added. 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, Jeff Yoshimi, Zach Tosi

See Also:

Serialized Form

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 and Description
(package private) java.awt.event.ActionListener	actionListener Action listener.

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

Constructors

Constructor and Description
StandardDialog() This method is the default constructor.
StandardDialog(java.awt.Frame parent, java.lang.String title) This method creates a StandardDialog with the given parent frame and title.

Method Summary

Modifier and Type	Method and Description
void	addButton(javax.swing.JButton theButton) Adds a new button to the panel.
void	centerDialog() Center the dialog on the screen.
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	disableOkButton() Disables the Ok button if certain constraints of the dialog have not be fulfilled.
void	enableOkButton() Enables the Ok button.
java.awt.Container	getContentPane() This method gets the content pane for adding components.
javax.swing.JButton	getOkButton() Give other classes access to the Ok button.
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	setAsDoneDialog() If called then this becomes a "Done" dialog.
void	setContentPane(java.awt.Container contentPane) This method sets the content pane for adding components.
static void	setSimulationRunning(boolean isRunning)

Methods inherited from class org.simbrain.util.genericframe.GenericJDialog

setIcon, setMaximizable

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, 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, 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, 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, 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, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, 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 org.simbrain.util.genericframe.GenericFrame

dispose, getBounds, getJMenuBar, getMaximumSize, getPreferredSize, getSize, getTitle, pack, setBounds, setBounds, setJMenuBar, setLocation, setLocationRelativeTo, setMaximumSize, setPreferredSize, setResizable, setTitle, setVisible

Field Detail

actionListener

java.awt.event.ActionListener actionListener

Action listener.

Constructor Detail

StandardDialog

public StandardDialog()

This method is the default constructor.

StandardDialog

public StandardDialog(java.awt.Frame parent,
                      java.lang.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.

Method Detail

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 java.awt.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 javax.swing.RootPaneContainer

Overrides:

getContentPane in class javax.swing.JDialog

Returns:

the content pane for the dialog.

setContentPane

public void setContentPane(java.awt.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 javax.swing.RootPaneContainer

Specified by:

setContentPane in interface GenericFrame

Overrides:

setContentPane in class javax.swing.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.

Returns:

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(javax.swing.JButton theButton)

Adds a new button to the panel.

Parameters:

theButton - button to be added

setSimulationRunning

public static void setSimulationRunning(boolean isRunning)

Parameters:

isRunning - the isRunning to set

centerDialog

public void centerDialog()

Center the dialog on the screen.

disableOkButton

public void disableOkButton()

Disables the Ok button if certain constraints of the dialog have not be fulfilled.

enableOkButton

public void enableOkButton()

Enables the Ok button.

getOkButton

public javax.swing.JButton getOkButton()

Give other classes access to the Ok button.

Returns:

the ok JButton

setAsDoneDialog

public void setAsDoneDialog()

If called then this becomes a "Done" dialog. The cancel button is removed and "Ok" is renamed "Done".