|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.openstreetmap.josm.gui.ConditionalOptionPaneUtil
public class ConditionalOptionPaneUtil
ConditionalOptionPaneUtil provides static utility methods for displaying modal message dialogs
which can be enabled/disabled by the user.
They wrap the methods provided by JOptionPane
. Within JOSM you should use these
methods rather than the bare methods from JOptionPane
because the methods provided
by ConditionalOptionPaneUtil ensure that a dialog window is always on top and isn't hidden by one of the
JOSM windows for detached dialogs, relation editors, history browser and the like.
Nested Class Summary | |
---|---|
private static class |
ConditionalOptionPaneUtil.MessagePanel
This is a message panel used in dialogs which can be enabled/disabled with a preference setting. |
Field Summary | |
---|---|
static int |
DIALOG_DISABLED_OPTION
|
Constructor Summary | |
---|---|
private |
ConditionalOptionPaneUtil()
this is a static utility class only |
Method Summary | |
---|---|
static java.lang.Integer |
getDialogReturnValue(java.lang.String prefKey)
Returns the preference value for the preference key "message." + prefKey + ".value". |
static boolean |
getDialogShowingEnabled(java.lang.String prefKey)
Replies the preference value for the preference key "message." + prefKey . |
static void |
setDialogReturnValue(java.lang.String prefKey,
java.lang.Integer value)
sets the value for the preference key "message." + prefKey + ".value". |
static void |
setDialogShowingEnabled(java.lang.String prefKey,
boolean enabled)
sets the value for the preference key "message." + prefKey . |
static boolean |
showConfirmationDialog(java.lang.String preferenceKey,
java.awt.Component parent,
java.lang.Object message,
java.lang.String title,
int optionType,
int messageType,
int trueOption)
Displays a confirmation dialog with some option buttons given by optionType . |
static void |
showMessageDialog(java.lang.String preferenceKey,
java.awt.Component parent,
java.lang.Object message,
java.lang.String title,
int messageType)
Displays an message in modal dialog with an OK button. |
static int |
showOptionDialog(java.lang.String preferenceKey,
java.awt.Component parent,
java.lang.Object message,
java.lang.String title,
int optionType,
int messageType,
java.lang.Object[] options,
java.lang.Object defaultOption)
Displays an confirmation dialog with some option buttons given by optionType . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DIALOG_DISABLED_OPTION
Constructor Detail |
---|
private ConditionalOptionPaneUtil()
Method Detail |
---|
public static boolean getDialogShowingEnabled(java.lang.String prefKey)
prefKey
.
The default value if the preference key is missing is true.
the
- preference key
prefKey
public static void setDialogShowingEnabled(java.lang.String prefKey, boolean enabled)
prefKey
.
prefKey
- the keyenabled
- the valuepublic static java.lang.Integer getDialogReturnValue(java.lang.String prefKey)
prefKey
+ ".value".
The default value if the preference key is missing is -1.
the
- preference key
prefKey
+ ".value"public static void setDialogReturnValue(java.lang.String prefKey, java.lang.Integer value)
prefKey
+ ".value".
prefKey
- the keyvalue
- the valuepublic static int showOptionDialog(java.lang.String preferenceKey, java.awt.Component parent, java.lang.Object message, java.lang.String title, int optionType, int messageType, java.lang.Object[] options, java.lang.Object defaultOption) throws java.awt.HeadlessException
optionType
.
It is always on top even if there are other open windows like detached dialogs,
relation editors, history browsers and the like.
Set optionType
to JOptionPane.YES_NO_OPTION
for a dialog with a YES and
a NO button.
Set optionType
to JOptionPane.YES_NO_CANCEL_OPTION
for a dialog with a YES,
a NO and a CANCEL button
Returns one of the constants JOptionPane.YES_OPTION, JOptionPane.NO_OPTION,
JOptionPane.CANCEL_OPTION or JOptionPane.CLOSED_OPTION depending on the action chosen by
the user.
preferenceKey
- the preference keyparent
- the parent componentmessage
- the messagetitle
- the titleoptionType
- the option typemessageType
- the message typeoptions
- a list of optionsdefaultOption
- the default option
JOptionPane.CLOSED_OPTION
if the dialog was closed.
java.awt.HeadlessException
public static boolean showConfirmationDialog(java.lang.String preferenceKey, java.awt.Component parent, java.lang.Object message, java.lang.String title, int optionType, int messageType, int trueOption) throws java.awt.HeadlessException
optionType
.
It is always on top even if there are other open windows like detached dialogs,
relation editors, history browsers and the like.
Set optionType
to JOptionPane.YES_NO_OPTION
for a dialog with a YES and
a NO button.
Set optionType
to JOptionPane.YES_NO_CANCEL_OPTION
for a dialog with a YES,
a NO and a CANCEL button
Replies true, if the selected option is equal to trueOption
, otherwise false.
Replies true, if the dialog is not displayed because the respective preference option
preferenceKey
is set to false and the user has previously chosen
trueOption
.
preferenceKey
- the preference keyparent
- the parent componentmessage
- the messagetitle
- the titleoptionType
- the option typemessageType
- the message typetrueOption
- if this option is selected the method replies true
trueOption
, otherwise false.
java.awt.HeadlessException
JOptionPane.INFORMATION_MESSAGE
,
JOptionPane.WARNING_MESSAGE
,
JOptionPane.ERROR_MESSAGE
public static void showMessageDialog(java.lang.String preferenceKey, java.awt.Component parent, java.lang.Object message, java.lang.String title, int messageType)
preferenceKey
and value false
the dialog is not show.
preferenceKey
- the preference keyparent
- the parent componentmessage
- the messagetitle
- the titlemessageType
- the message typeJOptionPane.INFORMATION_MESSAGE
,
JOptionPane.WARNING_MESSAGE
,
JOptionPane.ERROR_MESSAGE
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |