Changeset 4595 in josm

Timestamp:

Nov 15, 2011 8:09:57 PM (19 months ago)

Author:

jttt

Message:

Multikey keyboard shorcuts - shorcuts like Ctrl+Alt+S,n will toggle n-th layer visibility, added shorcuts also for Jump to next/previous marker. Shorcuts for other actions can be easily added.

Location:

trunk/src/org/openstreetmap/josm

Files:

• gui/dialogs/LayerListDialog.java (modified) (13 diffs)
• gui/layer/markerlayer/MarkerLayer.java (modified) (8 diffs)
• tools/MultikeyActionsHandler.java (added)
• tools/MultikeyShortcutAction.java (added)
• tools/Shortcut.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/gui/dialogs/LayerListDialog.java

@@ -16 +16 @@
 import java.beans.PropertyChangeEvent;
 import java.beans.PropertyChangeListener;
+import java.lang.ref.WeakReference;
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -64 +65 @@
 import org.openstreetmap.josm.tools.CheckParameterUtil;
 import org.openstreetmap.josm.tools.ImageProvider;
+import org.openstreetmap.josm.tools.MultikeyActionsHandler;
+import org.openstreetmap.josm.tools.MultikeyShortcutAction;
+import org.openstreetmap.josm.tools.MultikeyShortcutAction.MultikeyInfo;
 import org.openstreetmap.josm.tools.Shortcut;
 
@@ -85 +89 @@
             throw new IllegalStateException("Dialog was already created");
         instance = new LayerListDialog(mapFrame);
+
+        MultikeyActionsHandler.getInstance().addAction(instance.new ShowHideLayerAction(false));
     }
 
@@ -113 +119 @@
     ActivateLayerAction activateLayerAction;
 
+    //TODO This duplicates ShowHide actions functionality
     /** stores which layer index to toggle and executes the ShowHide action if the layer is present */
     private final class ToggleLayerIndexVisibility extends AbstractAction {
@@ -123 +130 @@
             final Layer l = model.getLayer(model.getRowCount() - layerIndex);
             if(l != null) {
-                new ShowHideLayerAction(l).actionPerformed(e);
+                l.toggleVisible();
             }
         }
@@ -258 +265 @@
 
         createLayout(layerList, true, Arrays.asList(new SideButton[] {
-            new SideButton(moveUpAction),
-            new SideButton(moveDownAction),
-            new SideButton(activateLayerAction),
-            new SideButton(showHideLayerAction),
-            opacityButton,
-            new SideButton(mergeLayerAction),
-            new SideButton(duplicateLayerAction),
-            new SideButton(deleteLayerAction, false)
+                new SideButton(moveUpAction),
+                new SideButton(moveDownAction),
+                new SideButton(activateLayerAction),
+                new SideButton(showHideLayerAction),
+                opacityButton,
+                new SideButton(mergeLayerAction),
+                new SideButton(duplicateLayerAction),
+                new SideButton(deleteLayerAction, false)
         }));
 
@@ -420 +427 @@
     }
 
-    public final class ShowHideLayerAction extends AbstractAction implements IEnabledStateUpdating, LayerAction {
-        private  Layer layer;
-
-        /**
-         * Creates a {@see ShowHideLayerAction} which toggle the visibility of
-         * a specific layer.
-         *
-         * @param layer  the layer. Must not be null.
-         * @exception IllegalArgumentException thrown, if layer is null
-         */
-        public ShowHideLayerAction(Layer layer) throws IllegalArgumentException {
-            this();
-            putValue(NAME, tr("Show/Hide"));
-            CheckParameterUtil.ensureParameterNotNull(layer, "layer");
-            this.layer = layer;
-            updateEnabledState();
-        }
+    public final class ShowHideLayerAction extends AbstractAction implements IEnabledStateUpdating, LayerAction, MultikeyShortcutAction {
+
+        private WeakReference<Layer> lastLayer;
 
         /**
@@ -443 +436 @@
          *
          */
-        public ShowHideLayerAction() {
+        public ShowHideLayerAction(boolean init) {
             putValue(SMALL_ICON, ImageProvider.get("dialogs", "showhide"));
             putValue(SHORT_DESCRIPTION, tr("Toggle visible state of the selected layer."));
             putValue("help", HelpUtil.ht("/Dialog/LayerList#ShowHideLayer"));
-            updateEnabledState();
+            putValue(ACCELERATOR_KEY, Shortcut.registerShortcut("core_multikey:showHideLayer", "", 'S', Shortcut.GROUP_DIRECT, KeyEvent.ALT_DOWN_MASK + KeyEvent.CTRL_DOWN_MASK).getKeyStroke());
+            if (init) {
+                updateEnabledState();
+            }
+        }
+
+        public ShowHideLayerAction() {
+            this(true);
         }
 
         @Override
         public void actionPerformed(ActionEvent e) {
-            if (layer != null) {
-                layer.toggleVisible();
-            } else {
-                for(Layer l : model.getSelectedLayers()) {
+            for(Layer l : model.getSelectedLayers()) {
+                l.toggleVisible();
+            }
+        }
+
+        @Override
+        public void executeMultikeyAction(int index) {
+            Layer l = LayerListDialog.getLayerForIndex(index);
+            if (l != null) {
+                l.toggleVisible();
+                lastLayer = new WeakReference<Layer>(l);
+            }
+        }
+
+        @Override
+        public void repeateLastMultikeyAction() {
+            if (lastLayer != null) {
+                Layer l = lastLayer.get();
+                if (LayerListDialog.isLayerValid(l)) {
                     l.toggleVisible();
                 }
@@ -463 +478 @@
         @Override
         public void updateEnabledState() {
-            if (layer == null) {
-                setEnabled(! getModel().getSelectedLayers().isEmpty());
-            } else {
-                setEnabled(true);
-            }
+            setEnabled(!model.getSelectedLayers().isEmpty());
         }
 
@@ -488 +499 @@
         public int hashCode() {
             return getClass().hashCode();
+        }
+
+        @Override
+        public List<MultikeyInfo> getMultikeyCombinations() {
+            return LayerListDialog.getLayerInfoByClass(Layer.class);
+        }
+
+        @Override
+        public MultikeyInfo getLastMultikeyAction() {
+            if (lastLayer != null)
+                return LayerListDialog.getLayerInfo(lastLayer.get());
+            return null;
         }
     }
@@ -905 +928 @@
                     }
                 }
-                if(c == null)
+                if(c == null) {
                     c = Main.pref.getUIColor(isSelected ? "Table.selectionForeground" : "Table.foreground");
+                }
                 label.setForeground(c);
             }
@@ -1459 +1483 @@
      */
     public ShowHideLayerAction createShowHideLayerAction() {
-        ShowHideLayerAction act = new ShowHideLayerAction();
+        ShowHideLayerAction act = new ShowHideLayerAction(true);
         act.putValue(Action.NAME, tr("Show/Hide"));
         return act;
@@ -1497 +1521 @@
         return new MergeAction(layer);
     }
+
+    public static Layer getLayerForIndex(int index) {
+
+        if (!Main.isDisplayingMapView())
+            return null;
+
+        List<Layer> layers = Main.map.mapView.getAllLayersAsList();
+
+        if (index < layers.size())
+            return layers.get(index);
+        else
+            return null;
+    }
+
+    public static List<MultikeyInfo> getLayerInfoByClass(Class<? extends Layer> layerClass) {
+
+        List<MultikeyInfo> result = new ArrayList<MultikeyShortcutAction.MultikeyInfo>();
+
+        if (!Main.isDisplayingMapView())
+            return result;
+
+        List<Layer> layers = Main.map.mapView.getAllLayersAsList();
+
+        int index = 0;
+        for (Layer l: layers) {
+            if (layerClass.isAssignableFrom(l.getClass())) {
+                result.add(new MultikeyInfo(index, l.getName()));
+            }
+            index++;
+        }
+
+        return result;
+    }
+
+    public static boolean isLayerValid(Layer l) {
+        if (l == null)
+            return false;
+
+        if (!Main.isDisplayingMapView())
+            return false;
+
+        return Main.map.mapView.getAllLayersAsList().indexOf(l) >= 0;
+    }
+
+    public static MultikeyInfo getLayerInfo(Layer l) {
+
+        if (l == null)
+            return null;
+
+        if (!Main.isDisplayingMapView())
+            return null;
+
+        int index = Main.map.mapView.getAllLayersAsList().indexOf(l);
+        if (index < 0)
+            return null;
+
+        return new MultikeyInfo(index, l.getName());
+    }
 }

trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerLayer.java

@@ -12 +12 @@
 import java.awt.Point;
 import java.awt.event.ActionEvent;
+import java.awt.event.KeyEvent;
 import java.awt.event.MouseAdapter;
 import java.awt.event.MouseEvent;
 import java.io.File;
+import java.lang.ref.WeakReference;
 import java.net.URL;
 import java.util.ArrayList;
@@ -42 +44 @@
 import org.openstreetmap.josm.tools.AudioPlayer;
 import org.openstreetmap.josm.tools.ImageProvider;
+import org.openstreetmap.josm.tools.MultikeyActionsHandler;
+import org.openstreetmap.josm.tools.MultikeyShortcutAction;
+import org.openstreetmap.josm.tools.Shortcut;
 
 /**
@@ -59 +64 @@
      * A list of markers.
      */
-    public final Collection<Marker> data;
+    public final List<Marker> data;
     private boolean mousePressed = false;
     public GpxLayer fromLayer = null;
-
-    @SuppressWarnings("unchecked")
+    private Marker currentMarker;
+
     public MarkerLayer(GpxData indata, String name, File associatedFile, GpxLayer fromLayer) {
 
@@ -125 +130 @@
     }
 
+    static {
+        MultikeyActionsHandler.getInstance().addAction(new JumpToNextMarker(null));
+        MultikeyActionsHandler.getInstance().addAction(new JumpToPreviousMarker(null));
+    }
+
+
     /**
      * Return a static icon.
@@ -200 +211 @@
             components.add (new MoveAudio());
         }
+        components.add(new JumpToNextMarker(this));
+        components.add(new JumpToPreviousMarker(this));
         components.add(new RenameLayerAction(getAssociatedFile(), this));
         components.add(SeparatorLayerAction.INSTANCE);
@@ -292 +305 @@
         data.addAll(newData);
         return ret;
+    }
+
+    public void jumpToNextMarker() {
+        if (currentMarker == null) {
+            currentMarker = data.get(0);
+        } else {
+            boolean foundCurrent = false;
+            for (Marker m: data) {
+                if (foundCurrent) {
+                    currentMarker = m;
+                    break;
+                } else if (currentMarker == m) {
+                    foundCurrent = true;
+                }
+            }
+        }
+        Main.map.mapView.zoomTo(currentMarker.getEastNorth());
+    }
+
+    public void jumpToPreviousMarker() {
+        if (currentMarker == null) {
+            currentMarker = data.get(data.size() - 1);
+        } else {
+            boolean foundCurrent = false;
+            for (int i=data.size() - 1; i>=0; i--) {
+                Marker m = data.get(i);
+                if (foundCurrent) {
+                    currentMarker = m;
+                    break;
+                } else if (currentMarker == m) {
+                    foundCurrent = true;
+                }
+            }
+        }
+        Main.map.mapView.zoomTo(currentMarker.getEastNorth());
     }
 
@@ -393 +441 @@
     }
 
+    public static final class JumpToNextMarker extends AbstractAction implements MultikeyShortcutAction {
+
+        private final MarkerLayer layer;
+        private WeakReference<MarkerLayer> lastLayer;
+
+        public JumpToNextMarker(MarkerLayer layer) {
+            putValue(ACCELERATOR_KEY, Shortcut.registerShortcut("core_multikey:nextMarker", "", 'J', Shortcut.GROUP_DIRECT, KeyEvent.ALT_DOWN_MASK + KeyEvent.CTRL_DOWN_MASK).getKeyStroke());
+            putValue(SHORT_DESCRIPTION, tr("Jump to next marker"));
+            putValue(NAME, tr("Jump to next marker"));
+
+            this.layer = layer;
+        }
+
+        @Override
+        public void actionPerformed(ActionEvent e) {
+            execute(layer);
+        }
+
+        @Override
+        public void executeMultikeyAction(int index) {
+            Layer l = LayerListDialog.getLayerForIndex(index);
+            if (l != null && l instanceof MarkerLayer) {
+                execute((MarkerLayer) l);
+            }
+        }
+
+        @Override
+        public void repeateLastMultikeyAction() {
+            if (lastLayer != null) {
+                MarkerLayer l = lastLayer.get();
+                if (LayerListDialog.isLayerValid(l)) {
+                    execute(l);
+                }
+            }
+        }
+
+        private void execute(MarkerLayer l) {
+            l.jumpToNextMarker();
+            lastLayer = new WeakReference<MarkerLayer>(l);
+        }
+
+        @Override
+        public List<MultikeyInfo> getMultikeyCombinations() {
+            return LayerListDialog.getLayerInfoByClass(MarkerLayer.class);
+        }
+
+        @Override
+        public MultikeyInfo getLastMultikeyAction() {
+            if (lastLayer != null)
+                return LayerListDialog.getLayerInfo(lastLayer.get());
+            else
+                return null;
+        }
+
+    }
+
+    public static final class JumpToPreviousMarker extends AbstractAction implements MultikeyShortcutAction {
+
+        private WeakReference<MarkerLayer> lastLayer;
+        private final MarkerLayer layer;
+
+        public JumpToPreviousMarker(MarkerLayer layer) {
+            this.layer = layer;
+
+            putValue(ACCELERATOR_KEY, Shortcut.registerShortcut("core_multikey:previousMarker", "", 'P', Shortcut.GROUP_DIRECT, KeyEvent.ALT_DOWN_MASK + KeyEvent.CTRL_DOWN_MASK).getKeyStroke());
+            putValue(SHORT_DESCRIPTION, tr("Jump to previous marker"));
+            putValue(NAME, tr("Jump to previous marker"));
+        }
+
+        @Override
+        public void actionPerformed(ActionEvent e) {
+            execute(layer);
+        }
+
+        @Override
+        public void executeMultikeyAction(int index) {
+            Layer l = LayerListDialog.getLayerForIndex(index);
+            if (l != null && l instanceof MarkerLayer) {
+                execute((MarkerLayer) l);
+            }
+        }
+
+        @Override
+        public void repeateLastMultikeyAction() {
+            if (lastLayer != null) {
+                MarkerLayer l = lastLayer.get();
+                if (LayerListDialog.isLayerValid(l)) {
+                    execute(l);
+                }
+            }
+        }
+
+        private void execute(MarkerLayer l) {
+            l.jumpToPreviousMarker();
+            lastLayer = new WeakReference<MarkerLayer>(l);
+        }
+
+        @Override
+        public List<MultikeyInfo> getMultikeyCombinations() {
+            return LayerListDialog.getLayerInfoByClass(MarkerLayer.class);
+        }
+
+        @Override
+        public MultikeyInfo getLastMultikeyAction() {
+            if (lastLayer != null)
+                return LayerListDialog.getLayerInfo(lastLayer.get());
+            else
+                return null;
+        }
+
+    }
+
     private class SynchronizeAudio extends AbstractAction {
 
@@ -455 +615 @@
         }
     }
+
 }

trunk/src/org/openstreetmap/josm/tools/Shortcut.java

@@ -2 +2 @@
 package org.openstreetmap.josm.tools;
 
-import java.awt.Menu;
 import static org.openstreetmap.josm.tools.I18n.tr;
 
@@ -209 +208 @@
     }
 
+    @Override
+    public String toString() {
+        return getKeyText();
+    }
+
     ///////////////////////////////
     // everything's static below //
@@ -504 +508 @@
                                 :
                                     tr("Using the shortcut ''{0}'' instead.\n\n", potentialShortcut.getKeyText())
-                        )+
-                        tr("(Hint: You can edit the shortcuts in the preferences.)"),
-                        tr("Error"),
-                        JOptionPane.ERROR_MESSAGE
-        );
+                                )+
+                                tr("(Hint: You can edit the shortcuts in the preferences.)"),
+                                tr("Error"),
+                                JOptionPane.ERROR_MESSAGE
+                );
     }