org.basex.gui.layout
Class BaseXDialog

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 org.basex.gui.layout.BaseXDialog
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:
DialogAbout, DialogColors, DialogEdit, DialogExport, DialogFonts, DialogInput, DialogInsert, DialogLine, DialogManage, DialogMapLayout, DialogMessage, DialogNew, DialogPackages, DialogPass, DialogPrefs, DialogProgress, DialogProps, DialogServer, DialogTreeOptions

public abstract class BaseXDialog
extends javax.swing.JDialog

This superclass in inherited by all dialog windows.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen
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
 GUI gui
          Reference to main window.
 java.awt.event.KeyAdapter keys
          Key listener, triggering an action with each click.
 java.lang.StringBuilder mnem
          Used mnemonics.
 boolean ok
          Remembers if the window was correctly closed.
 BaseXBack panel
          Reference to the root 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
BaseXDialog(BaseXDialog d, java.lang.String title)
          Constructor, called from a dialog window.
BaseXDialog(GUI main, java.lang.String title)
          Constructor, called from the main window.
BaseXDialog(GUI main, java.lang.String title, boolean modal)
          Constructor, called from the main window.
 
Method Summary
 void action(java.lang.Object comp)
          Reacts on user input; can be overwritten.
static void browse(GUI gui, java.lang.String url)
          Browses the specified url.
 void cancel()
          Cancels the dialog; can be overwritten.
 void close()
          Closes the dialog and stores the location of the dialog window; can be overwritten.
static boolean confirm(GUI gui, java.lang.String text)
          Static yes/no dialog.
 void dispose()
           
static void enableOK(javax.swing.JComponent panel, java.lang.String label, boolean enabled)
          Enables/disables a button in the specified panel.
static void error(GUI gui, java.lang.String text)
          Static error dialog.
 void finish(int[] l)
          Finalizes the dialog layout and sets it visible.
static void info(GUI gui, java.lang.String text)
          Static information dialog.
 BaseXBack newButtons(java.lang.Object... buttons)
          Creates a new button list.
 boolean ok()
          States if the dialog window was confirmed or canceled.
 BaseXBack okCancel()
          Creates a OK and CANCEL button.
 void set(java.awt.Component comp, java.lang.String pos)
          Sets a component at the specified BorderLayout position.
 void setLocation(int x, int y)
           
static java.lang.Boolean yesNoCancel(GUI gui, java.lang.String text)
          Static yes/no dialog.
 
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, 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, 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

mnem

public final java.lang.StringBuilder mnem
Used mnemonics.


gui

public GUI gui
Reference to main window.


ok

public boolean ok
Remembers if the window was correctly closed.


panel

public BaseXBack panel
Reference to the root panel.


keys

public final java.awt.event.KeyAdapter keys
Key listener, triggering an action with each click.

Constructor Detail

BaseXDialog

public BaseXDialog(BaseXDialog d,
                   java.lang.String title)
Constructor, called from a dialog window.

Parameters:
d - calling dialog
title - dialog title

BaseXDialog

public BaseXDialog(GUI main,
                   java.lang.String title)
Constructor, called from the main window.

Parameters:
main - reference to main window
title - dialog title

BaseXDialog

public BaseXDialog(GUI main,
                   java.lang.String title,
                   boolean modal)
Constructor, called from the main window.

Parameters:
main - reference to the main window
title - dialog title
modal - modal flag
Method Detail

set

public final void set(java.awt.Component comp,
                      java.lang.String pos)
Sets a component at the specified BorderLayout position.

Parameters:
comp - component to be added
pos - layout position

finish

public final void finish(int[] l)
Finalizes the dialog layout and sets it visible.

Parameters:
l - optional dialog location, relative to main window

setLocation

public void setLocation(int x,
                        int y)
Overrides:
setLocation in class java.awt.Component

action

public void action(java.lang.Object comp)
Reacts on user input; can be overwritten.

Parameters:
comp - the action component

cancel

public void cancel()
Cancels the dialog; can be overwritten.


close

public void close()
Closes the dialog and stores the location of the dialog window; can be overwritten.


dispose

public void dispose()
Overrides:
dispose in class java.awt.Window

ok

public final boolean ok()
States if the dialog window was confirmed or canceled.

Returns:
true when dialog was confirmed

okCancel

public BaseXBack okCancel()
Creates a OK and CANCEL button.

Returns:
button list

newButtons

public BaseXBack newButtons(java.lang.Object... buttons)
Creates a new button list.

Parameters:
buttons - button names or objects
Returns:
button list

enableOK

public static void enableOK(javax.swing.JComponent panel,
                            java.lang.String label,
                            boolean enabled)
Enables/disables a button in the specified panel.

Parameters:
panel - button panel
label - button label
enabled - enabled/disabled

yesNoCancel

public static java.lang.Boolean yesNoCancel(GUI gui,
                                            java.lang.String text)
Static yes/no dialog. Returns a null reference if the dialog was canceled.

Parameters:
gui - parent reference
text - text
Returns:
true if dialog was confirmed

confirm

public static boolean confirm(GUI gui,
                              java.lang.String text)
Static yes/no dialog.

Parameters:
gui - parent reference
text - text
Returns:
true if dialog was confirmed

info

public static void info(GUI gui,
                        java.lang.String text)
Static information dialog.

Parameters:
gui - parent reference
text - text

error

public static void error(GUI gui,
                         java.lang.String text)
Static error dialog.

Parameters:
gui - parent reference
text - text

browse

public static void browse(GUI gui,
                          java.lang.String url)
Browses the specified url.

Parameters:
gui - parent reference
url - url to be browsed