Changeset 6131 in josm for trunk/src

Timestamp:

2013-08-10T14:34:47+02:00 (11 years ago)

Author:

bastiK

Message:

see #6963 - optional help button for notifications; use notifications in Simplify Way action

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/SimplifyWayAction.java (modified) (2 diffs)
• gui/Notification.java (modified) (6 diffs)
• gui/NotificationManager.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/actions/SimplifyWayAction.java

@@ -28 +28 @@
 import org.openstreetmap.josm.gui.HelpAwareOptionPane;
 import org.openstreetmap.josm.gui.HelpAwareOptionPane.ButtonSpec;
+import org.openstreetmap.josm.gui.Notification;
 import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -45 +46 @@
 
     protected void alertSelectAtLeastOneWay() {
-        HelpAwareOptionPane.showOptionDialog(
-                Main.parent,
-                tr("Please select at least one way to simplify."),
-                tr("Warning"),
-                JOptionPane.WARNING_MESSAGE,
-                HelpUtil.ht("/Action/SimplifyWay#SelectAWayToSimplify")
-                );
+        new Notification(
+                tr("Please select at least one way to simplify."))
+                .setIcon(JOptionPane.WARNING_MESSAGE)
+                .setDuration(Notification.TIME_SHORT)
+                .setHelpTopic(HelpUtil.ht("/Action/SimplifyWay#SelectAWayToSimplify"))
+                .show();
     }
 

trunk/src/org/openstreetmap/josm/gui/Notification.java

@@ -22 +22 @@
  * <pre>
  *      Notification note = new Notification("Hi there!");
- *      note.setDuration(4000); // optional
  *      note.setIcon(JOptionPane.INFORMATION_MESSAGE); // optional
+ *      note.setDuration(Notification.TIME_SHORT); // optional
  *      note.show();
  * </pre>
@@ -52 +52 @@
     public final static int TIME_VERY_LONG = Main.pref.getInteger("notification-time-very_long-ms", 20000);
 
+    private Component content;
+    private int duration;
     private Icon icon;
-    private int duration;
-    private Component content;
+    private String helpTopic;
 
     public Notification() {
@@ -81 +82 @@
      * Set the notification text. (Convenience method)
      *
-     * @param msg the message String
+     * @param msg the message String. Will be wrapped in &lt;html&gt;, so
+     * you can use &lt;br&gt; and other markup directly.
      *
      * @see #Notification(java.lang.String)
@@ -97 +99 @@
      *
      * @param duration the time (in milliseconds)
+     * Preset values {@link #TIME_SHORT}, {@link #TIME_DEFAULT}, {@link #TIME_LONG}
+     * and {@link #TIME_VERY_LONG} can be used.
      * @return the current Object, for convenience
      */
@@ -141 +145 @@
     }
 
+    /**
+     * Display a help button at the bottom of the notification window.
+     * @param helpTopic the help topic
+     * @return the current Object, for convenience
+     */
+    public Notification setHelpTopic(String helpTopic) {
+        this.helpTopic = helpTopic;
+        return this;
+    }
+
     public Component getContent() {
         return content;
@@ -153 +167 @@
     }
 
+    public String getHelpTopic() {
+        return helpTopic;
+    }
+
     /**
      * Display the notification.

trunk/src/org/openstreetmap/josm/gui/NotificationManager.java

@@ -1 +1 @@
 // License: GPL. For details, see LICENSE file.
 package org.openstreetmap.josm.gui;
+
+import static org.openstreetmap.josm.tools.I18n.tr;
 
 import java.awt.BasicStroke;
@@ -23 +25 @@
 
 import javax.swing.AbstractAction;
+import javax.swing.Action;
 import javax.swing.BorderFactory;
 import javax.swing.GroupLayout;
@@ -35 +38 @@
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.gui.help.HelpBrowser;
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.tools.ImageProvider;
 
@@ -187 +192 @@
         }
 
-        private void build(Notification note) {
-            JButton close = new JButton(new HideAction());
-            close.setPreferredSize(new Dimension(50, 50));
+        private void build(final Notification note) {
+            JButton btnClose = new JButton(new HideAction());
+            btnClose.setPreferredSize(new Dimension(50, 50));
+            btnClose.setMargin(new Insets(0, 0, 1, 1));
+            btnClose.setContentAreaFilled(false);
+            // put it in JToolBar to get a better appearance
             JToolBar tbClose = new JToolBar();
-            close.setMargin(new Insets(0, 0, 1, 1));
-            close.setContentAreaFilled(false);
-
             tbClose.setFloatable(false);
             tbClose.setBorderPainted(false);
             tbClose.setOpaque(false);
-            tbClose.add(close);
+            tbClose.add(btnClose);
+
+            JToolBar tbHelp = null;
+            if (note.getHelpTopic() != null) {
+                JButton btnHelp = new JButton(tr("Help"));
+                btnHelp.setIcon(ImageProvider.get("help"));
+                btnHelp.setToolTipText(tr("Show help information"));
+                HelpUtil.setHelpContext(btnHelp, note.getHelpTopic());
+                btnHelp.addActionListener(new AbstractAction() {
+                    @Override
+                    public void actionPerformed(ActionEvent e) {
+                        SwingUtilities.invokeLater(new Runnable() {
+                            @Override
+                            public void run() {
+                                HelpBrowser.setUrlForHelpTopic(note.getHelpTopic());
+                            }
+                        });
+                    }
+                });
+                btnHelp.setOpaque(false);
+                tbHelp = new JToolBar();
+                tbHelp.setFloatable(false);
+                tbHelp.setBorderPainted(false);
+                tbHelp.setOpaque(false);
+                tbHelp.add(btnHelp);
+            }
 
             setOpaque(false);
@@ -221 +251 @@
                 hgroup.addComponent(icon);
             }
-            hgroup.addComponent(content).addComponent(tbClose);
+            if (tbHelp != null) {
+                hgroup.addGroup(layout.createParallelGroup(GroupLayout.Alignment.TRAILING)
+                        .addComponent(content)
+                        .addComponent(tbHelp)
+                );
+            } else {
+                hgroup.addComponent(content);
+            }
+            hgroup.addComponent(tbClose);
             GroupLayout.ParallelGroup vgroup = layout.createParallelGroup();
             if (icon != null) {
                 vgroup.addComponent(icon);
             }
-            vgroup.addComponent(content).addComponent(tbClose);
+            vgroup.addComponent(content);
+            vgroup.addComponent(tbClose);
             layout.setHorizontalGroup(hgroup);
-            layout.setVerticalGroup(vgroup);
+
+            if (tbHelp != null) {
+                layout.setVerticalGroup(layout.createSequentialGroup()
+                        .addGroup(vgroup)
+                        .addComponent(tbHelp)
+                );
+            } else {
+                layout.setVerticalGroup(vgroup);
+            }
 
             /*