skrueger.swing
Class TranslationAskJDialog

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 skrueger.swing.AtlasDialog
                          extended by skrueger.swing.CancellableDialogAdapter
                              extended by skrueger.swing.TranslationAskJDialog
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, Cancellable, CancellableDialog

public class TranslationAskJDialog
extends CancellableDialogAdapter

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
 
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
static String PROPERTY_APPLY_AND_CLOSE
           
static String PROPERTY_CANCEL_AND_CLOSE
           
 
Fields inherited from class skrueger.swing.CancellableDialogAdapter
cancelled, RESOURCE
 
Fields inherited from class skrueger.swing.AtlasDialog
isDisposed
 
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
TranslationAskJDialog(Component owner)
          The TranslationAskJDialog fills its content pane with an arbitrary number of components.
TranslationAskJDialog(Component owner, JComponent... translationEditJPanels)
          The TranslationAskJDialog fills its content pane with an arbitrary number of components.
 
Method Summary
 void cancel()
          Called when the dilaog is closed using the cancel button.
protected  JRootPane createRootPane()
          Since the registerKeyboardAction() method is part of the JComponent class definition, you must define the Escape keystroke and register the keyboard action with a JComponent, not with a JDialog.
 boolean isCancelled()
          After the modal dialog has been closed, this allows to find out, whether the Component has been canceled.
 boolean okClose()
          This method is only called when the dialog is closed and not canceled.
 void setComponents(JComponent... translationEditJPanels)
          The TranslationAskJDialog fills its content pane with an arbitrary number of components.
 void setOptionalButtons(JButton... optionalButtons)
           
 
Methods inherited from class skrueger.swing.CancellableDialogAdapter
cancelClose, close, forceClose, getCancelButton, getOkButton
 
Methods inherited from class skrueger.swing.AtlasDialog
dispose
 
Methods inherited from class javax.swing.JDialog
addImpl, 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, 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, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PROPERTY_CANCEL_AND_CLOSE

public static final String PROPERTY_CANCEL_AND_CLOSE
See Also:
Constant Field Values

PROPERTY_APPLY_AND_CLOSE

public static final String PROPERTY_APPLY_AND_CLOSE
See Also:
Constant Field Values
Constructor Detail

TranslationAskJDialog

public TranslationAskJDialog(Component owner,
                             JComponent... translationEditJPanels)
The TranslationAskJDialog fills its content pane with an arbitrary number of components. If these Components are TranslationEditJPanels, the JDialog manages to backup the values and restore them if the dialog is canceled. Other JComponents are just displayed.
This class handles the cancel button itself. You may still want to listen to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has to be set visible afterwards.

Parameters:
owner - A component of the GUI that this dialog is related to. If no Window is passed, SwingUtil.getParentWindow(owner) is called.

TranslationAskJDialog

public TranslationAskJDialog(Component owner)
The TranslationAskJDialog fills its content pane with an arbitrary number of components. If these Components are TranslationEditJPanels, the JDialog manages to backup the values and restore them if the dialog is canceled. Other JComponents are just displayed.
This class handles the cancel button itself. You may still want to listen to PROPERTY_APPLY_AND_CLOSE events. This dialog is modal. The dialog has to be set visible afterwards.
Using this constructor, you have to call setComponents afterwards.

Method Detail

createRootPane

protected JRootPane createRootPane()
Since the registerKeyboardAction() method is part of the JComponent class definition, you must define the Escape keystroke and register the keyboard action with a JComponent, not with a JDialog. The JRootPane for the JDialog serves as an excellent choice to associate the registration, as this will always be visible. If you override the protected createRootPane() method of JDialog, you can return your custom JRootPane with the keystroke enabled:

Overrides:
createRootPane in class AtlasDialog

setComponents

public void setComponents(JComponent... translationEditJPanels)
The TranslationAskJDialog fills its content pane with an arbitrary number of components. If these Components are TranslationEditJPanels, the JDialog manages to backup the values and restore them if the dialog is canceled. Other JComponents are just displayed.

Parameters:
translationEditJPanels - Arbitrary list of JComponents and TranslationEditJPanels.

setOptionalButtons

public void setOptionalButtons(JButton... optionalButtons)

cancel

public void cancel()
Called when the dilaog is closed using the cancel button. When overwriting this method, call super.cancel() after restoring your properties.

Specified by:
cancel in interface Cancellable
Specified by:
cancel in class CancellableDialogAdapter

okClose

public boolean okClose()
This method is only called when the dialog is closed and not canceled. Can be overwritten to do anything when the dialog has been accepted.

Overrides:
okClose in class CancellableDialogAdapter

isCancelled

public boolean isCancelled()
After the modal dialog has been closed, this allows to find out, whether the Component has been canceled.

Specified by:
isCancelled in interface CancellableDialog
Overrides:
isCancelled in class CancellableDialogAdapter
Returns:
true if the JDialog has been canceled.