org.mdiutil.swing

Class GenericDialog<O>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.mdiutil.swing.GenericDialog<O>

Type Parameters:

O - tne type of an additional object used to create the dialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable

Direct Known Subclasses:

JDialogBuilderDialog

public abstract class GenericDialog<O>
extends JComponent

A generic dialog component, with Yes / No buttons.The minimal method to implement is the createPanel() method, which allows to create the main panel of the dialog.

Using the Dialog

The basic way to use the dialog involve:

• Creating the dialog
• Showing the dialog: showDialog()

Note that the default result of clicking the "Yes" or "No" buttons is disposing of the dialog.

Example

Example of a MyDialog class usage, extending the GenericDialog class:

  MyDialog dialog = new MyDialog(parent);
  dialog.setDialogTitle("My Dialog");
  int ret = dialog.showDialog();
  if (ret == JFileChooser.APPROVE_OPTION) {
    ... do something
  }

 

Deriving the GenericDialog class

Basic dialog

The minimal method to implement is the createPanel() method, which allows to create the main panel of the dialog. In this case, the dialog will present:

• The main panel
• A bottom bar, with a "Yes", and "Cancel" buttons

It is also advisable to set the title of the Dialog.

Advance derivation

The simplest way to derive the dialog is to change the Labels for the default "Yes" and "No" buttons (see setYesNoLabels(java.lang.String, java.lang.String)). It is possible to change the behavior when clicking these buttons by overriding the doYes() or doCancel() methods. A more advanced derivation is by creating a different bottom panel (see createYesNoPanel()). It is also possible to add a menuBar to the dialog.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenericDialog.DialogAdapter A default implementation for a Dialog listener which will be fired if the dialog is applied (if clicking on "Yes") or cancelled (if clicking on "Cancel" or closing the window without applying the dialog).
static interface	GenericDialog.DialogListener An interface for Dialog listener which will be fired if the dialog is applied (if clicking on "Yes") or cancelled (if clicking on "Cancel" or closing the window without applying the dialog).

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

JComponent.AccessibleJComponent

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
protected AbstractAction	cancelAction The action associated with the default "No" button.
protected JDialog	dialog The internal dialog.
protected Point	dialogLocation The location of the dialog.
protected JFrame	frame The internal dialog associated frame.
protected String	noLabel The "No" Label.
protected O	object An additional object used to create the dialog.
protected String	okLabel The "Ok" Label.
protected int	returnValue The return value.
protected AbstractAction	yesAction The action associated with the default "Yes" button.
protected String	yesLabel The "Yes" Label.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
GenericDialog() Constructor.
GenericDialog(boolean isModal) Constructor.
GenericDialog(O object, boolean isModal) Constructor.
GenericDialog(String title) Constructor, with a title.
GenericDialog(String title, boolean isModal) Constructor, with a title.
GenericDialog(String title, Component parent, boolean isModal) Constructor, with a title, a dialog owner, and a modality.
GenericDialog(String title, Component parent, O object, boolean isModal) Constructor, with a title, a dialog owner, and a modality.
GenericDialog(String title, O object) Constructor, with a title.

Method Summary

Modifier and Type	Method and Description
void	addDialogListener(GenericDialog.DialogListener listener) Set a dialog listener which will be fired if the dialog is applied (if clicking on "Yes") or cancelled (if clicking on "Cancel" or closing the window without applying the dialog).
protected void	apply() Called when applying the dialog.
void	applyBeforeShowingDialog(Component parent) Called before the dialog is shown.
protected void	applyDialogSizeAndPosition() Apply thz size and position of the dialog.
protected void	cancel() Called when cancelling the dialog.
protected JDialog	createDialog(Component parent) Create the dialog, as a child of its parent owner.
protected JDialog	createDialog(Component parent, boolean modal) Create the dialog as a JDialog, as a child of its parent owner.
protected JFrame	createFrame(Component parent) Create the dialog as a JFrame, as a child of its parent owner.
protected JPanel	createOKPanel() Create the Yes Panel, which is part of the Yes / No panel.
protected abstract void	createPanel() The method to implement to create the main panel of the dialog.
protected JPanel	createYesNoPanel() Create the Yes / No bottom Panel.
void	dispose() Dispose the underlying dialog.
protected void	doCancel() Called when clicking the default "No" button.
protected void	doYes() Called when clicking the default "Yes" button.
AbstractAction	getCancelAction() Return the action associated with the default "No" button.
JDialog	getDialog() Return the dialog.
List<GenericDialog.DialogListener>	getDialogListeners() Return the Dialog listeners which will be fired if the dialog is applied or cancelled.
Point	getDialogLocation() Return the dialog location.
JFrame	getFrame() Return the dialog Frame.
JMenuBar	getJMenuBar() Return the MenuBar to use with this Dialog (may be null).
int	getReturnValue() Return the last value of the dialog return value.
AbstractAction	getYesAction() Return the action associated with the default "Yes" button.
boolean	isAlwaysOnTop() Return true if this dialog should always be above other windows.
boolean	isModal() Return the modality of the dialog.
void	removeDialogListener(GenericDialog.DialogListener listener) Remove a dialog listener.
void	setAlwaysOnTop(boolean alwaysOnTop) Sets whether this dialog should always be above other windows.
void	setDialogLocation(Point location) Set the dialog location.
void	setDialogTitle(String title) Set the title of the Dialog.
void	setJMenuBar(JMenuBar menus) Set a MenuBar to use with this Dialog.
void	setModal(boolean isModal) Set the modality of the dialog.
void	setOKLabel(String okLabel) Set the labels for the OK buttons in the default exit panel.
void	setResizable(boolean isResizable) Set if the Dialog panel is resizable.
void	setYesNoLabels(String yesLabel, String noLabel) Set the labels for the Yes / No buttons in the default exit panel.
int	showDialog() Show the dialog.
int	showDialog(Component parent) Show the dialog.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, 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

dialog

protected JDialog dialog

The internal dialog.

frame

protected JFrame frame

The internal dialog associated frame.

yesLabel

protected String yesLabel

The "Yes" Label. The default value is "Yes".

okLabel

protected String okLabel

The "Ok" Label. The default value is "OK".

noLabel

protected String noLabel

The "No" Label. The default value is "Cancel".

yesAction

protected AbstractAction yesAction

The action associated with the default "Yes" button.

cancelAction

protected AbstractAction cancelAction

The action associated with the default "No" button.

returnValue

protected int returnValue

The return value.

dialogLocation

protected Point dialogLocation

The location of the dialog.

object

protected O object

An additional object used to create the dialog.

Constructor Detail

GenericDialog

public GenericDialog()

Constructor.

GenericDialog

public GenericDialog(boolean isModal)

Constructor.

Parameters:

isModal - true if the dialog is modal

GenericDialog

public GenericDialog(O object,
                     boolean isModal)

Constructor.

Parameters:

object - an additional object used to create the dialog

isModal - true if the dialog is modal

GenericDialog

public GenericDialog(String title,
                     Component parent,
                     boolean isModal)

Constructor, with a title, a dialog owner, and a modality.

Parameters:

title - the title

parent - the dialog owner, may be a heavyweight component (like a JFrame), or a smallweight one, the class will automatically look for the heavyweight root

isModal - true if the dialog is modal

GenericDialog

public GenericDialog(String title,
                     Component parent,
                     O object,
                     boolean isModal)

Constructor, with a title, a dialog owner, and a modality.

Parameters:

title - the title

parent - the dialog owner, may be a heavyweight component (like a JFrame), or a smallweight one, the class will automatically look for the heavyweight root

object - an additional object used to create the dialog

isModal - true if the dialog is modal

GenericDialog

public GenericDialog(String title)

Constructor, with a title.

Parameters:

title - the title

GenericDialog

public GenericDialog(String title,
                     O object)

Constructor, with a title.

Parameters:

title - the title

object - an additional object used to create the dialog

GenericDialog

public GenericDialog(String title,
                     boolean isModal)

Constructor, with a title.

Parameters:

title - the title

isModal - true if the dialog is modal

Method Detail

setDialogTitle

public void setDialogTitle(String title)

Set the title of the Dialog.

Parameters:

title - the Dialog title

setJMenuBar

public void setJMenuBar(JMenuBar menus)

Set a MenuBar to use with this Dialog.

Parameters:

menus - the MenuBar

setModal

public void setModal(boolean isModal)

Set the modality of the dialog.

Parameters:

isModal - true if the dialog is modal

isModal

public boolean isModal()

Return the modality of the dialog.

Returns:

true if the dialog is modal

setAlwaysOnTop

public void setAlwaysOnTop(boolean alwaysOnTop)

Sets whether this dialog should always be above other windows.

Parameters:

alwaysOnTop - true if this dialog should always be above other windows

isAlwaysOnTop

public boolean isAlwaysOnTop()

Return true if this dialog should always be above other windows.

Returns:

true if this dialog should always be above other windows

getJMenuBar

public final JMenuBar getJMenuBar()

Return the MenuBar to use with this Dialog (may be null).

Returns:

the MenuBar

setDialogLocation

public final void setDialogLocation(Point location)

Set the dialog location.

Parameters:

location - the dialog location

getDialogLocation

public final Point getDialogLocation()

Return the dialog location.

Returns:

the dialog location

addDialogListener

public void addDialogListener(GenericDialog.DialogListener listener)

Set a dialog listener which will be fired if the dialog is applied (if clicking on "Yes") or cancelled (if clicking on "Cancel" or closing the window without applying the dialog).

Parameters:

listener - the dialog listener

removeDialogListener

public void removeDialogListener(GenericDialog.DialogListener listener)

Remove a dialog listener.

Parameters:

listener - the dialog listener

getDialogListeners

public List<GenericDialog.DialogListener> getDialogListeners()

Return the Dialog listeners which will be fired if the dialog is applied or cancelled.

Returns:

the Dialog listeners

getDialog

public JDialog getDialog()

Return the dialog.

Returns:

the dialog

getFrame

public JFrame getFrame()

Return the dialog Frame.

Returns:

the dialog Frame

dispose

public void dispose()

Dispose the underlying dialog.

setResizable

public void setResizable(boolean isResizable)

Set if the Dialog panel is resizable.

Parameters:

isResizable - true if the Dialog panel is resizable

setYesNoLabels

public void setYesNoLabels(String yesLabel,
                           String noLabel)

Set the labels for the Yes / No buttons in the default exit panel.

Parameters:

yesLabel - the label for the Yes button

noLabel - the label for the No button

setOKLabel

public void setOKLabel(String okLabel)

Set the labels for the OK buttons in the default exit panel.

Parameters:

okLabel - the label for the OK button

createFrame

protected final JFrame createFrame(Component parent)

Create the dialog as a JFrame, as a child of its parent owner. THis method can be used when extending this class, if the dialog implementer does want to use a JFrame instead of a JDialog.

Example

 public MyDialog(String title, Component parent) {
    this(title);
    this.createFrame(parent);
 }
 

Parameters:

parent - the dialog owner (may be null)

Returns:

the dialog Frame

createDialog

protected JDialog createDialog(Component parent)

Create the dialog, as a child of its parent owner.

Parameters:

parent - the dialog owner (may be null)

Returns:

the dialog

createDialog

protected final JDialog createDialog(Component parent,
                                     boolean modal)

Create the dialog as a JDialog, as a child of its parent owner.

Parameters:

parent - the dialog owner (may be null)

modal - true if the dialog is modal

Returns:

the dialog

applyDialogSizeAndPosition

protected void applyDialogSizeAndPosition()

Apply thz size and position of the dialog.

createOKPanel

protected JPanel createOKPanel()

Create the Yes Panel, which is part of the Yes / No panel.

Returns:

the Yes Panel

createYesNoPanel

protected JPanel createYesNoPanel()

Create the Yes / No bottom Panel. Note that it is possible to define a completely different panel can be defined by overriding this method. It is even possible to define a panel with a completely different content, even without Yes /No buttons.

Returns:

the Yes/No Panel

getYesAction

public AbstractAction getYesAction()

Return the action associated with the default "Yes" button.

Returns:

the action associated with the default "Yes" button

getCancelAction

public AbstractAction getCancelAction()

Return the action associated with the default "No" button.

Returns:

the action associated with the default "No" button

createPanel

protected abstract void createPanel()

The method to implement to create the main panel of the dialog. Note that you should create a Yes / No Panel here. For example, here is a case where the sub-class will create a default panel with a text message, using the default Yes /No Panel:

 Container pane = dialog.getContentPane();
 pane.setLayout(new BoxLayout(pane, BoxLayout.Y_AXIS));

 pane.add(new JLabel("MyText");
 pane.add(Box.createRigidArea(new Dimension(50, 20)));

 JPanel yesnopanel = this.createYesNoPanel();

 pane.add(yesnopanel);
 

showDialog

public int showDialog(Component parent)

Show the dialog.

Parameters:

parent - the parent component

Returns:

the JFileChooser return value.

applyBeforeShowingDialog

public void applyBeforeShowingDialog(Component parent)

Called before the dialog is shown.

Parameters:

parent - the parent component

showDialog

public int showDialog()

Show the dialog.

Returns:

the JFileChooser return value.

getReturnValue

public final int getReturnValue()

Return the last value of the dialog return value.

Returns:

the last value of the dialog return value

apply

protected void apply()

Called when applying the dialog. Do nothing by default.

cancel

protected void cancel()

Called when cancelling the dialog. Do nothing by default.

doYes

protected void doYes()

Called when clicking the default "Yes" button.

doCancel

protected void doCancel()

Called when clicking the default "No" button.