be.ugent.caagt.swirl.dialogs
Class SimpleDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      be.ugent.caagt.swirl.dialogs.SimpleDialog

All Implemented Interfaces:

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

public class SimpleDialog
extends javax.swing.JDialog

Simple dialog window consisting of three different components:

• A central panel, provided by the client.
• An OK button and a CANCEL button, placed at the bottom right of the window.
• An optional icon, placed to the left of the central panel.

To use a dialog object of this type, you should first construct it, then add the central component to it, using setCentralComponent(javax.swing.JComponent) and finally initialize it by calling init. Once initialized, you can call launch() several times and inspect the user action using getReturnValue().

Alternatively, consider extending the class DialogPanel and using one of its createDialog methods.

An icon can be installed, changed or removed using setIcon(javax.swing.Icon) before the dialog is launched.

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

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

static int	APPROVE_OPTION Return value if approve (yes, ok) is chosen.
protected javax.swing.JPanel	buttonPanel Button panel.
static int	CANCEL_OPTION Return value if cancel is chosen (or window is simply closed).
static int	ERROR_OPTION Return value if an error occured.

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

Method Summary

static SimpleDialog	createSimpleDialog(java.awt.Component parent, java.lang.String title, boolean modal) Creates a new simple dialog with the given component as a parent.
javax.swing.JPanel	getButtonPanel() Return the button panel for this dialog.
int	getReturnValue() Get the last value returned by launch().
void	init() Initializes and populates the dialog.
protected void	initButtonPanel() Creates the button panel and makes the OK-button the default button.
int	launch() Show this dialog and wait for the user to respond to it.
int	launch(int x, int y) Show this dialog and wait for the user to respond to it.
int	launchAtPointerPosition() Show this dialog and wait for the user to respond to it.
void	setCentralComponent(javax.swing.JComponent component) Add the central component to the dialog.
void	setIcon(javax.swing.Icon icon) Add the icon to the dialog (or remove when null}.
static int	showSimpleDialog(java.awt.Component parent, java.lang.String title, javax.swing.JComponent panel) Show a simple modal dialog with the given panel at its center and wait for the user to respond to it.
static int	showSimpleDialog(java.awt.Component parent, java.lang.String title, javax.swing.JComponent panel, javax.swing.Icon icon) Show a simple modal dialog with the given panel at its center and wait for the user to respond to it.

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, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CANCEL_OPTION

public static final int CANCEL_OPTION

Return value if cancel is chosen (or window is simply closed).

See Also:

Constant Field Values

APPROVE_OPTION

public static final int APPROVE_OPTION

Return value if approve (yes, ok) is chosen.

See Also:

Constant Field Values

ERROR_OPTION

public static final int ERROR_OPTION

Return value if an error occured.

See Also:

Constant Field Values

buttonPanel

protected javax.swing.JPanel buttonPanel

Button panel.

Method Detail

createSimpleDialog

public static SimpleDialog createSimpleDialog(java.awt.Component parent,
                                              java.lang.String title,
                                              boolean modal)

Creates a new simple dialog with the given component as a parent.

setCentralComponent

public void setCentralComponent(javax.swing.JComponent component)

Add the central component to the dialog.

setIcon

public void setIcon(javax.swing.Icon icon)

Add the icon to the dialog (or remove when null}.

initButtonPanel

protected void initButtonPanel()

Creates the button panel and makes the OK-button the default button.

getButtonPanel

public javax.swing.JPanel getButtonPanel()

Return the button panel for this dialog. Can be used to add further buttons.

getReturnValue

public int getReturnValue()

Get the last value returned by launch(). One of CANCEL_OPTION, APPROVE_OPTION or ERROR_OPTION.

launch

public int launch()

Show this dialog and wait for the user to respond to it. Displays the dialog centered with respect to the parent component.

Returns:

an indication of the users action, either CANCEL_OPTION, APPROVE_OPTION or ERROR_OPTION.

launchAtPointerPosition

public int launchAtPointerPosition()

Show this dialog and wait for the user to respond to it. Displays the dialog with the top left corner of its root pane at the current pointer position.

Returns:

an indication of the users action, either CANCEL_OPTION, APPROVE_OPTION or ERROR_OPTION.

launch

public int launch(int x,
                  int y)

Show this dialog and wait for the user to respond to it. Displays the dialog window with its top left corner at the given relative position with respect to the parent component.

Returns:

an indication of the users action, either CANCEL_OPTION, APPROVE_OPTION or ERROR_OPTION.

showSimpleDialog

public static int showSimpleDialog(java.awt.Component parent,
                                   java.lang.String title,
                                   javax.swing.JComponent panel)

Show a simple modal dialog with the given panel at its center and wait for the user to respond to it.

Parameters:

panel - Central component to be displayed

title - Title of the dialog window

Returns:

an indication of the users action, either CANCEL_OPTION, APPROVE_OPTION or ERROR_OPTION.

showSimpleDialog

public static int showSimpleDialog(java.awt.Component parent,
                                   java.lang.String title,
                                   javax.swing.JComponent panel,
                                   javax.swing.Icon icon)

Show a simple modal dialog with the given panel at its center and wait for the user to respond to it.

Parameters:

panel - Central component to be displayed

title - Title of the dialog window

icon - Icon to be displayed to the left of the panel

Returns:

an indication of the users action, either CANCEL_OPTION, APPROVE_OPTION or ERROR_OPTION.

init

public void init()

Initializes and populates the dialog. Must be called once before the first call to launch().