Changeset 2285 in josm for trunk/src/org/openstreetmap/josm/gui/ExtendedDialog.java

Timestamp:

2009-10-13T20:34:11+02:00 (15 years ago)

Author:

Gubaer

Message:

Improved Download Location Dialog and created ​help page.
ExtendedDialog now supports context sensitive help including a help button.
ExtendedDialog now supports tooltip texts for buttons in the button row.

File:

• trunk/src/org/openstreetmap/josm/gui/ExtendedDialog.java (modified) (6 diffs)

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

@@ -23 +23 @@
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.gui.help.HelpBrowserProxy;
+import org.openstreetmap.josm.gui.help.HelpBuilder;
 import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.ImageProvider;
@@ -41 +43 @@
     private Component content;
     private final String[] bTexts;
+    private String[] bToolTipTexts;
     private String[] bIcons;
+
+    /** true, if the dialog should include a help button */
+    private boolean showHelpButton;
+    /** the help topic */
+    private String helpTopic;
+
     /**
      * set to true if the content of the extended dialog should
@@ -99 +108 @@
 
     /**
+     * Allows decorating the buttons with tooltips. Expects an String[] with translated
+     * tooltip texts.
+     * 
+     * @param toolTipTexts the tool tip texts. Ignored, if null.
+     */
+    public void setToolTipTexts(String[] toolTipTexts) {
+        this.bToolTipTexts = toolTipTexts;
+    }
+
+    /**
      * Sets the content that will be displayed in the message dialog.
      * 
@@ -187 +206 @@
                 button.setIcon(ImageProvider.get(bIcons[i]));
             }
+            if (bToolTipTexts != null && i < bToolTipTexts.length && bToolTipTexts[i] != null) {
+                button.setToolTipText(bToolTipTexts[i]);
+            }
 
             if(i == 0) {
@@ -193 +215 @@
             buttonsPanel.add(button, GBC.std().insets(2,2,2,2));
             buttons.add(button);
+        }
+        if (showHelpButton) {
+            buttonsPanel.add(new JButton(new HelpAction()), GBC.std().insets(2,2,2,2));
+            HelpBuilder.setHelpContext(getRootPane(),helpTopic);
         }
 
@@ -396 +422 @@
         return lbl;
     }
+
+    /**
+     * Configures how this dialog support for context sensitive help.
+     * <ul>
+     *  <li>if helpTopic is null, the dialog doesn't provide context sensitive help</li>
+     *  <li>if helpTopic != null, the dialog redirect user to the help page for this helpTopic when
+     *  the user clicks F1 in the dialog</li>
+     *  <li>if showHelpButton is true, the dialog displays "Help" button (rightmost button in
+     *  the button row)</li>
+     * </ul>
+     * 
+     * @param helpTopic the help topic
+     * @param showHelpButton true, if the dialog displays a help button
+     */
+    public void configureContextsensitiveHelp(String helpTopic, boolean showHelpButton) {
+        this.helpTopic = helpTopic;
+        this.showHelpButton = showHelpButton;
+    }
+
+
+    class HelpAction extends AbstractAction {
+        public HelpAction() {
+            putValue(SHORT_DESCRIPTION, tr("Show help information"));
+            putValue(NAME, tr("Help"));
+            putValue(SMALL_ICON, ImageProvider.get("help"));
+        }
+
+        public void actionPerformed(ActionEvent e) {
+            HelpBrowserProxy.getInstance().setUrlForHelpTopic(helpTopic);
+        }
+    }
 }