meka.gui.core

Class ApprovalDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

meka.gui.core.MekaDialog

meka.gui.core.ApprovalDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

MarkdownDialog

public class ApprovalDialog
extends MekaDialog

Base class for approval dialogs, i.e., dialogs that require the user to click on Yes, No or Cancel. Closing the dialog is considered a Cancel operation.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

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	APPROVE_OPTION the approve option.
static int	CANCEL_OPTION the cancel option.
static int	DISCARD_OPTION the discard option.
protected JButton	m_ButtonApprove the approve button.
protected JButton	m_ButtonCancel the cancel button.
protected JButton	m_ButtonDiscard the discard button.
protected int	m_Option the option selected by the user (CANCEL_OPTION, APPROVE_OPTION).
protected JPanel	m_PanelButtons the buttons panel.
protected JPanel	m_PanelContent the content panel.

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
ApprovalDialog() Creates a modeless dialog without a title and without a specified Frame owner.
ApprovalDialog(Dialog owner) Creates a modeless dialog without a title with the specified Dialog as its owner.
ApprovalDialog(Dialog owner, Dialog.ModalityType modality) Creates a dialog with the specified owner Dialog and modality.
ApprovalDialog(Dialog owner, String title) Creates a modeless dialog with the specified title and with the specified owner dialog.
ApprovalDialog(Dialog owner, String title, Dialog.ModalityType modality) Creates a dialog with the specified title, modality and the specified owner Dialog.
ApprovalDialog(Frame owner) Creates a modeless dialog without a title with the specified Frame as its owner.
ApprovalDialog(Frame owner, boolean modal) Creates a dialog with the specified owner Frame, modality and an empty title.
ApprovalDialog(Frame owner, String title) Creates a modeless dialog with the specified title and with the specified owner frame.
ApprovalDialog(Frame owner, String title, boolean modal) Creates a dialog with the specified owner Frame, modality and title.

Method Summary

Modifier and Type	Method and Description
protected void	beforeShow() Hook method just before the dialog is made visible.
JButton	getApproveButton() Returns the approve button.
String	getApproveCaption() Returns the caption/text of the approve button.
int	getApproveMnemonic() Returns the mnemonic of the approve button.
JButton	getCancelButton() Returns the cancel button.
String	getCancelCaption() Returns the caption/text of the Cancel button.
int	getCancelMnemonic() Returns the mnemonic of the Cancel button.
static ApprovalDialog	getConfirmationDialog(Dialog owner) Returns a basic (modal) confirmation dialog (yes/no/cancel).
static ApprovalDialog	getConfirmationDialog(Dialog owner, Dialog.ModalityType modal) Returns a basic confirmation dialog (yes/no/cancel).
static ApprovalDialog	getConfirmationDialog(Frame owner) Returns a basic (modal) confirmation dialog (yes/no/cancel).
static ApprovalDialog	getConfirmationDialog(Frame owner, boolean modal) Returns a basic confirmation dialog (yes/no/cancel).
JPanel	getContentPanel() Returns the panel to add the content to.
JButton	getDiscardButton() Returns the discard button.
String	getDiscardCaption() Returns the caption/text of the discard button.
int	getDiscardMnemonic() Returns the mnemonic of the discard button.
static ApprovalDialog	getInformationDialog(Dialog owner) Returns a basic (modal) info dialog (ok).
static ApprovalDialog	getInformationDialog(Dialog owner, Dialog.ModalityType modal) Returns a basic info dialog (ok).
static ApprovalDialog	getInformationDialog(Frame owner) Returns a basic (modal) info dialog (ok).
static ApprovalDialog	getInformationDialog(Frame owner, boolean modal) Returns a basic info dialog (ok).
int	getOption() Returns the selected option.
protected void	initGUI() Initializes the widgets.
boolean	isApproveVisible() Returns the visibility of the approve button.
boolean	isCancelVisible() Returns the visibility of the cancel button.
boolean	isDiscardVisible() Returns the visibility of the discard button.
void	setApproveCaption(String value) Sets the caption/text of the approve button.
void	setApproveMnemonic(int value) Sets the mnemonic of the approve button.
void	setApproveVisible(boolean value) Sets the visbility of the approve button.
void	setCancelCaption(String value) Sets the caption/text of the Cancel button.
void	setCancelMnemonic(int value) Sets the mnemonic of the Cancel button.
void	setCancelVisible(boolean value) Sets the visbility of the cancel button.
void	setDiscardCaption(String value) Sets the caption/text of the discard button.
void	setDiscardMnemonic(int value) Sets the mnemonic of the discard button.
void	setDiscardVisible(boolean value) Sets the visbility of the discard button.

Methods inherited from class meka.gui.core.MekaDialog

afterHide, afterShow, beforeHide, finishInit, initialize, setVisible

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

Field Detail

APPROVE_OPTION

public static final int APPROVE_OPTION

the approve option.

See Also:

Constant Field Values

DISCARD_OPTION

public static final int DISCARD_OPTION

the discard option.

See Also:

Constant Field Values

CANCEL_OPTION

public static final int CANCEL_OPTION

the cancel option.

See Also:

Constant Field Values

m_PanelContent

protected JPanel m_PanelContent

the content panel.

m_PanelButtons

protected JPanel m_PanelButtons

the buttons panel.

m_ButtonApprove

protected JButton m_ButtonApprove

the approve button.

m_ButtonDiscard

protected JButton m_ButtonDiscard

the discard button.

m_ButtonCancel

protected JButton m_ButtonCancel

the cancel button.

m_Option

protected int m_Option

the option selected by the user (CANCEL_OPTION, APPROVE_OPTION).

Constructor Detail

ApprovalDialog

public ApprovalDialog()

Creates a modeless dialog without a title and without a specified Frame owner.

ApprovalDialog

public ApprovalDialog(Dialog owner)

Creates a modeless dialog without a title with the specified Dialog as its owner.

Parameters:

owner - the owning dialog

ApprovalDialog

public ApprovalDialog(Dialog owner,
                      Dialog.ModalityType modality)

Creates a dialog with the specified owner Dialog and modality.

Parameters:

owner - the owning dialog

modality - the type of modality

ApprovalDialog

public ApprovalDialog(Dialog owner,
                      String title)

Creates a modeless dialog with the specified title and with the specified owner dialog.

Parameters:

owner - the owning dialog

title - the title of the dialog

ApprovalDialog

public ApprovalDialog(Dialog owner,
                      String title,
                      Dialog.ModalityType modality)

Creates a dialog with the specified title, modality and the specified owner Dialog.

Parameters:

owner - the owning dialog

title - the title of the dialog

modality - the type of modality

ApprovalDialog

public ApprovalDialog(Frame owner)

Creates a modeless dialog without a title with the specified Frame as its owner.

Parameters:

owner - the owning frame

ApprovalDialog

public ApprovalDialog(Frame owner,
                      boolean modal)

Creates a dialog with the specified owner Frame, modality and an empty title.

Parameters:

owner - the owning frame

modal - whether the dialog is modal or not

ApprovalDialog

public ApprovalDialog(Frame owner,
                      String title)

Creates a modeless dialog with the specified title and with the specified owner frame.

Parameters:

owner - the owning frame

title - the title of the dialog

ApprovalDialog

public ApprovalDialog(Frame owner,
                      String title,
                      boolean modal)

Creates a dialog with the specified owner Frame, modality and title.

Parameters:

owner - the owning frame

title - the title of the dialog

modal - whether the dialog is modal or not

Method Detail

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class MekaDialog

beforeShow

protected void beforeShow()

Hook method just before the dialog is made visible.

Overrides:

beforeShow in class MekaDialog

getOption

public int getOption()

Returns the selected option.

Returns:

the option

getApproveButton

public JButton getApproveButton()

Returns the approve button.

Returns:

the button

setApproveVisible

public void setApproveVisible(boolean value)

Sets the visbility of the approve button.

Parameters:

value - true if to display button

isApproveVisible

public boolean isApproveVisible()

Returns the visibility of the approve button.

Returns:

true if visible

setApproveCaption

public void setApproveCaption(String value)

Sets the caption/text of the approve button.

Parameters:

value - the new text

getApproveCaption

public String getApproveCaption()

Returns the caption/text of the approve button.

Returns:

the current text

setApproveMnemonic

public void setApproveMnemonic(int value)

Sets the mnemonic of the approve button.

Parameters:

value - the new mnemonic, e.g., KeyEvent.VK_O

getApproveMnemonic

public int getApproveMnemonic()

Returns the mnemonic of the approve button.

Returns:

the current mnemonic, e.g., KeyEvent.VK_O

getDiscardButton

public JButton getDiscardButton()

Returns the discard button.

Returns:

the button

setDiscardVisible

public void setDiscardVisible(boolean value)

Sets the visbility of the discard button.

Parameters:

value - true if to display button

isDiscardVisible

public boolean isDiscardVisible()

Returns the visibility of the discard button.

Returns:

true if visible

setDiscardCaption

public void setDiscardCaption(String value)

Sets the caption/text of the discard button.

Parameters:

value - the new text

getDiscardCaption

public String getDiscardCaption()

Returns the caption/text of the discard button.

Returns:

the current text

setDiscardMnemonic

public void setDiscardMnemonic(int value)

Sets the mnemonic of the discard button.

Parameters:

value - the new mnemonic, e.g., KeyEvent.VK_D

getDiscardMnemonic

public int getDiscardMnemonic()

Returns the mnemonic of the discard button.

Returns:

the current mnemonic, e.g., KeyEvent.VK_D

getCancelButton

public JButton getCancelButton()

Returns the cancel button.

Returns:

the button

setCancelVisible

public void setCancelVisible(boolean value)

Sets the visbility of the cancel button.

Parameters:

value - true if to display button

isCancelVisible

public boolean isCancelVisible()

Returns the visibility of the cancel button.

Returns:

true if visible

setCancelCaption

public void setCancelCaption(String value)

Sets the caption/text of the Cancel button.

Parameters:

value - the new text

getCancelCaption

public String getCancelCaption()

Returns the caption/text of the Cancel button.

Returns:

the current text

setCancelMnemonic

public void setCancelMnemonic(int value)

Sets the mnemonic of the Cancel button.

Parameters:

value - the new mnemonic, e.g., KeyEvent.VK_C

getCancelMnemonic

public int getCancelMnemonic()

Returns the mnemonic of the Cancel button.

Returns:

the current mnemonic, e.g., KeyEvent.VK_C

getContentPanel

public JPanel getContentPanel()

Returns the panel to add the content to.

Returns:

the content panel

getConfirmationDialog

public static ApprovalDialog getConfirmationDialog(Dialog owner)

Returns a basic (modal) confirmation dialog (yes/no/cancel).

Parameters:

owner - the owner of the dialog

getConfirmationDialog

public static ApprovalDialog getConfirmationDialog(Dialog owner,
                                                   Dialog.ModalityType modal)

Returns a basic confirmation dialog (yes/no/cancel).

Parameters:

owner - the owner of the dialog

modal - the modality of the dialog

getConfirmationDialog

public static ApprovalDialog getConfirmationDialog(Frame owner)

Returns a basic (modal) confirmation dialog (yes/no/cancel).

Parameters:

owner - the owner of the dialog

getConfirmationDialog

public static ApprovalDialog getConfirmationDialog(Frame owner,
                                                   boolean modal)

Returns a basic confirmation dialog (yes/no/cancel).

Parameters:

owner - the owner of the dialog

modal - whether to create a modal dialog

getInformationDialog

public static ApprovalDialog getInformationDialog(Dialog owner)

Returns a basic (modal) info dialog (ok).

Parameters:

owner - the owner of the dialog

getInformationDialog

public static ApprovalDialog getInformationDialog(Dialog owner,
                                                  Dialog.ModalityType modal)

Returns a basic info dialog (ok).

Parameters:

owner - the owner of the dialog

modal - the modality of the dialog

getInformationDialog

public static ApprovalDialog getInformationDialog(Frame owner)

Returns a basic (modal) info dialog (ok).

Parameters:

owner - the owner of the dialog

getInformationDialog

public static ApprovalDialog getInformationDialog(Frame owner,
                                                  boolean modal)

Returns a basic info dialog (ok).

Parameters:

owner - the owner of the dialog

modal - whether to create a modal dialog