Changes between Version 1 and Version 2 of DevelopersGuide/HelpSystem

Timestamp:

2009-11-08T16:56:29+01:00 (16 years ago)

Author:

Gubaer

Comment:

--

DevelopersGuide/HelpSystem

@@ -1 +1 @@
 = Context-sensitive help =
+[[TOC(inline)]]
 
 == Help content ==
@@ -21 +22 @@
     * {{{/Dialog/LayerDialog}}} - help topic for the help content about the layer dialog
 
+
+
 == Enabling context-sensitive help ==
 === Declaring help topics ===
@@ -27 +30 @@
 Always use the marker method [source:/trunk/src/org/openstreetmap/josm/gui/help/HelpUtil.java ht("...")] to declare a help topic. {{{ht}}} just replies the relative help topic. It's purpose is only to make explicit which string constants are used as help topics. There are scripts which harvest these help topics from the JOSM source and create a [wiki:/DevelopersGuide/HelpSystem/HelpTopicsList cross-references].
 
-=== Adding a help button to an UI ===
+=== Adding a help button to an UI widget ===
 You can easily add a help button to a GUI element. The easiest way is to reuse [source:/trunk/src/org/openstreetmap/josm/gui/help/ContextSensitiveHelpAction ContextSensitiveHelpAction]:
 {{{
@@ -71 +74 @@
 
 At run-time, JOSM walks up the ui component tree and redirects the user to the first, i.e. the most specific help topic it finds along this way.
+
+=== Context-sensitive help for an action ===
+You can easily configure context-sensitive help for an action. If you later add the action to a button or a menu item, both the button or the menu item will redirect the user to the declared help topic if he presses F1.
+
+{{{
+#!java
+import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
+
+// Example: a custom action with a declared help topic 
+// 
+class MyAction extends AbstractAction {
+   public MyAction() {
+      putValue("help", ht("/Action/MyAction"));  // configure help topic for the action 
+   }
+
+   public void actionPerformed(ActionEvent evt) {
+     // tbd
+   }
+}
+
+// btn will respond to F1. Help topic is /Action/MyAction 
+//
+JButton btn = nwe JButton(new MyAction());
+}}}
+
 
 === Context-sensitive help for the ExtendedDialog ===