public final class HelpAwareOptionPane extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
HelpAwareOptionPane.ButtonSpec |
private static class |
HelpAwareOptionPane.DefaultAction |
Modifier | Constructor and Description |
---|---|
private |
HelpAwareOptionPane() |
Modifier and Type | Method and Description |
---|---|
private static javax.swing.JButton |
createHelpButton(java.lang.String helpTopic)
Creates the help button
|
private static java.util.List<javax.swing.JButton> |
createOptionButtons(HelpAwareOptionPane.ButtonSpec[] options,
java.lang.String helpTopic)
Creates the list buttons to be displayed in the option pane dialog.
|
static void |
showMessageDialogInEDT(java.awt.Component parentComponent,
java.lang.Object msg,
java.lang.String title,
int messageType,
java.lang.String helpTopic)
Run it in Event Dispatch Thread.
|
static int |
showOptionDialog(java.awt.Component parentComponent,
java.lang.Object msg,
java.lang.String title,
int messageType,
javax.swing.Icon icon,
HelpAwareOptionPane.ButtonSpec[] options,
HelpAwareOptionPane.ButtonSpec defaultOption,
java.lang.String helpTopic)
Displays an option dialog which is aware of a help context.
|
static int |
showOptionDialog(java.awt.Component parentComponent,
java.lang.Object msg,
java.lang.String title,
int messageType,
java.lang.String helpTopic)
Displays an option dialog which is aware of a help context.
|
private HelpAwareOptionPane()
private static java.util.List<javax.swing.JButton> createOptionButtons(HelpAwareOptionPane.ButtonSpec[] options, java.lang.String helpTopic)
options
- the option. If null, just creates an OK button and a help buttonhelpTopic
- the help topic. The context sensitive help of all buttons is equal
to the context sensitive help of the whole dialogprivate static javax.swing.JButton createHelpButton(java.lang.String helpTopic)
helpTopic
- the help topicpublic static int showOptionDialog(java.awt.Component parentComponent, java.lang.Object msg, java.lang.String title, int messageType, javax.swing.Icon icon, HelpAwareOptionPane.ButtonSpec[] options, HelpAwareOptionPane.ButtonSpec defaultOption, java.lang.String helpTopic)
helpTopic
isn't null,
the dialog includes a "Help" button and launches the help browser if the user presses F1. If the
user clicks on the "Help" button the option dialog remains open and JOSM launches the help
browser.
helpTopic
is the trailing part of a JOSM online help URL, i.e. the part after the leading
https://josm.openstreetmap.de/wiki/Help
. It should start with a leading '/' and it
may include an anchor after a '#'.
Examples
parentComponent
- the parent componentmsg
- the messagetitle
- the titlemessageType
- the message type (see JOptionPane
)icon
- the icon to display. Can be null.options
- the list of options to display. Can be null.defaultOption
- the default option. Can be null.helpTopic
- the help topic. Can be null.JOptionPane.CLOSED_OPTION
public static int showOptionDialog(java.awt.Component parentComponent, java.lang.Object msg, java.lang.String title, int messageType, java.lang.String helpTopic)
parentComponent
- the parent componentmsg
- the messagetitle
- the titlemessageType
- the message type (see JOptionPane
)helpTopic
- the help topic. Can be null.JOptionPane.CLOSED_OPTION
showOptionDialog(Component, Object, String, int, Icon, ButtonSpec[], ButtonSpec, String)
public static void showMessageDialogInEDT(java.awt.Component parentComponent, java.lang.Object msg, java.lang.String title, int messageType, java.lang.String helpTopic)