Changeset 13431 in josm

Timestamp:

2018-02-17T16:36:12+01:00 (6 years ago)

Author:

Don-vip

Message:

fix #15950 - Preferences Help button should go directly to selected Preferences tab Help page

Location:

trunk/src/org/openstreetmap/josm/gui/preferences

Files:

• DefaultTabPreferenceSetting.java (modified) (2 diffs)
• PreferenceDialog.java (modified) (5 diffs)
• PreferenceTabbedPane.java (modified) (2 diffs)
• TabPreferenceSetting.java (modified) (1 diff)
• ToolbarPreferences.java (modified) (2 diffs)
• advanced/AdvancedPreference.java (modified) (3 diffs)
• audio/AudioPreference.java (modified) (2 diffs)
• display/DisplayPreference.java (modified) (2 diffs)
• imagery/ImageryPreference.java (modified) (2 diffs)
• map/MapPreference.java (modified) (2 diffs)
• plugin/PluginPreference.java (modified) (1 diff)
• remotecontrol/RemoteControlPreference.java (modified) (2 diffs)
• server/ServerAccessPreference.java (modified) (1 diff)
• shortcut/ShortcutPreference.java (modified) (2 diffs)
• validator/ValidatorPreference.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/gui/preferences/DefaultTabPreferenceSetting.java

@@ -10 +10 @@
 import javax.swing.JTabbedPane;
 
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.Logging;
@@ -136 +137 @@
         return subSettingMap != null ? subSettingMap.get(sub) : null;
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Action/Preferences");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceDialog.java

@@ -42 +42 @@
 
     private final PreferenceTabbedPane tpPreferences = new PreferenceTabbedPane();
+    private final ContextSensitiveHelpAction helpAction = new ContextSensitiveHelpAction();
     private boolean canceled;
 
@@ -68 +69 @@
         btns.add(new JButton(new OKAction()));
         btns.add(new JButton(new CancelAction()));
-        btns.add(new JButton(new ContextSensitiveHelpAction(HelpUtil.ht("/Action/Preferences"))));
+        btns.add(new JButton(helpAction));
         pnl.add(expert, GBC.std().insets(5, 0, 0, 0));
         pnl.add(btns, GBC.std().fill(GBC.HORIZONTAL));
@@ -85 +86 @@
 
         InputMapUtils.addEscapeAction(getRootPane(), new CancelAction());
-        HelpUtil.setHelpContext(getRootPane(), HelpUtil.ht("/Action/Preferences"));
+        setHelpContext(HelpUtil.ht("/Action/Preferences"));
+    }
+
+    /**
+     * Sets the help context of the preferences dialog.
+     * @param helpContext new help context
+     * @since 13431
+     */
+    public final void setHelpContext(String helpContext) {
+        helpAction.setHelpTopic(helpContext);
+        HelpUtil.setHelpContext(getRootPane(), helpContext);
     }
 
@@ -97 +108 @@
     }
 
+    /**
+     * Determines if preferences changes have been canceled.
+     * @return {@code true} if preferences changes have been canceled
+     */
     public boolean isCanceled() {
         return canceled;
@@ -109 +124 @@
         if (visible) {
             // Make the pref window at most as large as the parent JOSM window
-            // Have to take window decorations into account or the windows will
-            // be too large
+            // Have to take window decorations into account or the windows will be too large
             Insets i = this.getParent().getInsets();
             Dimension p = this.getParent().getSize();
             p = new Dimension(Math.min(p.width-i.left-i.right, 700),
-                    Math.min(p.height-i.top-i.bottom, 800));
+                              Math.min(p.height-i.top-i.bottom, 800));
             new WindowGeometry(
                     getClass().getName() + ".geometry",

trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceTabbedPane.java

@@ -5 +5 @@
 
 import java.awt.Component;
+import java.awt.Container;
 import java.awt.Font;
 import java.awt.GridBagLayout;
@@ -610 +611 @@
                 }
             }
+            Container ancestor = getTopLevelAncestor();
+            if (ancestor instanceof PreferenceDialog) {
+                ((PreferenceDialog) ancestor).setHelpContext(preferenceSettings.getHelpContext());
+            }
         }
     }

trunk/src/org/openstreetmap/josm/gui/preferences/TabPreferenceSetting.java

@@ -78 +78 @@
      */
     boolean selectSubTab(SubPreferenceSetting subPref);
+
+    /**
+     * Returns the help context for this preferences settings tab.
+     * @return the help context for this preferences settings tab
+     * @since 13431
+     */
+    String getHelpContext();
 }

trunk/src/org/openstreetmap/josm/gui/preferences/ToolbarPreferences.java

@@ -69 +69 @@
 import org.openstreetmap.josm.data.imagery.ImageryLayerInfo;
 import org.openstreetmap.josm.gui.MainApplication;
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.tagging.presets.TaggingPreset;
 import org.openstreetmap.josm.gui.util.GuiHelper;
@@ -993 +994 @@
         }
 
+        @Override
+        public String getHelpContext() {
+            return HelpUtil.ht("/Preferences/Toolbar");
+        }
     }
 

trunk/src/org/openstreetmap/josm/gui/preferences/advanced/AdvancedPreference.java

@@ -40 +40 @@
 import org.openstreetmap.josm.data.Preferences;
 import org.openstreetmap.josm.data.PreferencesUtils;
-import org.openstreetmap.josm.spi.preferences.Setting;
-import org.openstreetmap.josm.spi.preferences.StringSetting;
 import org.openstreetmap.josm.gui.dialogs.LogShowDialog;
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.io.CustomConfigurator;
 import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
@@ -52 +51 @@
 import org.openstreetmap.josm.gui.widgets.JosmTextField;
 import org.openstreetmap.josm.spi.preferences.Config;
+import org.openstreetmap.josm.spi.preferences.Setting;
+import org.openstreetmap.josm.spi.preferences.StringSetting;
 import org.openstreetmap.josm.tools.GBC;
 import org.openstreetmap.josm.tools.Logging;
@@ -463 +464 @@
         return false;
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/Advanced");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/audio/AudioPreference.java

@@ -11 +11 @@
 import javax.swing.JPanel;
 
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
@@ -147 +148 @@
         return false;
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/Audio");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/display/DisplayPreference.java

@@ -6 +6 @@
 import javax.swing.JTabbedPane;
 
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
@@ -42 +43 @@
         gui.createPreferenceTab(this).add(getTabPane(), GBC.eol().fill(GBC.BOTH));
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/Display");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/imagery/ImageryPreference.java

@@ -62 +62 @@
 import org.openstreetmap.josm.gui.MainApplication;
 import org.openstreetmap.josm.gui.download.DownloadDialog;
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
@@ -957 +958 @@
         MainApplication.getMenu().imageryMenu.refreshOffsetMenu();
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/Imagery");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/map/MapPreference.java

@@ -6 +6 @@
 import javax.swing.JTabbedPane;
 
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
@@ -41 +42 @@
         gui.createPreferenceTab(this).add(getTabPane(), GBC.eol().fill(GBC.BOTH));
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/Map");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/plugin/PluginPreference.java

@@ -649 +649 @@
         }
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/Plugins");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/remotecontrol/RemoteControlPreference.java

@@ -28 +28 @@
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
@@ -219 +220 @@
         return false;
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/RemoteControl");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/server/ServerAccessPreference.java

@@ -110 +110 @@
         return false;
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/Connection");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/shortcut/ShortcutPreference.java

@@ -6 +6 @@
 import javax.swing.JPanel;
 
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
@@ -58 +59 @@
         defaultFilter = substring;
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/Shortcuts");
+    }
 }

trunk/src/org/openstreetmap/josm/gui/preferences/validator/ValidatorPreference.java

@@ -6 +6 @@
 import javax.swing.JTabbedPane;
 
+import org.openstreetmap.josm.gui.help.HelpUtil;
 import org.openstreetmap.josm.gui.preferences.DefaultTabPreferenceSetting;
 import org.openstreetmap.josm.gui.preferences.PreferenceSetting;
@@ -44 +45 @@
         return false;
     }
+
+    @Override
+    public String getHelpContext() {
+        return HelpUtil.ht("/Preferences/Validator");
+    }
 }