JAPDialog

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

gui.dialog
Class JAPDialog

java.lang.Object
  gui.dialog.JAPDialog

All Implemented Interfaces:: IDialogOptions, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

Direct Known Subclasses:: ActivePaymentDetails, BISelectionDialog, CaptchaDialog, CertDetailsDialog, ClipFrame, ConfigAssistant, FlatrateDialog, JAPAbout, JAPAboutNew, JAPConf, JAPInternalHelpViewer, MapBox, MixDetailsDialog, MultiCertOverview, PassivePaymentDetails, TermsAndConditionsDialog, TermsAndConditionsInfoDialog, TransactionOverviewDialog

public class JAPDialog
extends java.lang.Object
implements javax.accessibility.Accessible, javax.swing.WindowConstants, javax.swing.RootPaneContainer, java.awt.MenuContainer, java.awt.image.ImageObserver, IDialogOptions
extends java.lang.Object
implements javax.accessibility.Accessible, javax.swing.WindowConstants, javax.swing.RootPaneContainer, java.awt.MenuContainer, java.awt.image.ImageObserver, IDialogOptions

This is the generic implementation for an optionally modal, resizable a dialog. Use the getRootPane() and getContentPane() methods for customization.
The customizable dialogs show the same behaviour as the standard JDialog, except for the modality attribute: Modal JAPDialogs are only modal for their parent window and the parent of its parent and so on, but not for other Dialogs or Windows. This allows for example to access a non-modal help window at the time a modal dialog is displayed.
This class is also a replacement for JOptionPane: it allows for the same type of dialogs, and even has the same syntax (save that it only accepts String messages), but with additional features. JAPDialog option panes

are auto-formatted in the golden ratio if possible by a quick heuristic
interpret the text message as HTML, without the need to add html or body tags
may get an HTML link that triggers an arbitrary event, for example show a help window on clicking (interface ILinkedInformation)

These features take the need to put newlines or HTML breaks into the message text to format the dialog. This is done fully automatically. Also, dialog texts may get smaller, without ignoring important information. This information may be stored behind the optional dialog link. For displaying a simple link to a JAPHelp window, for example, there is a class named LinkedHelpContext. Its implementation should cover most needs.

Warning: This is a really complex class handling many bugs and differences in different JDKs. If you change something here, be sure you know what you are doing and test the class at least with the following JDKs:

Microsoft JView
1.1.8
1.2.2
1.3.x
1.4.x
1.5.x
1.6.x

Author:: Rolf Wendolsky
See Also:: JDialog, JOptionPane, DialogContentPane, JAPDialog.ILinkedInformation

Nested Class Summary
`static class`	`JAPDialog.AbstractLinkedURLAdapter` May be used to show a URL.
`private class`	`JAPDialog.BlockedWindowDeactivationAdapter` Keeps the blocked window in a disabled state and transfers the focus from it to the dialog, even if some other part of the application set it to enabled or set the focus on it.
`private class`	`JAPDialog.DialogWindowAdapter` Catches all window events and informs the window listeners about them.
`static interface`	`JAPDialog.ILinkedInformation` Classes of this type are used to append a clickable and/or selectable message at the end of a dialog message.
`static class`	`JAPDialog.LinkedCheckBox` Shows a checkbox with a message on the dialog window.
`static class`	`JAPDialog.LinkedHelpContext` This implementation of ILinkedInformation registers a help context in the dialog and displays a help button that opens this context.
`static class`	`JAPDialog.LinkedInformation`
`static class`	`JAPDialog.LinkedInformationAdapter` This class does nothing but implementing all ILinkedInformation methods.
`private static class`	`JAPDialog.LinkedInformationClickListener` Activates a LinkedInformation, if it is given as a link.
`static class`	`JAPDialog.LinkedURLCheckBox`
`static class`	`JAPDialog.Options`
`private static class`	`JAPDialog.PreferredWidthBoxPanel`
`private static class`	`JAPDialog.SimpleDialogButtonFocusWindowAdapter`

Field Summary
`static int`	`FORMAT_DEFAULT_SCREEN`
`static int`	`FORMAT_GOLDEN_RATIO_PHI`
`static int`	`FORMAT_WIDE_SCREEN`
`private static double[]`	`FORMATS`
`private boolean`	`m_bBlockParentWindow`
`private boolean`	`m_bCatchCancel`
`private boolean`	`m_bDisposed`
`private boolean`	`m_bForceApplicationModality`
`private boolean`	`m_bLocationSetManually`
`private boolean`	`m_bModal`
`private boolean`	`m_bOnTop`
`private java.util.Vector`	`m_componentListeners`
`private int`	`m_defaultCloseOperation`
`private JAPDialog.DialogWindowAdapter`	`m_dialogWindowAdapter`
`private GUIUtils.WindowDocker`	`m_docker`
`private javax.swing.JDialog`	`m_internalDialog` Stores the instance of JDialog for internal use.
`private static int`	`m_optimizedFormat`
`private java.awt.Component`	`m_parentComponent` This stores the parent component of this dialog.
`private java.awt.Window`	`m_parentWindow` This stores the parent window of this dialog.
`private java.util.Vector`	`m_windowListeners`
`private static boolean`	`ms_bConsoleOnly`
`private static java.util.Hashtable`	`ms_registeredDialogs`
`static java.lang.String`	`MSG_BTN_PROCEED`
`static java.lang.String`	`MSG_BTN_RETRY`
`static java.lang.String`	`MSG_ERROR_UNDISPLAYABLE`
`static java.lang.String`	`MSG_ERROR_UNKNOWN`
`static java.lang.String`	`MSG_TITLE_CONFIRMATION`
`static java.lang.String`	`MSG_TITLE_ERROR`
`static java.lang.String`	`MSG_TITLE_INFO`
`static java.lang.String`	`MSG_TITLE_WARNING`
`private static int`	`NUMBER_OF_HEURISTIC_ITERATIONS`
`private java.lang.Object`	`SYNC_DOCK`
`static java.lang.String`	`XML_ATTR_OPTIMIZED_FORMAT`

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`

Fields inherited from interface gui.dialog.IDialogOptions
`MESSAGE_TYPE_ERROR, MESSAGE_TYPE_INFORMATION, MESSAGE_TYPE_PLAIN, MESSAGE_TYPE_QUESTION, MESSAGE_TYPE_WARNING, OPTION_TYPE_CANCEL, OPTION_TYPE_DEFAULT, OPTION_TYPE_EMPTY, OPTION_TYPE_OK_CANCEL, OPTION_TYPE_YES_NO, OPTION_TYPE_YES_NO_CANCEL, RETURN_VALUE_CANCEL, RETURN_VALUE_CLOSED, RETURN_VALUE_NO, RETURN_VALUE_OK, RETURN_VALUE_UNINITIALIZED, RETURN_VALUE_YES`

Constructor Summary
	`JAPDialog(java.awt.Component a_parentComponent, java.lang.String a_strTitle)` Creates a new instance of JAPDialog.
	`JAPDialog(java.awt.Component a_parentComponent, java.lang.String a_strTitle, boolean a_bModal)` Creates a new instance of JAPDialog.
`private`	`JAPDialog(java.awt.Component a_parentComponent, java.lang.String a_strTitle, boolean a_bModal, boolean a_bForceApplicationModality)` Creates a new instance of JAPDialog.
	`JAPDialog(JAPDialog a_parentDialog, java.lang.String a_strTitle)` Creates a new instance of JAPDialog.
	`JAPDialog(JAPDialog a_parentDialog, java.lang.String a_strTitle, boolean a_bModal)` Creates a new instance of JAPDialog.

Method Summary
`void`	`addComponentListener(java.awt.event.ComponentListener a_listener)` Adds a Componentistener to the dialog.
`void`	`addWindowListener(java.awt.event.WindowListener a_listener)` Adds a WindowListener to the dialog.
`void`	`dispose()` Disposes the dialog (set it to invisible and releases all resources).
`void`	`doClosingOnContentPaneCancel(boolean a_bCatchCancel)` Sets if the default click on the Cancel button of a dialog content pane is caught by the WindowClosing-Event of this dialog
`(package private) void`	`doWindowClosing()`
`javax.accessibility.AccessibleContext`	`getAccessibleContext()` Returns the AccessibleContext associated with this dialog
`java.awt.Container`	`getContentPane()` Returns the content pane that can be used to place elements on the dialog.
`int`	`getDefaultCloseOperation()` Returns the reaction of this dialog on a click on the close button in the dialog's title bar.
`java.awt.Font`	`getFont()`
`java.awt.Component`	`getGlassPane()` Returns the glass pane.
`java.awt.Insets`	`getInsets()`
`private static java.awt.Window`	`getInternalDialog(JAPDialog a_dialog)` Returns the internal dialog of a JAPDialog or null if there is none.
`javax.swing.JMenuBar`	`getJMenuBar()` Returns the menubar set on this dialog.
`javax.swing.JLayeredPane`	`getLayeredPane()` Returns the JLayeredPane.
`java.awt.Point`	`getLocation()` Returns the dialog's location on the screen.
`java.lang.String`	`getName()`
`static int`	`getOptimizedFormat()` Returns the format to which all automatically scaled dialogs are optimized.
`static double`	`getOptimizedFormatDelta(JAPDialog a_dialog)` Calculates the difference from a JAPDialog's size and the golden ratio.
`static double`	`getOptimizedFormatDelta(java.awt.Window a_window)` Calculates the difference from a window's size and the golden ratio.
`static double`	`getOptimizedFormatInternal(int a_format)` Returns the format to which all automatically scaled dialogs are optimized.
`java.awt.Window`	`getOwner()` Returns the parent Window.
`java.awt.Component`	`getParentComponent()` Returns the parent Component.
`java.awt.Dimension`	`getPreferredSize()` Returns the preferred size of the dialog window.
`javax.swing.JRootPane`	`getRootPane()` Returns the root pane of the dialog.
`java.awt.Rectangle`	`getScreenBounds()` Returns the bounds of the screen where this dialog is shown.
`java.awt.Dimension`	`getSize()` Returns the size of the dialog window.
`java.lang.String`	`getTitle()`
`boolean`	`imageUpdate(java.awt.Image a_image, int a_infoflags, int a_x, int a_y, int a_width, int a_height)`
`boolean`	`isClosingOnContentPaneCancel()` Returns if the default click on the Cancel button of a dialog content pane is caught by the WindowClosing-Event of this dialog.
`static boolean`	`isConsoleOnly()`
`boolean`	`isDisposed()`
`boolean`	`isEnabled()`
`boolean`	`isModal()` Returns if the dialog is modal.
`boolean`	`isResizable()` Returns if the dialog is resizable by the user.
`boolean`	`isVisible()` Returns if the dialog is visible on the screen.
`void`	`moveToUpRightCorner()`
`void`	`pack()` Sets the dialog to the optimal size.
`boolean`	`postEvent(java.awt.Event a_event)` Deprecated. As of JDK version 1.1 replaced by dispatchEvent(AWTEvent).
`void`	`remove(java.awt.MenuComponent a_component)`
`void`	`removeComponentListener(java.awt.event.ComponentListener a_listener)` Removes a specific ComponentListener from the dialog.
`void`	`removeWindowListener(java.awt.event.WindowListener a_listener)` Removes a specific WindowListener from the dialog.
`void`	`requestFocus()` Try to get the focus.
`private static boolean`	`requestFocusForFirstFocusableComponent(java.awt.Container a_container)` Finds the first focusable Component in a Container and sets the focus on it.
`void`	`resetAutomaticLocation(boolean a_bDoNotSetLocationAutomatically)` After using a method that sets the location of the dialog, it will not automatically set its location any more.
`void`	`restoreLocation(java.awt.Point a_point)` Sets a window to the specified position and tries to put the window inside the screen by altering the position if needed.
`void`	`restoreSize(java.awt.Dimension a_size)` Sets a window to the specified size and tries to put the window inside the screen by altering the size if needed.
`static java.lang.String`	`retrieveErrorMessage(java.lang.String a_message, java.lang.Throwable a_throwable)` Retrieves an error message from a Throwable and a message String that may be shown to the user.
`void`	`setAlwaysOnTop(boolean a_bOnTop)`
`static void`	`setConsoleOnly(boolean a_bConsoleOnly)` Disables the output of static dialog methods.
`void`	`setContentPane(java.awt.Container a_contentPane)` Sets a new content pane for this dialog.
`void`	`setDefaultCloseOperation(int a_windowAction)` Defines the reaction of this dialog on a click on the close button in the dialog's title bar.
`void`	`setDockable(boolean a_bDockable)`
`void`	`setEnabled(boolean b)`
`void`	`setGlassPane(java.awt.Component a_glassPane)` Sets a new glass pane for this dialog.
`void`	`setJMenuBar(javax.swing.JMenuBar a_menubar)` Sets the menubar for this dialog.
`void`	`setLayeredPane(javax.swing.JLayeredPane a_layeredPane)` Sets a new JLayeredPane for this dialog.
`void`	`setLocation(int x, int y)` Sets the location of the dialog 'manually'.
`void`	`setLocation(java.awt.Point a_location)` Sets the location of the dialog 'manually'.
`void`	`setLocationCenteredOn(java.awt.Component a_component)` The dialog is centered on the given Component.
`void`	`setLocationCenteredOnOwner()` Centers the dialog on the parent window, that means either the parent, if it is a window, or the the first window that contains the parent.
`void`	`setLocationCenteredOnParent()` The dialog is centered on the parent Component.
`void`	`setLocationCenteredOnScreen()` Centers this dialog relative to the screen.
`void`	`setLocationRelativeToOwner()` The dialog is positioned right under the owner window.
`void`	`setModal(boolean a_bModal)` Defines the dialog as modal or not.
`void`	`setName(java.lang.String a_name)`
`static void`	`setOptimizedFormat(int a_optimizedFormat)` Sets the format to which all automatically scaled dialogs are optimized.
`void`	`setResizable(boolean a_bResizable)` Allows to set the dialog resizable or fixed-sized.
`void`	`setSize(java.awt.Dimension a_size)` Sets the size of the dialog window.
`void`	`setSize(int a_width, int a_height)` Sets the size of the dialog window.
`void`	`setTitle(java.lang.String a_title)` Sets the title of this dialog.
`void`	`setVisible(boolean a_bVisible)` Shows or hides the dialog.
`void`	`setVisible(boolean a_bVisible, boolean a_bCenterOnParentComponent)` Shows or hides the dialog.
`private void`	`setVisibleInternal(boolean a_bVisible)` JAPDialog's main logic.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, int a_optionType, int a_messageType)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, int a_optionType, int a_messageType, javax.swing.Icon a_icon)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, int a_optionType, int a_messageType, JAPDialog.ILinkedInformation a_linkedInformation)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, JAPDialog.Options a_options, int a_messageType)` Displays a confirm dialog.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, JAPDialog.Options a_options, int a_messageType, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a confirm dialog.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, int a_optionType, int a_messageType)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, int a_optionType, int a_messageType, javax.swing.Icon a_icon)` Displays a message dialog.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, int a_optionType, int a_messageType, javax.swing.Icon a_icon, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a confirm dialog.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, int a_optionType, int a_messageType, JAPDialog.ILinkedInformation a_linkedInformation)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, JAPDialog.Options a_options, int a_messageType, javax.swing.Icon a_icon, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a confirm dialog.
`static int`	`showConfirmDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, JAPDialog.Options a_options, int a_messageType, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a confirm dialog.
`static int`	`showConfirmDialog(JAPDialog a_parentDialog, java.lang.String a_message, int a_optionType, int a_messageType)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static int`	`showConfirmDialog(JAPDialog a_parentDialog, java.lang.String a_message, int a_optionType, int a_messageType, javax.swing.Icon a_icon)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static int`	`showConfirmDialog(JAPDialog a_parentDialog, java.lang.String a_message, int a_optionType, int a_messageType, JAPDialog.ILinkedInformation a_linkedInformation)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static int`	`showConfirmDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, int a_optionType, int a_messageType)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static int`	`showConfirmDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, int a_optionType, int a_messageType, javax.swing.Icon a_icon)` Displays a message dialog.
`static int`	`showConfirmDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, int a_optionType, int a_messageType, javax.swing.Icon a_icon, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a message dialog.
`static int`	`showConfirmDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, int a_optionType, int a_messageType, JAPDialog.ILinkedInformation a_linkedInformation)` Brings up a dialog where the number of choices is determined by the optionType parameter.
`static void`	`showErrorDialog(java.awt.Component a_parentComponent, int a_logType, java.lang.Throwable a_throwable)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(java.awt.Component a_parentComponent, java.lang.String a_message, int a_logType)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(java.awt.Component a_parentComponent, java.lang.String a_message, int a_logType, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(java.awt.Component a_parentComponent, java.lang.String a_message, int a_logType, java.lang.String a_title)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(java.awt.Component a_parentComponent, java.lang.String a_message, int a_logType, java.lang.Throwable a_throwable)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, int a_logType)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, int a_logType, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, int a_logType, java.lang.Throwable a_throwable)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, int a_logType, java.lang.Throwable a_throwable, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(JAPDialog a_parentDialog, int a_logType, java.lang.Throwable a_throwable)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(JAPDialog a_parentDialog, java.lang.String a_message, int a_logType)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(JAPDialog a_parentDialog, java.lang.String a_message, int a_logType, JAPDialog.ILinkedInformation a_linkedInformation)`
`static void`	`showErrorDialog(JAPDialog a_parentDialog, java.lang.String a_message, int a_logType, java.lang.String a_title)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(JAPDialog a_parentDialog, java.lang.String a_message, int a_logType, java.lang.Throwable a_throwable)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showErrorDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, int a_logType, java.lang.Throwable a_throwable)` Displays a dialog showing an error message to the user and logs the error message to the currently used Log.
`static void`	`showMessageDialog(java.awt.Component a_parentComponent, java.lang.String a_message)` Displays an info message dialog.
`static void`	`showMessageDialog(java.awt.Component a_parentComponent, java.lang.String a_message, javax.swing.Icon a_icon)` Displays an info message dialog.
`static void`	`showMessageDialog(java.awt.Component a_parentComponent, java.lang.String a_message, javax.swing.Icon a_icon, JAPDialog.ILinkedInformation a_linkedInformation)` Displays an info message dialog.
`static void`	`showMessageDialog(java.awt.Component a_parentComponent, java.lang.String a_message, JAPDialog.ILinkedInformation a_linkedInformation)` Displays an info message dialog.
`static void`	`showMessageDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title)` Displays an info message dialog.
`static void`	`showMessageDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, javax.swing.Icon a_icon)` Displays an info message dialog.
`static void`	`showMessageDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, javax.swing.Icon a_icon, JAPDialog.ILinkedInformation a_linkedInformation)` Displays an info message dialog.
`static void`	`showMessageDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, JAPDialog.ILinkedInformation a_linkedInformation)` Displays an info message dialog.
`static void`	`showMessageDialog(JAPDialog a_parentDialog, java.lang.String a_message)` Displays an info message dialog.
`static void`	`showMessageDialog(JAPDialog a_parentDialog, java.lang.String a_message, javax.swing.Icon a_icon)` Displays an info message dialog.
`static void`	`showMessageDialog(JAPDialog a_parentDialog, java.lang.String a_message, javax.swing.Icon a_icon, JAPDialog.ILinkedInformation a_linkedInformation)` Displays an info message dialog.
`static void`	`showMessageDialog(JAPDialog a_parentDialog, java.lang.String a_message, JAPDialog.ILinkedInformation a_linkedInformation)` Displays an info message dialog.
`static void`	`showMessageDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title)` Displays an info message dialog.
`static void`	`showMessageDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, javax.swing.Icon a_icon)` Displays an info message dialog.
`static void`	`showMessageDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, javax.swing.Icon a_icon, JAPDialog.ILinkedInformation a_linkedInformation)` Displays an info message dialog.
`static void`	`showMessageDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, JAPDialog.ILinkedInformation a_linkedInformation)` Displays an info message dialog.
`static void`	`showWarningDialog(java.awt.Component a_parentComponent, java.lang.String a_message)` Displays a warning message dialog.
`static void`	`showWarningDialog(java.awt.Component a_parentComponent, java.lang.String a_message, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a warning message dialog.
`static void`	`showWarningDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title)` Displays a warning message dialog.
`static void`	`showWarningDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a warning message dialog.
`static void`	`showWarningDialog(JAPDialog a_parentDialog, java.lang.String a_message)` Displays a warning message dialog.
`static void`	`showWarningDialog(JAPDialog a_parentDialog, java.lang.String a_message, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a warning message dialog.
`static void`	`showWarningDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title)` Displays a warning message dialog.
`static void`	`showWarningDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a warning message dialog.
`static boolean`	`showYesNoDialog(java.awt.Component a_parentComponent, java.lang.String a_message)` Displays a message dialog that asks the user for a confirmation.
`static boolean`	`showYesNoDialog(java.awt.Component a_parentComponent, java.lang.String a_message, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a message dialog that asks the user for a confirmation.
`static boolean`	`showYesNoDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title)` Displays a message dialog that asks the user for a confirmation.
`static boolean`	`showYesNoDialog(java.awt.Component a_parentComponent, java.lang.String a_message, java.lang.String a_title, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a message dialog that asks the user for a confirmation.
`static boolean`	`showYesNoDialog(JAPDialog a_parentDialog, java.lang.String a_message)` Displays a message dialog that asks the user for a confirmation.
`static boolean`	`showYesNoDialog(JAPDialog a_parentDialog, java.lang.String a_message, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a message dialog that asks the user for a confirmation.
`static boolean`	`showYesNoDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title)` Displays a message dialog that asks the user for a confirmation.
`static boolean`	`showYesNoDialog(JAPDialog a_parentDialog, java.lang.String a_message, java.lang.String a_title, JAPDialog.ILinkedInformation a_linkedInformation)` Displays a message dialog that asks the user for a confirmation.
`void`	`toBack()` If this Window is visible, sends this Window to the back and may cause it to lose focus or activation if it is the focused or active Window.
`void`	`toFront()` If this Window is visible, brings this Window to the front and may make it the focused Window.
`void`	`validate()` Validates the dialog.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

XML_ATTR_OPTIMIZED_FORMAT

public static final java.lang.String XML_ATTR_OPTIMIZED_FORMAT

See Also:: Constant Field Values

FORMAT_GOLDEN_RATIO_PHI

public static final int FORMAT_GOLDEN_RATIO_PHI

See Also:: Constant Field Values

FORMAT_DEFAULT_SCREEN

public static final int FORMAT_DEFAULT_SCREEN

See Also:: Constant Field Values

FORMAT_WIDE_SCREEN

public static final int FORMAT_WIDE_SCREEN

See Also:: Constant Field Values

FORMATS

private static final double[] FORMATS

MSG_ERROR_UNKNOWN

public static final java.lang.String MSG_ERROR_UNKNOWN

MSG_TITLE_INFO

public static final java.lang.String MSG_TITLE_INFO

MSG_TITLE_CONFIRMATION

public static final java.lang.String MSG_TITLE_CONFIRMATION

MSG_TITLE_WARNING

public static final java.lang.String MSG_TITLE_WARNING

MSG_TITLE_ERROR

public static final java.lang.String MSG_TITLE_ERROR

MSG_ERROR_UNDISPLAYABLE

public static final java.lang.String MSG_ERROR_UNDISPLAYABLE

MSG_BTN_PROCEED

public static final java.lang.String MSG_BTN_PROCEED

MSG_BTN_RETRY

public static final java.lang.String MSG_BTN_RETRY

NUMBER_OF_HEURISTIC_ITERATIONS

private static final int NUMBER_OF_HEURISTIC_ITERATIONS

See Also:: Constant Field Values

m_optimizedFormat

private static int m_optimizedFormat

ms_registeredDialogs

private static java.util.Hashtable ms_registeredDialogs

ms_bConsoleOnly

private static boolean ms_bConsoleOnly

m_bLocationSetManually

private boolean m_bLocationSetManually

m_bModal

private boolean m_bModal

m_bBlockParentWindow

private boolean m_bBlockParentWindow

m_defaultCloseOperation

private int m_defaultCloseOperation

m_windowListeners

private java.util.Vector m_windowListeners

m_componentListeners

private java.util.Vector m_componentListeners

m_dialogWindowAdapter

private JAPDialog.DialogWindowAdapter m_dialogWindowAdapter

m_bForceApplicationModality

private boolean m_bForceApplicationModality

m_bDisposed

private boolean m_bDisposed

m_bCatchCancel

private boolean m_bCatchCancel

m_docker

private GUIUtils.WindowDocker m_docker

SYNC_DOCK

private final java.lang.Object SYNC_DOCK

m_internalDialog

private javax.swing.JDialog m_internalDialog

Stores the instance of JDialog for internal use.

m_parentComponent

private java.awt.Component m_parentComponent

This stores the parent component of this dialog.

m_parentWindow

private java.awt.Window m_parentWindow

This stores the parent window of this dialog.

m_bOnTop

private boolean m_bOnTop

Constructor Detail

JAPDialog

public JAPDialog(java.awt.Component a_parentComponent,
                 java.lang.String a_strTitle,
                 boolean a_bModal)

Creates a new instance of JAPDialog. It is user-resizable.

Parameters:: a_parentComponent - The parent component for this dialog. If it is null or the parent component is not within a frame, the dialog's parent frame is the default frame.; a_strTitle - The title String for this dialog.; a_bModal - if the dialog should be modal

JAPDialog

public JAPDialog(java.awt.Component a_parentComponent,
                 java.lang.String a_strTitle)

Creates a new instance of JAPDialog. It is user-resizable and modal.

Parameters:: a_parentComponent - The parent component for this dialog. If it is null or the parent component is not within a frame, the dialog's parent frame is the default frame.; a_strTitle - The title String for this dialog.

JAPDialog

public JAPDialog(JAPDialog a_parentDialog,
                 java.lang.String a_strTitle,
                 boolean a_bModal)

Creates a new instance of JAPDialog. It is user-resizable.

Parameters:: a_parentDialog - The parent dialog for this dialog. If it is null, the dialog's parent frame is the default frame.; a_strTitle - The title String for this dialog.; a_bModal - if the dialog should be modal

JAPDialog

public JAPDialog(JAPDialog a_parentDialog,
                 java.lang.String a_strTitle)

Creates a new instance of JAPDialog. It is user-resizable.

Parameters:: a_parentDialog - The parent dialog for this dialog. If it is null, the dialog's parent frame is the default frame.; a_strTitle - The title String for this dialog.

JAPDialog

private JAPDialog(java.awt.Component a_parentComponent,
                  java.lang.String a_strTitle,
                  boolean a_bModal,
                  boolean a_bForceApplicationModality)

Creates a new instance of JAPDialog. It is user-resizable.

Parameters:: a_parentComponent - The parent component for this dialog. If it is null or the parent component is not within a frame, the dialog's parent frame is the default frame.; a_strTitle - The title String for this dialog.; a_bModal - if the dialog should be modal; a_bForceApplicationModality - Force the JAPDialog to behave like a JDialog and block all application windows. This should not be available for the public, only for internal use!

Method Detail

setConsoleOnly

public static void setConsoleOnly(boolean a_bConsoleOnly)

Disables the output of static dialog methods. All those method will return RETURN_VALUE_UNINITIALIZED.

Parameters:: a_bConsoleOnly - if the output of static dialog methods should be disabled

isConsoleOnly

public static boolean isConsoleOnly()

setOptimizedFormat

public static void setOptimizedFormat(int a_optimizedFormat)

Sets the format to which all automatically scaled dialogs are optimized. It is one of the constants FORMAT_GOLDEN_RATIO_PHI, FORMAT_DEFAULT_SCREEN and FORMAT_WIDE_SCREEN.

Parameters:: a_optimizedFormat - the format to which all automatically scaled dialogs are optimized

getOptimizedFormat

public static int getOptimizedFormat()

Returns the format to which all automatically scaled dialogs are optimized. It is one of the constants GOLDEN_RATIO_PHI, DEFAULT_SCREEN_FORMAT and WIDE_SCREEN_FORMAT.

Returns:: the format to which all automatically scaled dialogs are optimized

getOptimizedFormatInternal

public static double getOptimizedFormatInternal(int a_format)

Returns the format to which all automatically scaled dialogs are optimized. It is one of the constants FORMAT_DEFAULT_SCREEN, FORMAT_GOLDEN_RATIO_PHI, and FORMAT_WIDE_SCREEN.

Parameters:: a_format - one of the constants FORMAT_DEFAULT_SCREEN, FORMAT_GOLDEN_RATIO_PHI, and FORMAT_WIDE_SCREEN
Returns:: the format to which all automatically scaled dialogs are optimized

getOptimizedFormatDelta

public static double getOptimizedFormatDelta(java.awt.Window a_window)

Calculates the difference from a window's size and the golden ratio.

Parameters:: a_window - a Window
Returns:: the difference from a window's size and the golden ratio

getOptimizedFormatDelta

public static double getOptimizedFormatDelta(JAPDialog a_dialog)

Calculates the difference from a JAPDialog's size and the golden ratio.

Parameters:: a_dialog - a JAPDialog
Returns:: the difference from a JAPDialog's size and the golden ratio