com.l2fprod.common.swing
Class BaseDialog

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by java.awt.Window
              extended by java.awt.Dialog
                  extended by javax.swing.JDialog
                      extended by com.l2fprod.common.swing.BaseDialog
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants
Direct Known Subclasses:
PropertySheetDialog

public class BaseDialog
extends javax.swing.JDialog

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

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 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
BaseDialog()
           
BaseDialog(java.awt.Dialog owner)
           
BaseDialog(java.awt.Dialog owner, boolean modal)
           
BaseDialog(java.awt.Dialog owner, java.lang.String title)
           
BaseDialog(java.awt.Dialog owner, java.lang.String title, boolean modal)
           
BaseDialog(java.awt.Dialog owner, java.lang.String title, boolean modal, java.awt.GraphicsConfiguration gc)
           
BaseDialog(java.awt.Frame owner)
           
BaseDialog(java.awt.Frame owner, boolean modal)
           
BaseDialog(java.awt.Frame owner, java.lang.String title)
           
BaseDialog(java.awt.Frame owner, java.lang.String title, boolean modal)
           
BaseDialog(java.awt.Frame owner, java.lang.String title, boolean modal, java.awt.GraphicsConfiguration gc)
           
 
Method Summary
 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.
 java.awt.Container getButtonPane()
           
 java.awt.Container getContentPane()
           
 int getDialogMode()
          Gets this dialog mode
static BaseDialog newBaseDialog(java.awt.Component parent)
           
 void ok()
          Called when the user clicks on the OK button.
protected  java.lang.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, 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, 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, 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 java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Dialog owner)
           throws java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Dialog owner,
                  boolean modal)
           throws java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Frame owner)
           throws java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Frame owner,
                  boolean modal)
           throws java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Dialog owner,
                  java.lang.String title)
           throws java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Dialog owner,
                  java.lang.String title,
                  boolean modal)
           throws java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Frame owner,
                  java.lang.String title)
           throws java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Frame owner,
                  java.lang.String title,
                  boolean modal)
           throws java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Dialog owner,
                  java.lang.String title,
                  boolean modal,
                  java.awt.GraphicsConfiguration gc)
           throws java.awt.HeadlessException
Throws:
java.awt.HeadlessException

BaseDialog

public BaseDialog(java.awt.Frame owner,
                  java.lang.String title,
                  boolean modal,
                  java.awt.GraphicsConfiguration gc)
Method Detail

newBaseDialog

public static BaseDialog newBaseDialog(java.awt.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.

See Also:
BannerPanel

getContentPane

public final java.awt.Container getContentPane()
Specified by:
getContentPane in interface javax.swing.RootPaneContainer
Overrides:
getContentPane in class javax.swing.JDialog

getButtonPane

public final java.awt.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 java.lang.String paramString()
Overrides:
paramString in class javax.swing.JDialog