[2512] | 1 | // License: GPL. For details, see LICENSE file.
|
---|
| 2 | package org.openstreetmap.josm.gui;
|
---|
| 3 |
|
---|
| 4 | import static org.openstreetmap.josm.tools.I18n.tr;
|
---|
| 5 |
|
---|
| 6 | import java.awt.Component;
|
---|
[3501] | 7 | import java.awt.Dialog.ModalityType;
|
---|
[2512] | 8 | import java.awt.event.ActionEvent;
|
---|
| 9 | import java.awt.event.KeyEvent;
|
---|
| 10 | import java.awt.event.WindowAdapter;
|
---|
| 11 | import java.awt.event.WindowEvent;
|
---|
| 12 | import java.util.ArrayList;
|
---|
[6051] | 13 | import java.util.Collection;
|
---|
| 14 | import java.util.HashSet;
|
---|
[2512] | 15 | import java.util.List;
|
---|
| 16 |
|
---|
[5926] | 17 | import javax.swing.AbstractAction;
|
---|
| 18 | import javax.swing.Action;
|
---|
| 19 | import javax.swing.Icon;
|
---|
| 20 | import javax.swing.JButton;
|
---|
| 21 | import javax.swing.JComponent;
|
---|
| 22 | import javax.swing.JDialog;
|
---|
| 23 | import javax.swing.JOptionPane;
|
---|
| 24 | import javax.swing.KeyStroke;
|
---|
[6051] | 25 | import javax.swing.event.ChangeEvent;
|
---|
| 26 | import javax.swing.event.ChangeListener;
|
---|
[2512] | 27 |
|
---|
[2715] | 28 | import org.openstreetmap.josm.gui.help.HelpBrowser;
|
---|
[2512] | 29 | import org.openstreetmap.josm.gui.help.HelpUtil;
|
---|
[6040] | 30 | import org.openstreetmap.josm.gui.util.GuiHelper;
|
---|
[5886] | 31 | import org.openstreetmap.josm.gui.widgets.JosmEditorPane;
|
---|
[2512] | 32 | import org.openstreetmap.josm.tools.ImageProvider;
|
---|
[5200] | 33 | import org.openstreetmap.josm.tools.InputMapUtils;
|
---|
[2512] | 34 | import org.openstreetmap.josm.tools.WindowGeometry;
|
---|
| 35 |
|
---|
[6362] | 36 | public final class HelpAwareOptionPane {
|
---|
[2512] | 37 |
|
---|
[6360] | 38 | private HelpAwareOptionPane() {
|
---|
| 39 | // Hide default constructor for utils classes
|
---|
| 40 | }
|
---|
[6920] | 41 |
|
---|
[2512] | 42 | public static class ButtonSpec {
|
---|
[5951] | 43 | public final String text;
|
---|
| 44 | public final Icon icon;
|
---|
| 45 | public final String tooltipText;
|
---|
| 46 | public final String helpTopic;
|
---|
[6051] | 47 | private boolean enabled;
|
---|
[6070] | 48 |
|
---|
[7005] | 49 | private final Collection<ChangeListener> listeners = new HashSet<>();
|
---|
[6070] | 50 |
|
---|
[5951] | 51 | /**
|
---|
| 52 | * Constructs a new {@code ButtonSpec}.
|
---|
| 53 | * @param text the button text
|
---|
| 54 | * @param icon the icon to display. Can be null
|
---|
| 55 | * @param tooltipText the tooltip text. Can be null.
|
---|
| 56 | * @param helpTopic the help topic. Can be null.
|
---|
| 57 | */
|
---|
| 58 | public ButtonSpec(String text, Icon icon, String tooltipText, String helpTopic) {
|
---|
| 59 | this(text, icon, tooltipText, helpTopic, true);
|
---|
| 60 | }
|
---|
[2512] | 61 |
|
---|
| 62 | /**
|
---|
[5951] | 63 | * Constructs a new {@code ButtonSpec}.
|
---|
| 64 | * @param text the button text
|
---|
| 65 | * @param icon the icon to display. Can be null
|
---|
| 66 | * @param tooltipText the tooltip text. Can be null.
|
---|
[2512] | 67 | * @param helpTopic the help topic. Can be null.
|
---|
[5951] | 68 | * @param enabled the enabled status
|
---|
| 69 | * @since 5951
|
---|
[2512] | 70 | */
|
---|
[5951] | 71 | public ButtonSpec(String text, Icon icon, String tooltipText, String helpTopic, boolean enabled) {
|
---|
[2512] | 72 | this.text = text;
|
---|
| 73 | this.icon = icon;
|
---|
| 74 | this.tooltipText = tooltipText;
|
---|
| 75 | this.helpTopic = helpTopic;
|
---|
[6051] | 76 | setEnabled(enabled);
|
---|
[2512] | 77 | }
|
---|
[6070] | 78 |
|
---|
[6051] | 79 | /**
|
---|
| 80 | * Determines if this button spec is enabled
|
---|
| 81 | * @return {@code true} if this button spec is enabled, {@code false} otherwise
|
---|
| 82 | * @since 6051
|
---|
| 83 | */
|
---|
| 84 | public final boolean isEnabled() {
|
---|
| 85 | return enabled;
|
---|
| 86 | }
|
---|
[6070] | 87 |
|
---|
[6051] | 88 | /**
|
---|
| 89 | * Enables or disables this button spec, depending on the value of the parameter {@code b}.
|
---|
| 90 | * @param enabled if {@code true}, this button spec is enabled; otherwise this button spec is disabled
|
---|
| 91 | * @since 6051
|
---|
| 92 | */
|
---|
| 93 | public final void setEnabled(boolean enabled) {
|
---|
| 94 | if (this.enabled != enabled) {
|
---|
| 95 | this.enabled = enabled;
|
---|
| 96 | ChangeEvent event = new ChangeEvent(this);
|
---|
| 97 | for (ChangeListener listener : listeners) {
|
---|
| 98 | listener.stateChanged(event);
|
---|
| 99 | }
|
---|
| 100 | }
|
---|
| 101 | }
|
---|
[6070] | 102 |
|
---|
[8512] | 103 | private boolean addChangeListener(ChangeListener listener) {
|
---|
[9074] | 104 | return listener != null && listeners.add(listener);
|
---|
[6051] | 105 | }
|
---|
[2512] | 106 | }
|
---|
| 107 |
|
---|
[6889] | 108 | private static class DefaultAction extends AbstractAction {
|
---|
[9078] | 109 | private final JDialog dialog;
|
---|
| 110 | private final JOptionPane pane;
|
---|
| 111 | private final int value;
|
---|
[2512] | 112 |
|
---|
[8836] | 113 | DefaultAction(JDialog dialog, JOptionPane pane, int value) {
|
---|
[2512] | 114 | this.dialog = dialog;
|
---|
| 115 | this.pane = pane;
|
---|
| 116 | this.value = value;
|
---|
| 117 | }
|
---|
| 118 |
|
---|
[6084] | 119 | @Override
|
---|
[2512] | 120 | public void actionPerformed(ActionEvent e) {
|
---|
| 121 | pane.setValue(value);
|
---|
| 122 | dialog.setVisible(false);
|
---|
| 123 | }
|
---|
| 124 | }
|
---|
| 125 |
|
---|
| 126 | /**
|
---|
| 127 | * Creates the list buttons to be displayed in the option pane dialog.
|
---|
| 128 | *
|
---|
| 129 | * @param options the option. If null, just creates an OK button and a help button
|
---|
| 130 | * @param helpTopic the help topic. The context sensitive help of all buttons is equal
|
---|
| 131 | * to the context sensitive help of the whole dialog
|
---|
| 132 | * @return the list of buttons
|
---|
| 133 | */
|
---|
[6889] | 134 | private static List<JButton> createOptionButtons(ButtonSpec[] options, String helpTopic) {
|
---|
[7005] | 135 | List<JButton> buttons = new ArrayList<>();
|
---|
[2512] | 136 | if (options == null) {
|
---|
| 137 | JButton b = new JButton(tr("OK"));
|
---|
| 138 | b.setIcon(ImageProvider.get("ok"));
|
---|
| 139 | b.setToolTipText(tr("Click to close the dialog"));
|
---|
| 140 | b.setFocusable(true);
|
---|
| 141 | buttons.add(b);
|
---|
| 142 | } else {
|
---|
[6051] | 143 | for (final ButtonSpec spec: options) {
|
---|
| 144 | final JButton b = new JButton(spec.text);
|
---|
[2512] | 145 | b.setIcon(spec.icon);
|
---|
[8510] | 146 | b.setToolTipText(spec.tooltipText == null ? "" : spec.tooltipText);
|
---|
[2512] | 147 | if (helpTopic != null) {
|
---|
| 148 | HelpUtil.setHelpContext(b, helpTopic);
|
---|
| 149 | }
|
---|
| 150 | b.setFocusable(true);
|
---|
[6051] | 151 | b.setEnabled(spec.isEnabled());
|
---|
| 152 | spec.addChangeListener(new ChangeListener() {
|
---|
| 153 | @Override public void stateChanged(ChangeEvent e) {
|
---|
| 154 | b.setEnabled(spec.isEnabled());
|
---|
| 155 | }
|
---|
| 156 | });
|
---|
[2512] | 157 | buttons.add(b);
|
---|
| 158 | }
|
---|
| 159 | }
|
---|
| 160 | return buttons;
|
---|
| 161 | }
|
---|
| 162 |
|
---|
| 163 | /**
|
---|
| 164 | * Creates the help button
|
---|
| 165 | *
|
---|
| 166 | * @param helpTopic the help topic
|
---|
| 167 | * @return the help button
|
---|
| 168 | */
|
---|
[6889] | 169 | private static JButton createHelpButton(final String helpTopic) {
|
---|
[2512] | 170 | JButton b = new JButton(tr("Help"));
|
---|
| 171 | b.setIcon(ImageProvider.get("help"));
|
---|
| 172 | b.setToolTipText(tr("Show help information"));
|
---|
| 173 | HelpUtil.setHelpContext(b, helpTopic);
|
---|
| 174 | Action a = new AbstractAction() {
|
---|
[6084] | 175 | @Override
|
---|
[2512] | 176 | public void actionPerformed(ActionEvent e) {
|
---|
[2715] | 177 | HelpBrowser.setUrlForHelpTopic(helpTopic);
|
---|
[2512] | 178 | }
|
---|
| 179 | };
|
---|
| 180 | b.addActionListener(a);
|
---|
[5200] | 181 | InputMapUtils.enableEnter(b);
|
---|
[2512] | 182 | return b;
|
---|
| 183 | }
|
---|
| 184 |
|
---|
| 185 | /**
|
---|
| 186 | * Displays an option dialog which is aware of a help context. If <code>helpTopic</code> isn't null,
|
---|
| 187 | * the dialog includes a "Help" button and launches the help browser if the user presses F1. If the
|
---|
| 188 | * user clicks on the "Help" button the option dialog remains open and JOSM launches the help
|
---|
| 189 | * browser.
|
---|
| 190 | *
|
---|
| 191 | * <code>helpTopic</code> is the trailing part of a JOSM online help URL, i.e. the part after the leading
|
---|
[6920] | 192 | * <code>https://josm.openstreetmap.de/wiki/Help</code>. It should start with a leading '/' and it
|
---|
[2512] | 193 | * may include an anchor after a '#'.
|
---|
| 194 | *
|
---|
| 195 | * <strong>Examples</strong>
|
---|
| 196 | * <ul>
|
---|
| 197 | * <li>/Dialogs/RelationEditor</li>
|
---|
| 198 | * <li>/Dialogs/RelationEditor#ConflictInData</li>
|
---|
| 199 | * </ul>
|
---|
| 200 | *
|
---|
| 201 | * In addition, the option buttons display JOSM icons, similar to ExtendedDialog.
|
---|
| 202 | *
|
---|
| 203 | * @param parentComponent the parent component
|
---|
| 204 | * @param msg the message
|
---|
| 205 | * @param title the title
|
---|
[5266] | 206 | * @param messageType the message type (see {@link JOptionPane})
|
---|
[2512] | 207 | * @param icon the icon to display. Can be null.
|
---|
| 208 | * @param options the list of options to display. Can be null.
|
---|
| 209 | * @param defaultOption the default option. Can be null.
|
---|
| 210 | * @param helpTopic the help topic. Can be null.
|
---|
| 211 | * @return the index of the selected option or {@link JOptionPane#CLOSED_OPTION}
|
---|
| 212 | */
|
---|
[7466] | 213 | public static int showOptionDialog(Component parentComponent, Object msg, String title, int messageType,
|
---|
| 214 | Icon icon, final ButtonSpec[] options, final ButtonSpec defaultOption, final String helpTopic) {
|
---|
[2512] | 215 | final List<JButton> buttons = createOptionButtons(options, helpTopic);
|
---|
| 216 | if (helpTopic != null) {
|
---|
| 217 | buttons.add(createHelpButton(helpTopic));
|
---|
| 218 | }
|
---|
| 219 |
|
---|
| 220 | JButton defaultButton = null;
|
---|
| 221 | if (options != null && defaultOption != null) {
|
---|
[8510] | 222 | for (int i = 0; i < options.length; i++) {
|
---|
[2512] | 223 | if (options[i] == defaultOption) {
|
---|
| 224 | defaultButton = buttons.get(i);
|
---|
| 225 | break;
|
---|
| 226 | }
|
---|
| 227 | }
|
---|
| 228 | }
|
---|
| 229 |
|
---|
| 230 | if (msg instanceof String) {
|
---|
[5886] | 231 | JosmEditorPane pane = new JosmEditorPane("text/html", (String) msg);
|
---|
[4816] | 232 | pane.setEditable(false);
|
---|
| 233 | pane.setOpaque(false);
|
---|
| 234 | msg = pane;
|
---|
[2512] | 235 | }
|
---|
| 236 |
|
---|
| 237 | final JOptionPane pane = new JOptionPane(
|
---|
| 238 | msg,
|
---|
| 239 | messageType,
|
---|
| 240 | JOptionPane.DEFAULT_OPTION,
|
---|
| 241 | icon,
|
---|
| 242 | buttons.toArray(),
|
---|
| 243 | defaultButton
|
---|
| 244 | );
|
---|
| 245 |
|
---|
| 246 | final JDialog dialog = new JDialog(
|
---|
| 247 | JOptionPane.getFrameForComponent(parentComponent),
|
---|
| 248 | title,
|
---|
[3501] | 249 | ModalityType.DOCUMENT_MODAL
|
---|
[2512] | 250 | );
|
---|
| 251 | dialog.setContentPane(pane);
|
---|
[3501] | 252 | dialog.addWindowListener(new WindowAdapter() {
|
---|
| 253 | @Override
|
---|
| 254 | public void windowClosing(WindowEvent e) {
|
---|
| 255 | pane.setValue(JOptionPane.CLOSED_OPTION);
|
---|
| 256 | super.windowClosed(e);
|
---|
| 257 | }
|
---|
[2512] | 258 |
|
---|
[3501] | 259 | @Override
|
---|
| 260 | public void windowOpened(WindowEvent e) {
|
---|
| 261 | if (defaultOption != null && options != null && options.length > 0) {
|
---|
| 262 | int i;
|
---|
[8510] | 263 | for (i = 0; i < options.length; i++) {
|
---|
[3501] | 264 | if (options[i] == defaultOption) {
|
---|
| 265 | break;
|
---|
[2512] | 266 | }
|
---|
| 267 | }
|
---|
[3501] | 268 | if (i >= options.length) {
|
---|
| 269 | buttons.get(0).requestFocusInWindow();
|
---|
| 270 | }
|
---|
| 271 | buttons.get(i).requestFocusInWindow();
|
---|
| 272 | } else {
|
---|
| 273 | buttons.get(0).requestFocusInWindow();
|
---|
[2512] | 274 | }
|
---|
[3501] | 275 | }
|
---|
| 276 | });
|
---|
[8510] | 277 | dialog.getRootPane().getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(
|
---|
| 278 | KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), "close");
|
---|
[2512] | 279 | dialog.getRootPane().getActionMap().put("close", new AbstractAction() {
|
---|
[6084] | 280 | @Override
|
---|
[2512] | 281 | public void actionPerformed(ActionEvent e) {
|
---|
| 282 | pane.setValue(JOptionPane.CLOSED_OPTION);
|
---|
| 283 | dialog.setVisible(false);
|
---|
[9059] | 284 | }
|
---|
| 285 | });
|
---|
[2512] | 286 |
|
---|
| 287 | if (options != null) {
|
---|
[8510] | 288 | for (int i = 0; i < options.length; i++) {
|
---|
[2512] | 289 | final DefaultAction action = new DefaultAction(dialog, pane, i);
|
---|
| 290 | buttons.get(i).addActionListener(action);
|
---|
[8510] | 291 | buttons.get(i).getInputMap(JComponent.WHEN_FOCUSED).put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0), "enter");
|
---|
[2512] | 292 | buttons.get(i).getActionMap().put("enter", action);
|
---|
| 293 | }
|
---|
| 294 | } else {
|
---|
| 295 | final DefaultAction action = new DefaultAction(dialog, pane, 0);
|
---|
| 296 | buttons.get(0).addActionListener(action);
|
---|
[8510] | 297 | buttons.get(0).getInputMap(JComponent.WHEN_FOCUSED).put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0), "enter");
|
---|
[2512] | 298 | buttons.get(0).getActionMap().put("enter", action);
|
---|
| 299 | }
|
---|
| 300 |
|
---|
| 301 | dialog.pack();
|
---|
| 302 | WindowGeometry.centerOnScreen(dialog.getSize()).applySafe(dialog);
|
---|
| 303 | if (helpTopic != null) {
|
---|
| 304 | HelpUtil.setHelpContext(dialog.getRootPane(), helpTopic);
|
---|
| 305 | }
|
---|
| 306 | dialog.setVisible(true);
|
---|
[8510] | 307 | return (Integer) pane.getValue();
|
---|
[2512] | 308 | }
|
---|
| 309 |
|
---|
| 310 | /**
|
---|
[5909] | 311 | * Displays an option dialog which is aware of a help context.
|
---|
[2512] | 312 | *
|
---|
[5909] | 313 | * @param parentComponent the parent component
|
---|
| 314 | * @param msg the message
|
---|
| 315 | * @param title the title
|
---|
| 316 | * @param messageType the message type (see {@link JOptionPane})
|
---|
| 317 | * @param helpTopic the help topic. Can be null.
|
---|
| 318 | * @return the index of the selected option or {@link JOptionPane#CLOSED_OPTION}
|
---|
[2512] | 319 | * @see #showOptionDialog(Component, Object, String, int, Icon, ButtonSpec[], ButtonSpec, String)
|
---|
| 320 | */
|
---|
[7466] | 321 | public static int showOptionDialog(Component parentComponent, Object msg, String title, int messageType, String helpTopic) {
|
---|
| 322 | return showOptionDialog(parentComponent, msg, title, messageType, null, null, null, helpTopic);
|
---|
[2512] | 323 | }
|
---|
[3501] | 324 |
|
---|
| 325 | /**
|
---|
| 326 | * Run it in Event Dispatch Thread.
|
---|
[7466] | 327 | * This version does not return anything, so it is more like {@code showMessageDialog}.
|
---|
[3501] | 328 | *
|
---|
| 329 | * It can be used, when you need to show a message dialog from a worker thread,
|
---|
[7466] | 330 | * e.g. from {@code PleaseWaitRunnable}.
|
---|
| 331 | *
|
---|
| 332 | * @param parentComponent the parent component
|
---|
| 333 | * @param msg the message
|
---|
| 334 | * @param title the title
|
---|
| 335 | * @param messageType the message type (see {@link JOptionPane})
|
---|
| 336 | * @param helpTopic the help topic. Can be null.
|
---|
[3501] | 337 | */
|
---|
[8509] | 338 | public static void showMessageDialogInEDT(final Component parentComponent, final Object msg, final String title,
|
---|
| 339 | final int messageType, final String helpTopic) {
|
---|
[6040] | 340 | GuiHelper.runInEDT(new Runnable() {
|
---|
[6084] | 341 | @Override
|
---|
[3501] | 342 | public void run() {
|
---|
| 343 | showOptionDialog(parentComponent, msg, title, messageType, null, null, null, helpTopic);
|
---|
| 344 | }
|
---|
| 345 | });
|
---|
| 346 | }
|
---|
[2512] | 347 | }
|
---|