com.xmlmind.guiutil

Class DialogBase

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

com.xmlmind.guiutil.DialogBase

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

AboutAction.AboutDialog, AddKeyboardShortcutDialog, AreaEditor, AttributeEditor, AuthenticationDialog, CharacterDialog, CheckDocDialog, CheckForUpdatesAction.InfoBox, CheckValidityDialog, ClipboardViewer, ConversionParameterEditor, ConversionStylesheetChooser, ConversionStylesheetsEditor, CustomizeNodePathAction.Editor, CustomizeNodePathAction.EntryEditor, CustomizeStylesheetDialog, EditAttributesDialog, EditBookDivisionDialog, EditFontSpecDialog, EditFontSpecDialog, EditModuleDialog, EditText.DialogBox, EditTopicrefDialog, EncodedBinaryViewer, Execute.Dialog, FontChooserDialog, HelperApplicationEditor, HelperApplications.FindHelperAppDialog, IframeInfoEditor, ImageFolderChooser, IndexTermEditorBase, InstallAddonsDialog, ItemChooserDialog, LinkCallouts.PrefixDialog, ListAnchorsDialog, ListRevisionsDialog, OlinkedDocEditor, OlinkedDocsEditor, OlinkTargetChooser, OutputSelector, ParameterEditor, PathChooserDialog, PreferencesEditorDialog, PrefixPreferencesDialog, PreprocessingOptionsEditor, PreviewSettingsEditor, ProfileSelector, ProfilingAttributesEditor, PromptDialog, QueryEditor, RelationshipEditor, RemarkEditor, ResourceDialog, Run.Dialog, SaveAsTemplateDialog, SearchDialog, SearchReplaceDialog, SearchReplaceDialog, SetDateDialog, SetDateTimeDialog, SetFilterDialog, SetTimeDialog, SpellCheckDialog, StyleEditor, StyleEditor, TableFormatEditor, TableSizeDialog, TextStyleEditor, TextStyleListEditor, Tool, TreeViewSettingsEditor, URLChooserDialog, ViewsEditor, WebSearchServiceEditor, XPathSearchDialog

public abstract class DialogBase
extends JDialog
implements ActionListener

A base class for modal or non-modal dialog boxes having OK+Cancel buttons or a Close button, plus an optional Help button.

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, Window.Type

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

Fields

Modifier and Type	Field and Description
protected Component	dialogAnchor
protected JButton[]	dialogButtons
protected JButton	helpButton
protected Component	parentComponent
protected static int	STYLE_BUTTONS_AT_RIGHT
protected static int	STYLE_BUTTONS_VGAP
protected static int	STYLE_CLOSE_BUTTON
protected static int	STYLE_FORM_MARGINS
protected static int	STYLE_HELP_BUTTON
protected static int	STYLE_MODAL
protected static int	STYLE_OK_CANCEL_BUTTONS
protected static int	STYLE_RESIZABLE

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

Constructors

Modifier	Constructor and Description
protected	DialogBase(Component parentComponent, String title, boolean modal)
protected	DialogBase(Component parentComponent, String title, int style)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent event) Not part of the public API.
void	cancel() Not part of the public API.
void	close() Not part of the public API.
protected Component	createButtonsPane(int style, GridBagConstraints constraints)
protected abstract Component	createForm()
Component	getParentComponent() Returns the parent component of this dialog box, that is, the component passed as a parameter to the constructor.
protected void	initGlassPane() Must be invoked at the end of a constructor in order to allow using waitCursor(boolean).
protected void	initialize(Component parentComponent, int style)
void	ok() Not part of the public API.
void	setHelpId(String helpId) Associates a help ID to the Help button of this dialog box.
static boolean	showDialog(Component parentComponent, String title, int style, Component form, Component focusComponent, Icon icon, String message) Similar to showDialog(Dialog, String, int, Component, Component, Icon, String).
static boolean	showDialog(Dialog parentComponent, String title, int style, Component form, Component focusComponent, Icon icon, String message) Displays specified component inside a dialog box having specified features.
void	waitCursor(boolean on) Displays the wait cursor and also blocks all the user input.

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, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, 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, 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, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, 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, 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, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, 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

STYLE_MODAL

protected static final int STYLE_MODAL

See Also:

Constant Field Values

STYLE_RESIZABLE

protected static final int STYLE_RESIZABLE

See Also:

Constant Field Values

STYLE_FORM_MARGINS

protected static final int STYLE_FORM_MARGINS

See Also:

Constant Field Values

STYLE_BUTTONS_VGAP

protected static final int STYLE_BUTTONS_VGAP

See Also:

Constant Field Values

STYLE_OK_CANCEL_BUTTONS

protected static final int STYLE_OK_CANCEL_BUTTONS

See Also:

Constant Field Values

STYLE_CLOSE_BUTTON

protected static final int STYLE_CLOSE_BUTTON

See Also:

Constant Field Values

STYLE_HELP_BUTTON

protected static final int STYLE_HELP_BUTTON

See Also:

Constant Field Values

STYLE_BUTTONS_AT_RIGHT

protected static final int STYLE_BUTTONS_AT_RIGHT

See Also:

Constant Field Values

parentComponent

protected Component parentComponent

dialogAnchor

protected Component dialogAnchor

dialogButtons

protected JButton[] dialogButtons

helpButton

protected JButton helpButton

Constructor Detail

DialogBase

protected DialogBase(Component parentComponent,
                     String title,
                     int style)

DialogBase

protected DialogBase(Component parentComponent,
                     String title,
                     boolean modal)

Method Detail

initialize

protected void initialize(Component parentComponent,
                          int style)

createButtonsPane

protected Component createButtonsPane(int style,
                                      GridBagConstraints constraints)

setHelpId

public void setHelpId(String helpId)

Associates a help ID to the Help button of this dialog box.

Has no effect if this dialog box has no Help button.

Parameters:

helpId - specifies the help ID of the Help button.

Specify null to use the fully qualified class name of this dialog box as the help ID.

createForm

protected abstract Component createForm()

getParentComponent

public Component getParentComponent()

Returns the parent component of this dialog box, that is, the component passed as a parameter to the constructor.

actionPerformed

public void actionPerformed(ActionEvent event)

Not part of the public API.

Specified by:

actionPerformed in interface ActionListener

ok

public void ok()

Not part of the public API.

cancel

public void cancel()

Not part of the public API.

close

public void close()

Not part of the public API.

initGlassPane

protected void initGlassPane()

Must be invoked at the end of a constructor in order to allow using waitCursor(boolean).

waitCursor

public void waitCursor(boolean on)

Displays the wait cursor and also blocks all the user input.

Parameters:

on - if true, display the wait cursor. If false, display the normal cursor and unblock the user input.

showDialog

public static boolean showDialog(Dialog parentComponent,
                                 String title,
                                 int style,
                                 Component form,
                                 Component focusComponent,
                                 Icon icon,
                                 String message)

Displays specified component inside a dialog box having specified features.

Parameters:

parentComponent - the parent of the dialog box

title - the title of the dialog box

style - the style of the dialog box

form - the component displayed inside the dialog box

focusComponent - the component contained in of form that is to receive the keyboard focus. May be null.

icon - an icon displayed at the left of form. May be null.

message - a (possibly multi-line) message displayed at the top of form. May be null.

Returns:

true if the user clicked OK false if the user clicked Cancel or Close.

showDialog

public static boolean showDialog(Component parentComponent,
                                 String title,
                                 int style,
                                 Component form,
                                 Component focusComponent,
                                 Icon icon,
                                 String message)

Similar to showDialog(Dialog, String, int, Component, Component, Icon, String). Use this method when the parent of the dialog box is not a kind of Dialog.