001// License: GPL. For details, see LICENSE file.
002package org.openstreetmap.josm.gui;
003
004import static org.openstreetmap.josm.tools.I18n.tr;
005import static org.openstreetmap.josm.tools.I18n.trc;
006
007import java.awt.Component;
008import java.awt.GraphicsEnvironment;
009import java.awt.MenuComponent;
010import java.awt.event.ActionEvent;
011import java.util.ArrayList;
012import java.util.Collection;
013import java.util.Collections;
014import java.util.Comparator;
015import java.util.Iterator;
016import java.util.List;
017import java.util.Locale;
018
019import javax.swing.Action;
020import javax.swing.JComponent;
021import javax.swing.JMenu;
022import javax.swing.JMenuItem;
023import javax.swing.JPopupMenu;
024import javax.swing.event.MenuEvent;
025import javax.swing.event.MenuListener;
026
027import org.openstreetmap.josm.Main;
028import org.openstreetmap.josm.actions.AddImageryLayerAction;
029import org.openstreetmap.josm.actions.JosmAction;
030import org.openstreetmap.josm.actions.MapRectifierWMSmenuAction;
031import org.openstreetmap.josm.data.coor.LatLon;
032import org.openstreetmap.josm.data.imagery.ImageryInfo;
033import org.openstreetmap.josm.data.imagery.ImageryLayerInfo;
034import org.openstreetmap.josm.data.imagery.Shape;
035import org.openstreetmap.josm.gui.MapView.LayerChangeListener;
036import org.openstreetmap.josm.gui.layer.ImageryLayer;
037import org.openstreetmap.josm.gui.layer.Layer;
038import org.openstreetmap.josm.gui.preferences.imagery.ImageryPreference;
039import org.openstreetmap.josm.tools.ImageProvider;
040
041/**
042 * Imagery menu, holding entries for imagery preferences, offset actions and dynamic imagery entries
043 * depending on current maview coordinates.
044 * @since 3737
045 */
046public class ImageryMenu extends JMenu implements LayerChangeListener {
047
048    /**
049     * Compare ImageryInfo objects alphabetically by name.
050     *
051     * ImageryInfo objects are normally sorted by country code first
052     * (for the preferences). We don't want this in the imagery menu.
053     */
054    public static final Comparator<ImageryInfo> alphabeticImageryComparator = new Comparator<ImageryInfo>() {
055        @Override
056        public int compare(ImageryInfo ii1, ImageryInfo ii2) {
057            return ii1.getName().toLowerCase(Locale.ENGLISH).compareTo(ii2.getName().toLowerCase(Locale.ENGLISH));
058        }
059    };
060
061    private transient Action offsetAction = new JosmAction(
062            tr("Imagery offset"), "mapmode/adjustimg", tr("Adjust imagery offset"), null, false, false) {
063        {
064            putValue("toolbar", "imagery-offset");
065            Main.toolbar.register(this);
066        }
067
068        @Override
069        public void actionPerformed(ActionEvent e) {
070            Collection<ImageryLayer> layers = Main.map.mapView.getLayersOfType(ImageryLayer.class);
071            if (layers.isEmpty()) {
072                setEnabled(false);
073                return;
074            }
075            Component source = null;
076            if (e.getSource() instanceof Component) {
077                source = (Component) e.getSource();
078            }
079            JPopupMenu popup = new JPopupMenu();
080            if (layers.size() == 1) {
081                JComponent c = layers.iterator().next().getOffsetMenuItem(popup);
082                if (c instanceof JMenuItem) {
083                    ((JMenuItem) c).getAction().actionPerformed(e);
084                } else {
085                    if (source == null) return;
086                    popup.show(source, source.getWidth()/2, source.getHeight()/2);
087                }
088                return;
089            }
090            if (source == null) return;
091            for (ImageryLayer layer : layers) {
092                JMenuItem layerMenu = layer.getOffsetMenuItem();
093                layerMenu.setText(layer.getName());
094                layerMenu.setIcon(layer.getIcon());
095                popup.add(layerMenu);
096            }
097            popup.show(source, source.getWidth()/2, source.getHeight()/2);
098        }
099    };
100
101    private final JMenuItem singleOffset = new JMenuItem(offsetAction);
102    private JMenuItem offsetMenuItem = singleOffset;
103    private final MapRectifierWMSmenuAction rectaction = new MapRectifierWMSmenuAction();
104
105    /**
106     * Constructs a new {@code ImageryMenu}.
107     * @param subMenu submenu in that contains plugin-managed additional imagery layers
108     */
109    public ImageryMenu(JMenu subMenu) {
110        super(trc("menu", "Imagery"));
111        setupMenuScroller();
112        MapView.addLayerChangeListener(this);
113        // build dynamically
114        addMenuListener(new MenuListener() {
115            @Override
116            public void menuSelected(MenuEvent e) {
117                refreshImageryMenu();
118            }
119
120            @Override
121            public void menuDeselected(MenuEvent e) {
122            }
123
124            @Override
125            public void menuCanceled(MenuEvent e) {
126            }
127        });
128        MainMenu.add(subMenu, rectaction);
129    }
130
131    private void setupMenuScroller() {
132        if (!GraphicsEnvironment.isHeadless()) {
133            MenuScroller.setScrollerFor(this, 150, 2);
134        }
135    }
136
137    /**
138     * Refresh imagery menu.
139     *
140     * Outside this class only called in {@link ImageryPreference#initialize()}.
141     * (In order to have actions ready for the toolbar, see #8446.)
142     */
143    public void refreshImageryMenu() {
144        removeDynamicItems();
145
146        addDynamic(offsetMenuItem);
147        addDynamicSeparator();
148
149        // for each configured ImageryInfo, add a menu entry.
150        final List<ImageryInfo> savedLayers = new ArrayList<>(ImageryLayerInfo.instance.getLayers());
151        Collections.sort(savedLayers, alphabeticImageryComparator);
152        for (final ImageryInfo u : savedLayers) {
153            addDynamic(new AddImageryLayerAction(u));
154        }
155
156        // list all imagery entries where the current map location
157        // is within the imagery bounds
158        if (Main.isDisplayingMapView()) {
159            MapView mv = Main.map.mapView;
160            LatLon pos = mv.getProjection().eastNorth2latlon(mv.getCenter());
161            final List<ImageryInfo> inViewLayers = new ArrayList<>();
162
163            for (ImageryInfo i : ImageryLayerInfo.instance.getDefaultLayers()) {
164                if (i.getBounds() != null && i.getBounds().contains(pos)) {
165                    inViewLayers.add(i);
166                }
167            }
168            // Do not suggest layers already in use
169            inViewLayers.removeAll(ImageryLayerInfo.instance.getLayers());
170            // For layers containing complex shapes, check that center is in one
171            // of its shapes (fix #7910)
172            for (Iterator<ImageryInfo> iti = inViewLayers.iterator(); iti.hasNext();) {
173                List<Shape> shapes = iti.next().getBounds().getShapes();
174                if (shapes != null && !shapes.isEmpty()) {
175                    boolean found = false;
176                    for (Iterator<Shape> its = shapes.iterator(); its.hasNext() && !found;) {
177                        found = its.next().contains(pos);
178                    }
179                    if (!found) {
180                        iti.remove();
181                    }
182                }
183            }
184            if (!inViewLayers.isEmpty()) {
185                Collections.sort(inViewLayers, alphabeticImageryComparator);
186                addDynamicSeparator();
187                for (ImageryInfo i : inViewLayers) {
188                    addDynamic(new AddImageryLayerAction(i));
189                }
190            }
191        }
192
193        addDynamicSeparator();
194        JMenu subMenu = Main.main.menu.imagerySubMenu;
195        int heightUnrolled = 30*(getItemCount()+subMenu.getItemCount());
196        if (heightUnrolled < Main.panel.getHeight()) {
197            // add all items of submenu if they will fit on screen
198            int n = subMenu.getItemCount();
199            for (int i = 0; i < n; i++) {
200                addDynamic(subMenu.getItem(i).getAction());
201            }
202        } else {
203            // or add the submenu itself
204            addDynamic(subMenu);
205        }
206    }
207
208    private JMenuItem getNewOffsetMenu() {
209        if (!Main.isDisplayingMapView()) {
210            offsetAction.setEnabled(false);
211            return singleOffset;
212        }
213        Collection<ImageryLayer> layers = Main.map.mapView.getLayersOfType(ImageryLayer.class);
214        if (layers.isEmpty()) {
215            offsetAction.setEnabled(false);
216            return singleOffset;
217        }
218        offsetAction.setEnabled(true);
219        JMenu newMenu = new JMenu(trc("layer", "Offset"));
220        newMenu.setIcon(ImageProvider.get("mapmode", "adjustimg"));
221        newMenu.setAction(offsetAction);
222        if (layers.size() == 1)
223            return (JMenuItem) layers.iterator().next().getOffsetMenuItem(newMenu);
224        for (ImageryLayer layer : layers) {
225            JMenuItem layerMenu = layer.getOffsetMenuItem();
226            layerMenu.setText(layer.getName());
227            layerMenu.setIcon(layer.getIcon());
228            newMenu.add(layerMenu);
229        }
230        return newMenu;
231    }
232
233    public void refreshOffsetMenu() {
234        offsetMenuItem = getNewOffsetMenu();
235    }
236
237    @Override
238    public void activeLayerChange(Layer oldLayer, Layer newLayer) {
239    }
240
241    @Override
242    public void layerAdded(Layer newLayer) {
243        if (newLayer instanceof ImageryLayer) {
244            refreshOffsetMenu();
245        }
246    }
247
248    @Override
249    public void layerRemoved(Layer oldLayer) {
250        if (oldLayer instanceof ImageryLayer) {
251            refreshOffsetMenu();
252        }
253    }
254
255    /**
256     * Collection to store temporary menu items. They will be deleted
257     * (and possibly recreated) when refreshImageryMenu() is called.
258     * @since 5803
259     */
260    private List<Object> dynamicItems = new ArrayList<>(20);
261
262    /**
263     * Remove all the items in @field dynamicItems collection
264     * @since 5803
265     */
266    private void removeDynamicItems() {
267        for (Object item : dynamicItems) {
268            if (item instanceof JMenuItem) {
269                remove((JMenuItem) item);
270            }
271            if (item instanceof MenuComponent) {
272                remove((MenuComponent) item);
273            }
274            if (item instanceof Component) {
275                remove((Component) item);
276            }
277        }
278        dynamicItems.clear();
279    }
280
281    private void addDynamicSeparator() {
282        JPopupMenu.Separator s =  new JPopupMenu.Separator();
283        dynamicItems.add(s);
284        add(s);
285    }
286
287    private void addDynamic(Action a) {
288        dynamicItems.add(this.add(a));
289    }
290
291    private void addDynamic(JMenuItem it) {
292        dynamicItems.add(this.add(it));
293    }
294}