com.ontimize.gui.field.html.dialogs

Class StandardDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.ontimize.gui.container.EJDialog

com.ontimize.gui.field.html.dialogs.StandardDialog

All Implemented Interfaces:

Internationalization, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

OptionDialog

public class StandardDialog
extends EJDialog
implements Internationalization

This class 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.

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, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUTTONS_CENTER
static int	BUTTONS_LEFT
static int	BUTTONS_RIGHT
protected JButton	cancelB
static int	COMPONENT_SPACING The spacing between components in pixels
protected String	dialogTitle
protected boolean	myIsDialogCancelled Flag indicating if the "Cancel" button was pressed to close dialog
protected Container	myUserContentPane The content pane for holding user components
protected JButton	okB
protected ResourceBundle	resourceBundle

Fields inherited from class com.ontimize.gui.container.EJDialog

actions, askQuestionEverOnClose, askQuestionOnEsc, autoPackOnOpen, changeLAF, closeQuestion, defaultValueAskQuestionOnClose, defaultValueAskQuestionOnEsc, focusSet, glassPanel, keys, keyStrokes, opaque, previousGlassPane, sizePositionPreference

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 com.ontimize.gui.i18n.Internationalization

DEBUG_LANGUAGE

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(Dialog parent, String title) This method creates a StandardDialog with the given parent dialog and title.
StandardDialog(Dialog parent, String title, int orientation)
StandardDialog(Dialog parent, String title, int orientation, int spacing)
StandardDialog(Frame parent, String title) This method creates a StandardDialog with the given parent frame and title.
StandardDialog(Frame parent, String title, int orientation)
StandardDialog(Frame parent, String title, int orientation, int spacing)

Method Summary

Methods

Modifier and Type	Method and Description
Container	getContentPane() This method gets the content pane for adding components.
Vector	getTextsToTranslate() Returns all the texts in the element suitable for being translated.
boolean	hasUserCancelled() This method returns true if the User cancelled the dialog otherwise false.
protected void	init(int orientation, int spacing) This method sets up the default attributes of the dialog and the content pane.
protected boolean	isValidData() This method is used to validate the current dialog box.
void	setComponentLocale(Locale l)
void	setContentPane(Container contentPane) This method sets the content pane for adding components.
void	setResourceBundle(ResourceBundle resourceBundle) Sets the language resource bundle.

Methods inherited from class com.ontimize.gui.container.EJDialog

askCloseQuestion, dispose, getSizePositionPreference, initWindowListener, isAskOnClose, isAskOnEsc, pack, processKeyEvent, processWindowEvent, registerKeyBindings, setAction, setActionForKey, setAskOnClose, setAskOnEsc, setAutoPackOnOpen, setInitialFocus, setSizePositionPreference, setVisible, transparent

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, 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, 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, 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, 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

Field Detail

BUTTONS_CENTER

public static final int BUTTONS_CENTER

See Also:

Constant Field Values

BUTTONS_LEFT

public static final int BUTTONS_LEFT

See Also:

Constant Field Values

BUTTONS_RIGHT

public static final int BUTTONS_RIGHT

See Also:

Constant Field Values

COMPONENT_SPACING

public static final int COMPONENT_SPACING

The spacing between components in pixels

See Also:

Constant Field Values

myIsDialogCancelled

protected boolean myIsDialogCancelled

Flag indicating if the "Cancel" button was pressed to close dialog

myUserContentPane

protected Container myUserContentPane

The content pane for holding user components

resourceBundle

protected ResourceBundle resourceBundle

okB

protected JButton okB

cancelB

protected JButton cancelB

dialogTitle

protected String dialogTitle

Constructor Detail

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.

StandardDialog

public StandardDialog(Dialog parent,
              String title,
              int orientation,
              int spacing)

StandardDialog

public StandardDialog(Frame parent,
              String title,
              int orientation,
              int spacing)

StandardDialog

public StandardDialog(Frame parent,
              String title,
              int orientation)

StandardDialog

public StandardDialog(Dialog parent,
              String title,
              int orientation)

Method Detail

init

protected void init(int orientation,
        int spacing)

This method sets up the default attributes of the dialog and the content pane.

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

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.

setComponentLocale

public void setComponentLocale(Locale l)

Specified by:

setComponentLocale in interface Internationalization

setResourceBundle

public void setResourceBundle(ResourceBundle resourceBundle)

Description copied from interface: Internationalization

Sets the language resource bundle. When the application changes the configured language, for all the objects that implement this interface this method must be called with the new file.
The method must translate all the elements that have texts in the GUI

Specified by:

setResourceBundle in interface Internationalization

Parameters:

resourceBundle - the new language bundle.

getTextsToTranslate

public Vector getTextsToTranslate()

Description copied from interface: Internationalization

Returns all the texts in the element suitable for being translated.

Specified by:

getTextsToTranslate in interface Internationalization

Returns:

all the texts in the element suitable for being translated.