Changeset 20701 in osm for applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap

Timestamp:

2010-03-27T16:51:44+01:00 (15 years ago)

Author:

guggis

Message:

Added configuration of global shortcut in the preference settings
Fixed a couple of minor issues

Location:

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions

Files:

• CreateOrEditTurnRestrictionAction.java (modified) (3 diffs)
• TurnRestrictionsPlugin.java (modified) (2 diffs)
• editor/TurnRestrictionLegEditor.java (modified) (1 diff)
• list/TurnRestrictionCellRenderer.java (modified) (2 diffs)
• preferences/PreferenceKeys.java (modified) (2 diffs)
• preferences/PreferencesPanel.java (modified) (6 diffs)
• preferences/ShortcutPreferencePanel.java (added)
• qa/IdenticalTurnRestrictionLegsError.java (modified) (1 diff)
• qa/IntersectionMissingAsViaError.java (modified) (1 diff)
• qa/MultipleTurnRestrictionLegError.java (modified) (3 diffs)

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/CreateOrEditTurnRestrictionAction.java

@@ -4 +4 @@
 
 import java.awt.event.ActionEvent;
-import java.awt.event.KeyEvent;
 import java.util.Collection;
 import java.util.logging.Logger;
+
+import javax.swing.ActionMap;
+import javax.swing.InputMap;
+import javax.swing.JComponent;
+import javax.swing.KeyStroke;
 
 import org.openstreetmap.josm.Main;
@@ -15 +19 @@
 import org.openstreetmap.josm.plugins.turnrestrictions.editor.TurnRestrictionEditorManager;
 import org.openstreetmap.josm.plugins.turnrestrictions.editor.TurnRestrictionSelectionPopupPanel;
-import org.openstreetmap.josm.tools.Shortcut;
+import org.openstreetmap.josm.plugins.turnrestrictions.preferences.PreferenceKeys;
 
 /**
@@ -26 +30 @@
 public class CreateOrEditTurnRestrictionAction extends JosmAction {
         static private final Logger logger = Logger.getLogger(CreateOrEditTurnRestrictionAction.class.getName());
-        public CreateOrEditTurnRestrictionAction() {
+        
+        /**
+         * Installs the global key stroke with which creating/editing a turn restriction
+         * is triggered.
+         * 
+         * @param keyStroke the key stroke 
+         */
+        static public void install(KeyStroke keyStroke){
+                InputMap im = Main.contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW);
+                Object actionMapKey = im.get(keyStroke);
+                if (actionMapKey != null && !actionMapKey.toString().equals("turnrestrictions:create-or-edit")) {
+                        System.out.println(tr("Warning: turnrestrictions plugin replaces already existing action ''{0}'' behind shortcut ''{1}'' by action ''{2}''", actionMapKey.toString(), keyStroke.toString(), "turnrestrictions:create-or-edit"));                        
+                }
+                KeyStroke[] keys = im.keys();
+                if (keys != null){
+                        for(KeyStroke ks: im.keys()){
+                                if (im.get(ks).equals("turnrestrictions:create-or-edit")) {
+                                        im.remove(ks);
+                                }
+                        }
+                }
+                im.put(keyStroke, "turnrestrictions:create-or-edit");
+                ActionMap am = Main.contentPane.getActionMap();
+                am.put("turnrestrictions:create-or-edit", getInstance());
+        }
+        
+        /**
+         * Installs  global key stroke configured in the preferences.
+         * 
+         * @param keyStroke the key stroke 
+         */
+        static public void install(){
+                String value = Main.pref.get(PreferenceKeys.EDIT_SHORTCUT, "shift ctrl T");
+                KeyStroke key = KeyStroke.getKeyStroke(value);
+                if (key == null){
+                        System.out.println(tr("Warning: illegal value ''{0}'' for preference key ''{1}''. Falling back to default value ''shift ctrl T''.", value, PreferenceKeys.EDIT_SHORTCUT));
+                        key = KeyStroke.getKeyStroke("shift ctrl T");
+                }
+                install(key);
+        }
+        
+        /** the singleton instance of this action */
+        private static CreateOrEditTurnRestrictionAction instance;
+        
+        /**
+         * Replies the unique instance of this action
+         * 
+         * @return
+         */
+        public static CreateOrEditTurnRestrictionAction getInstance() {
+                if (instance == null){
+                        instance = new CreateOrEditTurnRestrictionAction();
+                }
+                return instance;
+        }
+        
+        protected CreateOrEditTurnRestrictionAction() {
                 super(
                     tr("Create/Edit turn restriction..."),
                     null,
                     tr("Create or edit a turn restriction."),
-                    Shortcut.registerShortcut(
-                                        "turnrestrictions:create-or-edit", 
-                                        tr("Turnrestrictions: Create or Edit"),
-                                        // results in Shift-Ctrl-T on windows
-                                        KeyEvent.VK_T,
-                                        Shortcut.GROUPS_ALT1+Shortcut.GROUP_HOTKEY, 
-                                        Shortcut.SHIFT_DEFAULT
-                        ),
-                        true /* register action */
+                    null, // shortcut is going to be registered later 
+                        false 
             );
         }       

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/TurnRestrictionsPlugin.java

@@ -9 +9 @@
 
 /**
- * This is the main class for the turnrestriction plugin.
+ * This is the main class for the turnrestrictions plugin.
  * 
  */
 public class TurnRestrictionsPlugin extends Plugin{
         
-        private CreateOrEditTurnRestrictionAction actCreateOrEditTurnRestriction;
-        
         public TurnRestrictionsPlugin(PluginInformation info) {
-                super(info);
-                actCreateOrEditTurnRestriction = new CreateOrEditTurnRestrictionAction();
+                super(info);            
         }
         
@@ -30 +27 @@
                         // add the dialog
                         newFrame.addToggleDialog(dialog);
+                        CreateOrEditTurnRestrictionAction.install();
                 }
         }

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/editor/TurnRestrictionLegEditor.java

@@ -156 +156 @@
                         lblOsmObject.setFont(UIManager.getFont("Label.font").deriveFont(Font.ITALIC));
                         lblOsmObject.setIcon(null);
-                        lblOsmObject.setText(tr("multiple objects with role ''{0}''",this.role.toString()));
+                        lblOsmObject.setText(tr("multiple objects with role ''{0}''",this.role.getOsmRole()));
                         lblOsmObject.setToolTipText(null);                      
                 }

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/list/TurnRestrictionCellRenderer.java

@@ -96 +96 @@
          */
         protected ImageIcon getIcon(String restrictionType) {
-                if (!isValidRestrictionType(restrictionType)) return null;
+                if (!isValidRestrictionType(restrictionType)) {
+                        return ImageProvider.get("types", "non-standard-type");
+                }
                 return ImageProvider.get(buildImageName(restrictionType));
         }
@@ -146 +148 @@
         protected void renderIcon(Relation tr) {
                 String restrictionType = tr.get("restriction");
-                if (!isValidRestrictionType(restrictionType)) {
-                        icon.setIcon(null);
-                        return;
-                }
                 icon.setIcon(getIcon(restrictionType));
         }

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/preferences/PreferenceKeys.java

@@ -1 +1 @@
 package org.openstreetmap.josm.plugins.turnrestrictions.preferences;
+
+import javax.swing.KeyStroke;
 
 /**
@@ -29 +31 @@
          */
         String SHOW_VIAS_IN_BASIC_EDITOR = "turnrestrictions.show-vias-in-basic-editor";
+        
+        /**
+         * The shortcut which triggers creating a new or editing and existing turn
+         * restriction. The value must be parseable by {@see KeyStroke#getKeyStroke(String)}.
+         * If missing, the default value "ctrl shift T" is assumed.
+         */
+        String EDIT_SHORTCUT= "turnrestrictions.edit-shortcut";
 }

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/preferences/PreferencesPanel.java

@@ -16 +16 @@
 import javax.swing.JPanel;
 import javax.swing.JRadioButton;
+import javax.swing.JSeparator;
 
 import org.openstreetmap.josm.data.Preferences;
@@ -34 +35 @@
         private ButtonGroup bgIconSet;
         private JCheckBox cbShowViaListInBasicEditor;
+        private ShortcutPreferencePanel pnlShortcutPreference;
         
         protected JPanel buildShowViaListInBasicEditorPanel() {
@@ -47 +49 @@
                 msg.setText("<html><body>"
                                 + tr("The Basic Editor can optionally display the list of via-objects "
-                                         + "of a turn restrictions. If enabled, one can also edit them "
-                                         + "in the Basic editor. If disabled, editing of via-objects is only "
-                                         + "possible in the Advanced Editor."
+                                         + "of a turn restriction. If enabled, one can edit them "
+                                         + "in the Basic editor too. If disabled, editing of via-objects is "
+                                         + "possible in the Advanced Editor only."
                                   )
                                 + "</body></html>"
@@ -153 +155 @@
                 add(buildSetBPanel(), gc);
                 gc.gridy++;
+                add(new JSeparator(), gc);              
+                gc.gridy++;
                 add(buildShowViaListInBasicEditorPanel(), gc);
+                gc.gridy++;
+                add(new JSeparator(), gc);
+                gc.gridy++;
+                add(pnlShortcutPreference = new ShortcutPreferencePanel(), gc);
                 
                 // filler - just grab remaining space
@@ -189 +197 @@
                 boolean b = prefs.getBoolean(PreferenceKeys.SHOW_VIAS_IN_BASIC_EDITOR, false);
                 cbShowViaListInBasicEditor.setSelected(b);
+                
+                pnlShortcutPreference.initFromPreferences(prefs);
         }
         
@@ -213 +223 @@
                         prefs.put(PreferenceKeys.SHOW_VIAS_IN_BASIC_EDITOR, newValue);
                 }               
+                
+                pnlShortcutPreference.saveToPreferences(prefs);
         }
         

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/qa/IdenticalTurnRestrictionLegsError.java

@@ -27 +27 @@
         @Override
         public String getText() {               
-                return tr("This turn restriction uses the OSM way <span class=\"object-name\">{0}</span> with role ''from'' <strong>and</strong> with role ''to''. "
-                                + "In a turn restriction, the way with role ''from'' should be different from the way with role ''to'', though.",
+                return tr("This turn restriction uses the OSM way <span class=\"object-name\">{0}</span> with role <tt>from</tt> <strong>and</strong> with role <tt>to</tt>. "
+                                + "In a turn restriction, the way with role <tt>from</tt> should be different from the way with role <tt>to</tt>, though.",
                                 leg.getDisplayName(DefaultNameFormatter.getInstance())
                                 );                              

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/qa/IntersectionMissingAsViaError.java

@@ -37 +37 @@
                 String msg = tr("The <strong>from</strong>-way <span class=\"object-name\">{0}</span> and the <strong>to</strong>-way <span class=\"object-name\">{1}</span> "
                        + "interesect at node <span class=\"object-name\">{2}</span> but <span class=\"object-name\">{2}</span> isn''t a <strong>via</strong>-object.<br> "
-                       + "It is recommended to set <span class=\"object-name\">{2}</span> as only <strong>via</strong>-object.",
+                       + "It is recommended to set <span class=\"object-name\">{2}</span> as unique <strong>via</strong>-object.",
                        this.from.getDisplayName(DefaultNameFormatter.getInstance()),
                        this.to.getDisplayName(DefaultNameFormatter.getInstance()),

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/qa/MultipleTurnRestrictionLegError.java

@@ -20 +20 @@
          * Create the issue
          * 
-         * @param parent the parant model 
+         * @param parent the parent model 
          * @param role the role of the turn restriction leg with multiple entries 
          * @param numLegs the number of legs
@@ -34 +34 @@
         public String getText() {
                 switch(role){
-                case FROM: return 
-                        tr("A turn restriction requires exactly one way with role <tt>from</tt>. "
+                case FROM:  
+                        return tr("A turn restriction requires exactly one way with role <tt>from</tt>. "
                                 + "This turn restriction has {0} ways in this role. Please remove "
                                 + "{1} of them.",
@@ -42 +42 @@
                         );
                 case TO: 
-                        tr("A turn restriction requires exactly one way with role <tt>from</tt>. "
+                        return tr("A turn restriction requires exactly one way with role <tt>to</tt>. "
                                         + "This turn restriction has {0} ways in this role. Please remove "
                                         + "{1} of them.",