Changeset 5821 in josm for trunk/src/org

Timestamp:

2013-04-02T00:55:56+02:00 (11 years ago)

Author:

Don-vip

Message:

see #7846 - Large code refactorization in management of popup menus to simplify interactions with plugins (needed at least for imagery-xml-bounds and tag2link plugins)

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/OsmPrimitiveAction.java (added)
• actions/relation/AbstractRelationAction.java (modified) (2 diffs)
• actions/relation/DownloadMembersAction.java (modified) (2 diffs)
• actions/relation/DownloadSelectedIncompleteMembersAction.java (modified) (2 diffs)
• actions/relation/DuplicateRelationAction.java (modified) (1 diff)
• gui/PopupMenuHandler.java (added)
• gui/dialogs/RelationListDialog.java (modified) (12 diffs)
• gui/dialogs/SelectionListDialog.java (modified) (8 diffs)
• gui/dialogs/properties/PropertiesDialog.java (modified) (11 diffs)

trunk/src/org/openstreetmap/josm/actions/relation/AbstractRelationAction.java

@@ -7 +7 @@
 import javax.swing.AbstractAction;
 
+import org.openstreetmap.josm.actions.OsmPrimitiveAction;
+import org.openstreetmap.josm.data.osm.OsmPrimitive;
 import org.openstreetmap.josm.data.osm.Relation;
+import org.openstreetmap.josm.tools.SubclassFilteredCollection;
 
 /**
@@ -14 +17 @@
  * @since 5793
  */
-public abstract class AbstractRelationAction extends AbstractAction {
+public abstract class AbstractRelationAction extends AbstractAction implements OsmPrimitiveAction {
     protected Collection<Relation> relations = Collections.<Relation>emptySet();
 
-    /**
-     * Specifies the working set of relations.
-     * @param relations The new working set of relations. Can be null or empty
+    protected static final Collection<Relation> getRelations(Collection<? extends OsmPrimitive> primitives) {
+        if (primitives == null || primitives.isEmpty()) {
+            return Collections.<Relation>emptySet();
+        } else {
+            return new SubclassFilteredCollection<OsmPrimitive, Relation>(
+                    primitives, OsmPrimitive.relationPredicate);
+        }
+    }
+    
+    /* (non-Javadoc)
+     * @see org.openstreetmap.josm.actions.relation.RelationAction#setPrimitives
      */
-    public void setRelations(Collection<Relation> relations) {
-        if (relations==null) {
-            this.relations = Collections.<Relation>emptySet();
-        } else {
-            this.relations = relations;
-        }
+    @Override
+    public void setPrimitives(Collection<? extends OsmPrimitive> primitives) {
+        this.relations = getRelations(primitives);
         updateEnabledState();
     }

trunk/src/org/openstreetmap/josm/actions/relation/DownloadMembersAction.java

@@ -6 +6 @@
 
 import java.awt.event.ActionEvent;
+import java.util.Collection;
 
 import org.openstreetmap.josm.Main;
+import org.openstreetmap.josm.data.osm.OsmPrimitive;
+import org.openstreetmap.josm.data.osm.Relation;
 import org.openstreetmap.josm.gui.dialogs.relation.DownloadRelationTask;
 import org.openstreetmap.josm.tools.ImageProvider;
+import org.openstreetmap.josm.tools.Predicate;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
  * The action for downloading members of relations
-
+ * @since 5793
  */
 public class DownloadMembersAction extends AbstractRelationAction {
@@ -32 +37 @@
         Main.worker.submit(new DownloadRelationTask(relations, Main.map.mapView.getEditLayer()));
     }
+
+    @Override
+    public void setPrimitives(Collection<? extends OsmPrimitive> primitives) {
+        // selected non-new relations
+        this.relations = Utils.filter(getRelations(primitives), new Predicate<Relation>(){
+            @Override public boolean evaluate(Relation r) {
+                return !r.isNew();
+            }});
+        updateEnabledState();
+    }
 }

trunk/src/org/openstreetmap/josm/actions/relation/DownloadSelectedIncompleteMembersAction.java

@@ -14 +14 @@
 import org.openstreetmap.josm.gui.dialogs.relation.DownloadRelationMemberTask;
 import org.openstreetmap.josm.tools.ImageProvider;
+import org.openstreetmap.josm.tools.Predicate;
+import org.openstreetmap.josm.tools.Utils;
 
 /**
@@ -51 +53 @@
                 Main.map.mapView.getEditLayer()));
     }
+
+    @Override
+    public void setPrimitives(Collection<? extends OsmPrimitive> primitives) {
+        // selected relations with incomplete members
+        this.relations = Utils.filter(getRelations(primitives), new Predicate<Relation>(){
+            @Override public boolean evaluate(Relation r) {
+                return !r.isNew() && r.hasIncompleteMembers();
+            }});
+        updateEnabledState();
+    }
 }

trunk/src/org/openstreetmap/josm/actions/relation/DuplicateRelationAction.java

@@ -17 +17 @@
  */
 public class DuplicateRelationAction extends AbstractRelationAction {
+    
+    /**
+     * Constructs a new {@code DuplicateRelationAction}. 
+     */
     public DuplicateRelationAction() {
         putValue(SHORT_DESCRIPTION, tr("Create a copy of this relation and open it in another editor window"));

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

@@ -16 +16 @@
 import java.util.Collections;
 import java.util.HashSet;
-import java.util.Iterator;
 import java.util.List;
 import java.util.Set;
@@ -22 +21 @@
 import javax.swing.AbstractAction;
 import javax.swing.AbstractListModel;
-import javax.swing.Action;
 import javax.swing.DefaultListSelectionModel;
 import javax.swing.JComponent;
 import javax.swing.JList;
-import javax.swing.JMenuItem;
 import javax.swing.JPanel;
 import javax.swing.JPopupMenu;
@@ -39 +36 @@
 import javax.swing.event.ListSelectionEvent;
 import javax.swing.event.ListSelectionListener;
-import javax.swing.event.PopupMenuListener;
 
 import org.openstreetmap.josm.Main;
@@ -69 +65 @@
 import org.openstreetmap.josm.gui.MapView.LayerChangeListener;
 import org.openstreetmap.josm.gui.OsmPrimitivRenderer;
+import org.openstreetmap.josm.gui.PopupMenuHandler;
 import org.openstreetmap.josm.gui.SideButton;
 import org.openstreetmap.josm.gui.dialogs.relation.RelationEditor;
@@ -95 +92 @@
     private final NewAction newAction;
     
-    /** the popup menu */
-    private final RelationDialogPopupMenu popupMenu;
+    /** the popup menu and its handler */
+    private final JPopupMenu popupMenu = new JPopupMenu();
+    private final PopupMenuHandler popupMenuHandler = new PopupMenuHandler(popupMenu);
 
     private final JTextField filter;
@@ -109 +107 @@
     private final DownloadMembersAction downloadMembersAction = new DownloadMembersAction();
     private final DownloadSelectedIncompleteMembersAction downloadSelectedIncompleteMembersAction = new DownloadSelectedIncompleteMembersAction();
-    private final SelectMembersAction selectMemebersAction = new SelectMembersAction(false);
+    private final SelectMembersAction selectMembersAction = new SelectMembersAction(false);
     private final SelectMembersAction addMembersToSelectionAction = new SelectMembersAction(true);
     private final SelectRelationAction selectRelationAction = new SelectRelationAction(false);
     private final SelectRelationAction addRelationToSelectionAction = new SelectRelationAction(true);
-    /** add all selected primitives to the given realtions */
+    /** add all selected primitives to the given relations */
     private final AddSelectionToRelations addSelectionToRelations = new AddSelectionToRelations();
     
@@ -154 +152 @@
             }
         });
+
+        // Setup popup menu handler
+        setupPopupMenuHandler();
         
         JPanel pane = new JPanel(new BorderLayout());
@@ -175 +176 @@
         InputMapUtils.addEnterAction(displaylist, selectRelationAction);
 
-        popupMenu = new RelationDialogPopupMenu();
-
         // Edit relation on Ctrl-Enter
         displaylist.getActionMap().put("edit", editAction);
@@ -186 +185 @@
     // inform all actions about list of relations they need
     private void updateActionsRelationLists() {
-        List<Relation> rels;
-        rels = model.getSelectedNonNewRelations();
-        downloadMembersAction.setRelations(rels);
-
-        rels = model.getSelectedRelationsWithIncompleteMembers();
-        downloadSelectedIncompleteMembersAction.setRelations(rels); 
-
-        rels = model.getSelectedRelations();
-        editAction.setRelations(rels);
-        deleteRelationsAction.setRelations(rels);
-        addSelectionToRelations.setRelations(rels);
-        selectMemebersAction.setRelations(rels);
-        addMembersToSelectionAction.setRelations(rels);
-        selectRelationAction.setRelations(rels);
-        addRelationToSelectionAction.setRelations(rels);
-        duplicateAction.setRelations(rels);
+        popupMenuHandler.setPrimitives(model.getSelectedRelations());
     }
     
@@ -509 +493 @@
             }
         }
-
-        /**
-         * Replies the list of selected relations with incomplete members
-         *
-         * @return the list of selected relations with incomplete members
-         */
-        public List<Relation> getSelectedRelationsWithIncompleteMembers() {
-            List<Relation> ret = getSelectedNonNewRelations();
-            Iterator<Relation> it = ret.iterator();
-            while(it.hasNext()) {
-                Relation r = it.next();
-                if (!r.hasIncompleteMembers()) {
-                    it.remove();
-                }
-            }
-            return ret;
-        }
         
         private void updateFilteredRelations() {
@@ -569 +536 @@
 
         /**
-         * Replies the list of selected, non-new relations. Empty list,
-         * if there are no selected, non-new relations.
-         *
-         * @return the list of selected, non-new relations.
-         */
-        public List<Relation> getSelectedNonNewRelations() {
-            ArrayList<Relation> ret = new ArrayList<Relation>();
-            for (int i=0; i<getSize();i++) {
-                if (!selectionModel.isSelectedIndex(i)) {
-                    continue;
-                }
-                if (getVisibleRelation(i).isNew()) {
-                    continue;
-                }
-                ret.add(getVisibleRelation(i));
-            }
-            return ret;
-        }
-
-        /**
          * Replies the list of selected relations. Empty list,
          * if there are no selected relations.
@@ -656 +603 @@
     }
 
-    class RelationDialogPopupMenu extends JPopupMenu {
-
-        public RelationDialogPopupMenu() {
-            // -- download members action
-            add(downloadMembersAction);
-
-            // -- download incomplete members action
-            add(downloadSelectedIncompleteMembersAction);
-
-            addSeparator();
-
-            // -- select members action
-            add(selectMemebersAction);
-            add(addMembersToSelectionAction);
-
-            // -- select action
-            add(selectRelationAction);
-            add(addRelationToSelectionAction);
-
-            addSeparator();
-
-            add(addSelectionToRelations);
-        }
-    }
-
+    private final void setupPopupMenuHandler() {
+        
+        // -- download members action
+        popupMenuHandler.addAction(downloadMembersAction);
+
+        // -- download incomplete members action
+        popupMenuHandler.addAction(downloadSelectedIncompleteMembersAction);
+
+        popupMenuHandler.addSeparator();
+
+        // -- select members action
+        popupMenuHandler.addAction(selectMembersAction);
+        popupMenuHandler.addAction(addMembersToSelectionAction);
+
+        // -- select action
+        popupMenuHandler.addAction(selectRelationAction);
+        popupMenuHandler.addAction(addRelationToSelectionAction);
+
+        popupMenuHandler.addSeparator();
+
+        popupMenuHandler.addAction(addSelectionToRelations);
+    }
+    
     /* ---------------------------------------------------------------------------------- */
-    /* Methods that can be called from plugins                                                                    */
+    /* Methods that can be called from plugins                                            */
     /* ---------------------------------------------------------------------------------- */
 
-    public void addPopupMenuSeparator() {
-        popupMenu.addSeparator();
-    }
-
-    public JMenuItem addPopupMenuAction(Action a) {
-        return popupMenu.add(a);
-    }
-
-    public void addPopupMenuListener(PopupMenuListener l) {
-        popupMenu.addPopupMenuListener(l);
-    }
-
-    public void removePopupMenuListener(PopupMenuListener l) {
-        popupMenu.addPopupMenuListener(l);
+    /**
+     * Replies the popup menu handler.
+     * @return The popup menu handler
+     */
+    public PopupMenuHandler getPopupMenuHandler() {
+        return popupMenuHandler;
     }
 

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

@@ -24 +24 @@
 import javax.swing.AbstractAction;
 import javax.swing.AbstractListModel;
-import javax.swing.Action;
 import javax.swing.DefaultListSelectionModel;
 import javax.swing.JList;
@@ -35 +34 @@
 import javax.swing.event.ListSelectionEvent;
 import javax.swing.event.ListSelectionListener;
-import javax.swing.event.PopupMenuListener;
 
 import org.openstreetmap.josm.Main;
@@ -67 +65 @@
 import org.openstreetmap.josm.gui.MapView.EditLayerChangeListener;
 import org.openstreetmap.josm.gui.OsmPrimitivRenderer;
+import org.openstreetmap.josm.gui.PopupMenuHandler;
 import org.openstreetmap.josm.gui.SideButton;
 import org.openstreetmap.josm.gui.layer.OsmDataLayer;
@@ -92 +91 @@
     private DownloadSelectedIncompleteMembersAction actDownloadSelectedIncompleteMembers;
 
-    private SelectionPopup popupMenu;
+    /** the popup menu and its handler */
+    private final ListPopupMenu popupMenu;
+    private final PopupMenuHandler popupMenuHandler;
 
     /**
@@ -148 +149 @@
         actDownloadSelectedIncompleteMembers = new DownloadSelectedIncompleteMembersAction();
 
+        popupMenu = new ListPopupMenu(lstPrimitives);
+        popupMenuHandler = setupPopupMenuHandler();
+
         lstPrimitives.addListSelectionListener(new ListSelectionListener() {
             @Override
             public void valueChanged(ListSelectionEvent e) {
                 actZoomToListSelection.valueChanged(e);
-                List<Relation> rels;
-                rels = model.getSelectedRelationsWithIncompleteMembers();
-                actDownloadSelectedIncompleteMembers.setRelations(rels); 
-                rels = OsmPrimitive.getFilteredList(model.getSelected(), Relation.class);
-                actSetRelationSelection.setRelations(rels);
-                actEditRelationSelection.setRelations(rels);
+                popupMenuHandler.setPrimitives(model.getSelected());
             }
         });
@@ -164 +163 @@
         lstPrimitives.addMouseListener(new DblClickHandler());
 
-        popupMenu = new SelectionPopup(lstPrimitives);
         InputMapUtils.addEnterAction(lstPrimitives, actZoomToListSelection);
     }
@@ -221 +219 @@
     }
 
-    /**
-     * The popup menu for the selection list
-     */
-    class SelectionPopup extends ListPopupMenu {
-        public SelectionPopup(JList list) {
-            super(list);
-            add(actZoomToJOSMSelection);
-            add(actZoomToListSelection);
-            addSeparator();
-            add(actSetRelationSelection);
-            add(actEditRelationSelection);
-            addSeparator();
-            add(actDownloadSelectedIncompleteMembers);
-        }
-    }
-
-    public void addPopupMenuSeparator() {
-        popupMenu.addSeparator();
-    }
-
-    public JMenuItem addPopupMenuAction(Action a) {
-        return popupMenu.add(a);
-    }
-
-    public void addPopupMenuListener(PopupMenuListener l) {
-        popupMenu.addPopupMenuListener(l);
-    }
-
-    public void removePopupMenuListener(PopupMenuListener l) {
-        popupMenu.addPopupMenuListener(l);
+    private final PopupMenuHandler setupPopupMenuHandler() {
+        PopupMenuHandler handler = new PopupMenuHandler(popupMenu);
+        handler.addAction(actZoomToJOSMSelection);
+        handler.addAction(actZoomToListSelection);
+        handler.addSeparator();
+        handler.addAction(actSetRelationSelection);
+        handler.addAction(actEditRelationSelection);
+        handler.addSeparator();
+        handler.addAction(actDownloadSelectedIncompleteMembers);
+        return handler;
+    }
+
+    /**
+     * Replies the popup menu handler.
+     * @return The popup menu handler
+     */
+    public PopupMenuHandler getPopupMenuHandler() {
+        return popupMenuHandler;
     }
 
@@ -596 +582 @@
             }
             setSelected(sel);
-        }
-
-        /**
-         * Replies the list of selected relations with incomplete members
-         *
-         * @return the list of selected relations with incomplete members
-         */
-        public List<Relation> getSelectedRelationsWithIncompleteMembers() {
-            List<Relation> ret = new LinkedList<Relation>();
-            for(int i=0; i<getSize(); i++) {
-                if (!selectionModel.isSelectedIndex(i)) {
-                    continue;
-                }
-                OsmPrimitive p = selection.get(i);
-                if (! (p instanceof Relation)) {
-                    continue;
-                }
-                if (p.isNew()) {
-                    continue;
-                }
-                Relation r = (Relation)p;
-                if (r.hasIncompleteMembers()) {
-                    ret.add(r);
-                }
-            }
-            return ret;
         }
 

trunk/src/org/openstreetmap/josm/gui/dialogs/properties/PropertiesDialog.java

@@ -32 +32 @@
 
 import javax.swing.AbstractAction;
-import javax.swing.Action;
 import javax.swing.JComponent;
 import javax.swing.JLabel;
-import javax.swing.JMenuItem;
 import javax.swing.JPanel;
 import javax.swing.JPopupMenu;
@@ -44 +42 @@
 import javax.swing.event.ListSelectionEvent;
 import javax.swing.event.ListSelectionListener;
-import javax.swing.event.PopupMenuListener;
 import javax.swing.table.DefaultTableCellRenderer;
 import javax.swing.table.DefaultTableModel;
@@ -77 +74 @@
 import org.openstreetmap.josm.gui.MapFrame;
 import org.openstreetmap.josm.gui.MapView;
+import org.openstreetmap.josm.gui.PopupMenuHandler;
 import org.openstreetmap.josm.gui.SideButton;
 import org.openstreetmap.josm.gui.dialogs.ToggleDialog;
@@ -111 +109 @@
  */
 public class PropertiesDialog extends ToggleDialog implements SelectionChangedListener, MapView.EditLayerChangeListener, DataSetListenerAdapter.Listener {
-    // hook for roadsigns plugin to display a small
-    // button in the upper right corner of this dialog
+
+    /**
+     * hook for roadsigns plugin to display a small button in the upper right corner of this dialog
+     */
     public static final JPanel pluginHook = new JPanel();
 
@@ -134 +134 @@
     private final JTable membershipTable = new JTable(membershipData);
 
-    private JPopupMenu propertyMenu;
-    private JPopupMenu membershipMenu;
+    // Popup menus
+    private final JPopupMenu propertyMenu = new JPopupMenu();
+    private final JPopupMenu membershipMenu = new JPopupMenu();
+
+    // Popup menu handlers
+    private final PopupMenuHandler propertyMenuHandler = new PopupMenuHandler(propertyMenu);
+    private final PopupMenuHandler membershipMenuHandler = new PopupMenuHandler(membershipMenu);
 
     private final Map<String, Map<String, Integer>> valueCount = new TreeMap<String, Map<String, Integer>>();
@@ -202 +207 @@
     /**
      * Create a new PropertiesDialog
+     * @param mapFrame The parent map fram
      */
     public PropertiesDialog(MapFrame mapFrame) {
@@ -370 +376 @@
     private void setupMembershipMenu() {
         // setting up the membership table
-        membershipMenu = new JPopupMenu();
-        membershipMenu.add(addRelationToSelectionAction);
-        membershipMenu.add(selectRelationAction);
-        membershipMenu.add(addMembersToSelectionAction);
-        membershipMenu.add(downloadSelectedIncompleteMembersAction);
+        membershipMenuHandler.addAction(addRelationToSelectionAction);
+        membershipMenuHandler.addAction(selectRelationAction);
+        membershipMenuHandler.addAction(addMembersToSelectionAction);
+        membershipMenuHandler.addAction(downloadSelectedIncompleteMembersAction);
         membershipMenu.addSeparator();
         membershipMenu.add(helpAction);
@@ -389 +394 @@
                     idx = new int[]{row};
                 }
-                List<Relation> rels =  new ArrayList<Relation>(10);
+                List<Relation> rels = new ArrayList<Relation>();
                 for (int i: idx) {
                     Relation r = (Relation) (membershipData.getValueAt(i, 0));
                     rels.add(r);
                 }
-                selectRelationAction.setRelations(rels);
-                addRelationToSelectionAction.setRelations(rels);
-                addMembersToSelectionAction.setRelations(rels);
-                downloadSelectedIncompleteMembersAction.setRelations(rels);
+                membershipMenuHandler.setPrimitives(rels);
                 membershipMenu.show(membershipTable, p.x, p.y-3);
             }
@@ -407 +409 @@
      */
     private void setupPropertiesMenu() {
-        propertyMenu = new JPopupMenu();
         propertyMenu.add(pasteValueAction);
         propertyMenu.add(copyValueAction);
@@ -695 +696 @@
 
     // <editor-fold defaultstate="collapsed" desc="Methods that are called by plugins to extend fuctionalty ">
-    public void addPropertyPopupMenuSeparator() {
-        propertyMenu.addSeparator();
-    }
-
-    public JMenuItem addPropertyPopupMenuAction(Action a) {
-        return propertyMenu.add(a);
-    }
-
-    public void addPropertyPopupMenuListener(PopupMenuListener l) {
-        propertyMenu.addPopupMenuListener(l);
-    }
-
-    public void removePropertyPopupMenuListener(PopupMenuListener l) {
-        propertyMenu.addPopupMenuListener(l);
+    
+    /**
+     * Replies the property popup menu handler.
+     * @return The property popup menu handler
+     */
+    public PopupMenuHandler getPropertyPopupMenuHandler() {
+        return propertyMenuHandler;
     }
 
@@ -721 +715 @@
     }
 
-    public void addMembershipPopupMenuSeparator() {
-        membershipMenu.addSeparator();
-    }
-
-    public JMenuItem addMembershipPopupMenuAction(Action a) {
-        return membershipMenu.add(a);
-    }
-
-    public void addMembershipPopupMenuListener(PopupMenuListener l) {
-        membershipMenu.addPopupMenuListener(l);
-    }
-
-    public void removeMembershipPopupMenuListener(PopupMenuListener l) {
-        membershipMenu.addPopupMenuListener(l);
+    /**
+     * Replies the membership popup menu handler.
+     * @return The membership popup menu handler
+     */
+    public PopupMenuHandler getMembershipPopupMenuHandler() {
+        return membershipMenuHandler;
     }