source: josm/trunk/src/org/openstreetmap/josm/gui/HelpAwareOptionPane.java@ 7447

Last change on this file since 7447 was 7005, checked in by Don-vip, 10 years ago

see #8465 - use diamond operator where applicable
  • Property svn:eol-style set to native
File size: 12.8 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5
6import java.awt.Component;
7import java.awt.Dialog.ModalityType;
8import java.awt.event.ActionEvent;
9import java.awt.event.KeyEvent;
10import java.awt.event.WindowAdapter;
11import java.awt.event.WindowEvent;
12import java.util.ArrayList;
13import java.util.Collection;
14import java.util.HashSet;
15import java.util.List;
16
17import javax.swing.AbstractAction;
18import javax.swing.Action;
19import javax.swing.Icon;
20import javax.swing.JButton;
21import javax.swing.JComponent;
22import javax.swing.JDialog;
23import javax.swing.JOptionPane;
24import javax.swing.KeyStroke;
25import javax.swing.event.ChangeEvent;
26import javax.swing.event.ChangeListener;
27
28import org.openstreetmap.josm.gui.help.HelpBrowser;
29import org.openstreetmap.josm.gui.help.HelpUtil;
30import org.openstreetmap.josm.gui.util.GuiHelper;
31import org.openstreetmap.josm.gui.widgets.JosmEditorPane;
32import org.openstreetmap.josm.tools.ImageProvider;
33import org.openstreetmap.josm.tools.InputMapUtils;
34import org.openstreetmap.josm.tools.WindowGeometry;
35
36public final class HelpAwareOptionPane {
37
38 private HelpAwareOptionPane() {
39 // Hide default constructor for utils classes
40 }
41
42 public static class ButtonSpec {
43 public final String text;
44 public final Icon icon;
45 public final String tooltipText;
46 public final String helpTopic;
47 private boolean enabled;
48
49 private final Collection<ChangeListener> listeners = new HashSet<>();
50
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 }
61
62 /**
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.
67 * @param helpTopic the help topic. Can be null.
68 * @param enabled the enabled status
69 * @since 5951
70 */
71 public ButtonSpec(String text, Icon icon, String tooltipText, String helpTopic, boolean enabled) {
72 this.text = text;
73 this.icon = icon;
74 this.tooltipText = tooltipText;
75 this.helpTopic = helpTopic;
76 setEnabled(enabled);
77 }
78
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 }
87
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 }
102
103 private final boolean addChangeListener(ChangeListener listener) {
104 return listener != null ? listeners.add(listener) : false;
105 }
106 }
107
108 private static class DefaultAction extends AbstractAction {
109 private JDialog dialog;
110 private JOptionPane pane;
111 private int value;
112
113 public DefaultAction(JDialog dialog, JOptionPane pane, int value) {
114 this.dialog = dialog;
115 this.pane = pane;
116 this.value = value;
117 }
118
119 @Override
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 */
134 private static List<JButton> createOptionButtons(ButtonSpec[] options, String helpTopic) {
135 List<JButton> buttons = new ArrayList<>();
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 {
143 for (final ButtonSpec spec: options) {
144 final JButton b = new JButton(spec.text);
145 b.setIcon(spec.icon);
146 b.setToolTipText(spec.tooltipText == null? "" : spec.tooltipText);
147 if (helpTopic != null) {
148 HelpUtil.setHelpContext(b, helpTopic);
149 }
150 b.setFocusable(true);
151 b.setEnabled(spec.isEnabled());
152 spec.addChangeListener(new ChangeListener() {
153 @Override public void stateChanged(ChangeEvent e) {
154 b.setEnabled(spec.isEnabled());
155 }
156 });
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 */
169 private static JButton createHelpButton(final String helpTopic) {
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() {
175 @Override
176 public void actionPerformed(ActionEvent e) {
177 HelpBrowser.setUrlForHelpTopic(helpTopic);
178 }
179 };
180 b.addActionListener(a);
181 InputMapUtils.enableEnter(b);
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
192 * <code>https://josm.openstreetmap.de/wiki/Help</code>. It should start with a leading '/' and it
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
206 * @param messageType the message type (see {@link JOptionPane})
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 */
213 public static int showOptionDialog(Component parentComponent, Object msg, String title, int messageType, Icon icon, final ButtonSpec[] options, final ButtonSpec defaultOption, final String helpTopic) {
214 final List<JButton> buttons = createOptionButtons(options, helpTopic);
215 if (helpTopic != null) {
216 buttons.add(createHelpButton(helpTopic));
217 }
218
219 JButton defaultButton = null;
220 if (options != null && defaultOption != null) {
221 for (int i=0; i< options.length; i++) {
222 if (options[i] == defaultOption) {
223 defaultButton = buttons.get(i);
224 break;
225 }
226 }
227 }
228
229 if (msg instanceof String) {
230 JosmEditorPane pane = new JosmEditorPane("text/html", (String) msg);
231 pane.setEditable(false);
232 pane.setOpaque(false);
233 msg = pane;
234 }
235
236 final JOptionPane pane = new JOptionPane(
237 msg,
238 messageType,
239 JOptionPane.DEFAULT_OPTION,
240 icon,
241 buttons.toArray(),
242 defaultButton
243 );
244
245 pane.getValue();
246 final JDialog dialog = new JDialog(
247 JOptionPane.getFrameForComponent(parentComponent),
248 title,
249 ModalityType.DOCUMENT_MODAL
250 );
251 dialog.setContentPane(pane);
252 dialog.addWindowListener(new WindowAdapter() {
253 @Override
254 public void windowClosing(WindowEvent e) {
255 pane.setValue(JOptionPane.CLOSED_OPTION);
256 super.windowClosed(e);
257 }
258
259 @Override
260 public void windowOpened(WindowEvent e) {
261 if (defaultOption != null && options != null && options.length > 0) {
262 int i;
263 for (i=0; i<options.length;i++) {
264 if (options[i] == defaultOption) {
265 break;
266 }
267 }
268 if (i >= options.length) {
269 buttons.get(0).requestFocusInWindow();
270 }
271 buttons.get(i).requestFocusInWindow();
272 } else {
273 buttons.get(0).requestFocusInWindow();
274 }
275 }
276 });
277 dialog.getRootPane().getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE,0), "close");
278 dialog.getRootPane().getActionMap().put("close", new AbstractAction() {
279 @Override
280 public void actionPerformed(ActionEvent e) {
281 pane.setValue(JOptionPane.CLOSED_OPTION);
282 dialog.setVisible(false);
283 }}
284 );
285
286 if (options != null) {
287 for (int i=0; i < options.length;i++) {
288 final DefaultAction action = new DefaultAction(dialog, pane, i);
289 buttons.get(i).addActionListener(action);
290 buttons.get(i).getInputMap(JComponent.WHEN_FOCUSED).put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,0), "enter");
291 buttons.get(i).getActionMap().put("enter", action);
292 }
293 } else {
294 final DefaultAction action = new DefaultAction(dialog, pane, 0);
295 buttons.get(0).addActionListener(action);
296 buttons.get(0).getInputMap(JComponent.WHEN_FOCUSED).put(KeyStroke.getKeyStroke(KeyEvent.VK_ENTER,0), "enter");
297 buttons.get(0).getActionMap().put("enter", action);
298 }
299
300 dialog.pack();
301 WindowGeometry.centerOnScreen(dialog.getSize()).applySafe(dialog);
302 if (helpTopic != null) {
303 HelpUtil.setHelpContext(dialog.getRootPane(), helpTopic);
304 }
305 dialog.setVisible(true);
306 return (Integer)pane.getValue();
307 }
308
309 /**
310 * Displays an option dialog which is aware of a help context.
311 *
312 * @param parentComponent the parent component
313 * @param msg the message
314 * @param title the title
315 * @param messageType the message type (see {@link JOptionPane})
316 * @param helpTopic the help topic. Can be null.
317 * @return the index of the selected option or {@link JOptionPane#CLOSED_OPTION}
318 * @see #showOptionDialog(Component, Object, String, int, Icon, ButtonSpec[], ButtonSpec, String)
319 */
320 public static int showOptionDialog(Component parentComponent, Object msg, String title, int messageType,final String helpTopic) {
321 return showOptionDialog(parentComponent, msg, title, messageType, null,null,null, helpTopic);
322 }
323
324 /**
325 * Run it in Event Dispatch Thread.
326 * This version does not return anything, so it is more like showMessageDialog.
327 *
328 * It can be used, when you need to show a message dialog from a worker thread,
329 * e.g. from PleaseWaitRunnable
330 */
331 public static void showMessageDialogInEDT(final Component parentComponent, final Object msg, final String title, final int messageType, final String helpTopic) {
332 GuiHelper.runInEDT(new Runnable() {
333 @Override
334 public void run() {
335 showOptionDialog(parentComponent, msg, title, messageType, null, null, null, helpTopic);
336 }
337 });
338 }
339}
Note: See TracBrowser for help on using the repository browser.