de.uni_paderborn.fujaba.gui
Class AbstractDialog

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjava.awt.Window
              extended byjava.awt.Dialog
                  extended byjavax.swing.JDialog
                      extended byde.uni_paderborn.fujaba.gui.AbstractDialog
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants
Direct Known Subclasses:
EditActivityDialog, EditPathExprDialog, SDMObjectDialog, SelectFromListDialog

public abstract class AbstractDialog
extends javax.swing.JDialog

Abstract dialog for convenience.

Version:
$Revision: 1.11 $
Author:
$Author: schneider $
See Also:
Serialized Form

Nested Class Summary
protected  class AbstractDialog.DialogClose
          Window is closed without ok or cancel buttons, calls cancelPressed ().
 
Nested classes inherited from class javax.swing.JDialog
javax.swing.JDialog.AccessibleJDialog
 
Nested classes inherited from class java.awt.Dialog
java.awt.Dialog.AccessibleAWTDialog
 
Nested classes inherited from class java.awt.Window
java.awt.Window.AccessibleAWTWindow
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
static int CANCEL
          No comment provided by developer, please add a comment to improve documentation.
static int NONE
          No comment provided by developer, please add a comment to improve documentation.
static int OK
          No comment provided by developer, please add a comment to improve documentation.
 
Fields inherited from class javax.swing.JDialog
accessibleContext, rootPane, rootPaneCheckingEnabled
 
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
AbstractDialog(javax.swing.JFrame frame, boolean modal)
          Deriving classes have to call "createUserInterface ();" and "initialize ();" during construction.
 
Method Summary
 void cancelPressed()
          Cancel is pressed, so don't change anything and leave dialog.
protected  void centerDialog()
          Center the dialog in the middle of the screen.
protected  boolean checkConstraints()
          Put all constraint checks that have to be verified before leaving the dialog into this method.
protected  javax.swing.JPanel createButtonPanel()
          Creates a panel with two buttons on the right side.
protected abstract  javax.swing.JPanel createMainPanel()
          Contains the complete user interface of the dialog, except "Ok" and "Cancel" buttons.
protected  void createUserInterface()
          Adds the main panel by calling createMainPanel () and the button panel by calling createButtonPanel () to an panel and returns it.
protected  javax.swing.JButton getCancelButton()
           
protected  javax.swing.JButton getOkButton()
           
 int getUserChoice()
          Get the userChoice attribute of the AbstractDialog object
protected  void initialize()
          Does all the stuff that has to be done during construction.
 void okPressed()
          Ok is pressed.
protected abstract  void parse()
          Get all information from the user interface and put them back to the parameters that can be modified by this dialog.
protected  void setCancelButton(javax.swing.JButton button)
           
protected  void setOkButton(javax.swing.JButton button)
           
protected  void setUserChoice(int userChoice)
          Sets the userChoice attribute of the AbstractDialog object
protected abstract  void unparse()
          Read the parameters which can be modified and put all information into the dialogs user interface.
 
Methods inherited from class javax.swing.JDialog
addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Dialog
addNotify, dispose, getTitle, hide, isModal, isResizable, isUndecorated, setModal, setResizable, setTitle, setUndecorated, show
 
Methods inherited from class java.awt.Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, finalize, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, toBack, 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, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, removeNotify, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, 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, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, 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, isOpaque, 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, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NONE

public static final int NONE
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

OK

public static final int OK
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values

CANCEL

public static final int CANCEL
No comment provided by developer, please add a comment to improve documentation.

See Also:
Constant Field Values
Constructor Detail

AbstractDialog

public AbstractDialog(javax.swing.JFrame frame,
                      boolean modal)
Deriving classes have to call "createUserInterface ();" and "initialize ();" during construction.

Parameters:
frame - No description provided
modal - No description provided
See Also:
createUserInterface(), initialize()
Method Detail

setUserChoice

protected void setUserChoice(int userChoice)
Sets the userChoice attribute of the AbstractDialog object

Parameters:
userChoice - The new userChoice value

getUserChoice

public int getUserChoice()
Get the userChoice attribute of the AbstractDialog object

Returns:
The userChoice value

initialize

protected void initialize()
Does all the stuff that has to be done during construction. Should be called by the constructor of the derived class. Calls unparse ().

See Also:
unparse()

setOkButton

protected void setOkButton(javax.swing.JButton button)
Parameters:
button - The new okButton value
See Also:
#okButton

getOkButton

protected javax.swing.JButton getOkButton()
Returns:
The okButton value
See Also:
#okButton

setCancelButton

protected void setCancelButton(javax.swing.JButton button)
Parameters:
button - The new cancelButton value
See Also:
#cancelButton

getCancelButton

protected javax.swing.JButton getCancelButton()
Returns:
The cancelButton value
See Also:
#cancelButton

unparse

protected abstract void unparse()
Read the parameters which can be modified and put all information into the dialogs user interface. Called by initialize ().

See Also:
initialize()

parse

protected abstract void parse()
Get all information from the user interface and put them back to the parameters that can be modified by this dialog. Called by okPressed ().

See Also:
okPressed()

checkConstraints

protected boolean checkConstraints()
Put all constraint checks that have to be verified before leaving the dialog into this method.

Returns:
true
See Also:
okPressed()

okPressed

public void okPressed()
Ok is pressed. Calls checkConstraints (), if constraints are positively verified, call parse () and leave dialog.

See Also:
checkConstraints(), parse()

cancelPressed

public void cancelPressed()
Cancel is pressed, so don't change anything and leave dialog.


createUserInterface

protected void createUserInterface()
Adds the main panel by calling createMainPanel () and the button panel by calling createButtonPanel () to an panel and returns it. Should be alled by the constructor of deriving classes.

See Also:
createMainPanel(), createButtonPanel()

createMainPanel

protected abstract javax.swing.JPanel createMainPanel()
Contains the complete user interface of the dialog, except "Ok" and "Cancel" buttons. Called by createUserInterface ().

Returns:
JPanel that is positioned in the middle of the dialog.
See Also:
createUserInterface()

createButtonPanel

protected javax.swing.JPanel createButtonPanel()
Creates a panel with two buttons on the right side. The default are an "Ok" and a "Cancel" button. Called by createUserInterface ().

Returns:
No description provided
See Also:
createUserInterface()

centerDialog

protected void centerDialog()
Center the dialog in the middle of the screen.