ides.api.utilities
Class EscapeDialog

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Dialog
                  javax.swing.JDialog
                      ides.api.utilities.EscapeDialog

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class EscapeDialog
extends javax.swing.JDialog

A class which extends JDialog with the capability to handle the event of the user pressing the Escape key. Instead of subclassing JDialog, subclass EscapeDialog and override onEscapeEvent().

Author:

Lenko Grigorov

See Also:

onEscapeEvent(), JDialog, 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

protected javax.swing.Action

escapeListener The listener for the user pressing the Escape key.

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

EscapeDialog()
Creates a non-modal dialog without a title and without a specified Frame owner.

EscapeDialog(java.awt.Dialog owner)
Creates a non-modal dialog without a title with the specified Dialog as its owner.

EscapeDialog(java.awt.Dialog owner, boolean modal)
Creates a modal or non-modal dialog without a title and with the specified owner Dialog.

EscapeDialog(java.awt.Dialog owner, java.lang.String title)
Creates a non-modal dialog with the specified title and with the specified owner Dialog.

EscapeDialog(java.awt.Dialog owner, java.lang.String title, boolean modal)
Creates a modal or non-modal dialog with the specified title and the specified owner Dialog.

EscapeDialog(java.awt.Dialog owner, java.lang.String title, boolean modal, java.awt.GraphicsConfiguration gc)
Creates a modal or non-modal dialog with the specified title, owner Dialog, and GraphicsConfiguration.

EscapeDialog(java.awt.Frame owner)
Creates a non-modal dialog without a title with the specified Frame as its owner.

EscapeDialog(java.awt.Frame owner, boolean modal)
Creates a modal or non-modal dialog without a title and with the specified owner Frame.

EscapeDialog(java.awt.Frame owner, java.lang.String title)
Creates a non-modal dialog with the specified title and with the specified owner Frame.

EscapeDialog(java.awt.Frame owner, java.lang.String title, boolean modal)
Creates a modal or non-modal dialog with the specified title and the specified owner Frame.

EscapeDialog(java.awt.Frame owner, java.lang.String title, boolean modal, java.awt.GraphicsConfiguration gc)
Creates a modal or non-modal dialog with the specified title, owner Frame, and GraphicsConfiguration.

Method Summary

protected void	bindEscapeListener() Called by the constructor to bind escapeListener with the JDialog.rootPane so that the Escape key can be intercepted.
protected void	onEscapeEvent() Called when the user presses the Escape key.

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, 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, 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

escapeListener

protected javax.swing.Action escapeListener

The listener for the user pressing the Escape key. Calls onEscapeEvent().

See Also:

onEscapeEvent(), bindEscapeListener()

Constructor Detail

EscapeDialog

public EscapeDialog()
             throws java.awt.HeadlessException

Creates a non-modal dialog without a title and without a specified Frame owner. A shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

public EscapeDialog(java.awt.Frame owner)
             throws java.awt.HeadlessException

Creates a non-modal dialog without a title with the specified Frame as its owner. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the Frame from which the dialog is displayed

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

public EscapeDialog(java.awt.Frame owner,
                    boolean modal)
             throws java.awt.HeadlessException

Creates a modal or non-modal dialog without a title and with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the Frame from which the dialog is displayed

modal - true for a modal dialog, false for one that allows others windows to be active at the same time

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

public EscapeDialog(java.awt.Frame owner,
                    java.lang.String title)
             throws java.awt.HeadlessException

Creates a non-modal dialog with the specified title and with the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of the dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the Frame from which the dialog is displayed

title - the string to display in the dialog's title bar

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

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

Creates a modal or non-modal dialog with the specified title and the specified owner Frame. If owner is null, a shared, hidden frame will be set as the owner of this dialog. All constructors defer to this one.

NOTE: Any popup components (JComboBox, JPopupMenu, JMenuBar) created within a modal dialog will be forced to be lightweight.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the Frame from which the dialog is displayed

title - the string to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows others windows to be active at the same time

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

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

Creates a modal or non-modal dialog with the specified title, owner Frame, and GraphicsConfiguration.

NOTE: Any popup components (JComboBox, JPopupMenu, JMenuBar) created within a modal dialog will be forced to be lightweight.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the Frame from which the dialog is displayed

title - the string to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows others windows to be active at the same time

gc - the GraphicsConfiguration of the target screen device. If gc is null, the same GraphicsConfiguration as the owning Frame is used.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

public EscapeDialog(java.awt.Dialog owner)
             throws java.awt.HeadlessException

Creates a non-modal dialog without a title with the specified Dialog as its owner.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the non-null Dialog from which the dialog is displayed

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

public EscapeDialog(java.awt.Dialog owner,
                    boolean modal)
             throws java.awt.HeadlessException

Creates a modal or non-modal dialog without a title and with the specified owner Dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the non-null Dialog from which the dialog is displayed

modal - true for a modal dialog, false for one that allows others windows to be active at the same time

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

public EscapeDialog(java.awt.Dialog owner,
                    java.lang.String title)
             throws java.awt.HeadlessException

Creates a non-modal dialog with the specified title and with the specified owner Dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the non-null Dialog from which the dialog is displayed

title - the string to display in the dialog's title bar

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

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

Creates a modal or non-modal dialog with the specified title and the specified owner Dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the non-null Dialog from which the dialog is displayed

title - the string to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows others windows to be active at the same time

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

EscapeDialog

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

Creates a modal or non-modal dialog with the specified title, owner Dialog, and GraphicsConfiguration.

NOTE: Any popup components (JComboBox, JPopupMenu, JMenuBar) created within a modal dialog will be forced to be lightweight.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale().

Parameters:

owner - the Dialog from which the dialog is displayed

title - the string to display in the dialog's title bar

modal - true for a modal dialog, false for one that allows others windows to be active at the same time

gc - the GraphicsConfiguration of the target screen device. If gc is null, the same GraphicsConfiguration as the owning Dialog is used.

Throws:

java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

See Also:

GraphicsEnvironment.isHeadless(), JComponent.getDefaultLocale()

Method Detail

bindEscapeListener

protected void bindEscapeListener()

Called by the constructor to bind escapeListener with the JDialog.rootPane so that the Escape key can be intercepted.

See Also:

escapeListener

onEscapeEvent

protected void onEscapeEvent()

Called when the user presses the Escape key. Override to custom-handle this event.