com.l2fprod.common.swing

Class BaseDialog

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.l2fprod.common.swing.BaseDialog

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

PropertySheetDialog

public class BaseDialog
extends JDialog

An extension of the JDialog with built-in support for OK/CANCEL/CLOSE buttons. BaseDialog adds:

• support for ESCAPE key to dispose the window
• ok, cancel methods
• simple method to check if ok or cancel was called (ask())
• button pane
• banner 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	CLOSE_DIALOG Used to set the mode of the dialog to OK/CANCEL.
static int	OK_CANCEL_DIALOG Used to set the mode of the dialog to OK/CANCEL.

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
BaseDialog()
BaseDialog(Dialog owner)
BaseDialog(Dialog owner, boolean modal)
BaseDialog(Dialog owner, String title)
BaseDialog(Dialog owner, String title, boolean modal)
BaseDialog(Dialog owner, String title, boolean modal, GraphicsConfiguration gc)
BaseDialog(Frame owner)
BaseDialog(Frame owner, boolean modal)
BaseDialog(Frame owner, String title)
BaseDialog(Frame owner, String title, boolean modal)
BaseDialog(Frame owner, String title, boolean modal, GraphicsConfiguration gc)

Method Summary

Modifier and Type	Method and Description
boolean	ask()
void	cancel() Called when the user clicks on the CANCEL or CLOSE button
void	centerOnScreen() Centers this dialog on screen.
BannerPanel	getBanner() Gets the BannerPanel displayed in this dialog.
Container	getButtonPane()
Container	getContentPane()
int	getDialogMode() Gets this dialog mode
static BaseDialog	newBaseDialog(Component parent)
void	ok() Called when the user clicks on the OK button.
protected String	paramString()
void	setDialogMode(int mode) Sets the mode of this dialog.

Methods inherited from class javax.swing.JDialog

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

Field Detail

OK_CANCEL_DIALOG

public static final int OK_CANCEL_DIALOG

Used to set the mode of the dialog to OK/CANCEL. When in this mode, OK and Cancel buttons are automatically added to the dialog.

See Also:

Constant Field Values

CLOSE_DIALOG

public static final int CLOSE_DIALOG

Used to set the mode of the dialog to OK/CANCEL. When in this mode, a Close button is automatically added to the dialog.

See Also:

Constant Field Values

Constructor Detail

BaseDialog

public BaseDialog()
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Dialog owner)
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Dialog owner,
                  boolean modal)
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Frame owner)
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Frame owner,
                  boolean modal)
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Dialog owner,
                  String title)
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Dialog owner,
                  String title,
                  boolean modal)
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Frame owner,
                  String title)
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Frame owner,
                  String title,
                  boolean modal)
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Dialog owner,
                  String title,
                  boolean modal,
                  GraphicsConfiguration gc)
           throws HeadlessException

Throws:

HeadlessException

BaseDialog

public BaseDialog(Frame owner,
                  String title,
                  boolean modal,
                  GraphicsConfiguration gc)

Method Detail

newBaseDialog

public static BaseDialog newBaseDialog(Component parent)

getBanner

public final BannerPanel getBanner()

Gets the BannerPanel displayed in this dialog. The BannerPanel can be made invisible by calling getBanner().setVisible(false); if it is not needed.

Returns:

See Also:

BannerPanel

getContentPane

public final Container getContentPane()

Specified by:

getContentPane in interface RootPaneContainer

Overrides:

getContentPane in class JDialog

getButtonPane

public final Container getButtonPane()

ask

public boolean ask()

Returns:

true if OK was clicked, false if CANCEL or CLOSE was clicked

ok

public void ok()

Called when the user clicks on the OK button.

cancel

public void cancel()

Called when the user clicks on the CANCEL or CLOSE button

setDialogMode

public void setDialogMode(int mode)

Sets the mode of this dialog. Default mode is OK_CANCEL_DIALOG

Parameters:

mode - OK_CANCEL_DIALOGor CLOSE_DIALOG

getDialogMode

public int getDialogMode()

Gets this dialog mode

Returns:

this dialog mode

centerOnScreen

public void centerOnScreen()

Centers this dialog on screen.

paramString

protected String paramString()

Overrides:

paramString in class JDialog