source: josm/trunk/src/org/openstreetmap/josm/gui/ImageryMenu.java@ 10304

Last change on this file since 10304 was 10173, checked in by Don-vip, 8 years ago

sonar - squid:S1186 - Methods should not be empty
  • Property svn:eol-style set to native
File size: 10.4 KB
Line 
1// License: GPL. For details, see LICENSE file.
2package org.openstreetmap.josm.gui;
3
4import static org.openstreetmap.josm.tools.I18n.tr;
5import static org.openstreetmap.josm.tools.I18n.trc;
6
7import java.awt.Component;
8import java.awt.GraphicsEnvironment;
9import java.awt.MenuComponent;
10import java.awt.event.ActionEvent;
11import java.util.ArrayList;
12import java.util.Collection;
13import java.util.Collections;
14import java.util.Comparator;
15import java.util.Iterator;
16import java.util.List;
17import java.util.Locale;
18
19import javax.swing.Action;
20import javax.swing.JComponent;
21import javax.swing.JMenu;
22import javax.swing.JMenuItem;
23import javax.swing.JPopupMenu;
24import javax.swing.event.MenuEvent;
25import javax.swing.event.MenuListener;
26
27import org.openstreetmap.josm.Main;
28import org.openstreetmap.josm.actions.AddImageryLayerAction;
29import org.openstreetmap.josm.actions.JosmAction;
30import org.openstreetmap.josm.actions.MapRectifierWMSmenuAction;
31import org.openstreetmap.josm.data.coor.LatLon;
32import org.openstreetmap.josm.data.imagery.ImageryInfo;
33import org.openstreetmap.josm.data.imagery.ImageryLayerInfo;
34import org.openstreetmap.josm.data.imagery.Shape;
35import org.openstreetmap.josm.gui.MapView.LayerChangeListener;
36import org.openstreetmap.josm.gui.layer.ImageryLayer;
37import org.openstreetmap.josm.gui.layer.Layer;
38import org.openstreetmap.josm.gui.preferences.imagery.ImageryPreference;
39import org.openstreetmap.josm.tools.ImageProvider;
40
41/**
42 * Imagery menu, holding entries for imagery preferences, offset actions and dynamic imagery entries
43 * depending on current maview coordinates.
44 * @since 3737
45 */
46public class ImageryMenu extends JMenu implements LayerChangeListener {
47
48 /**
49 * Compare ImageryInfo objects alphabetically by name.
50 *
51 * ImageryInfo objects are normally sorted by country code first
52 * (for the preferences). We don't want this in the imagery menu.
53 */
54 public static final Comparator<ImageryInfo> alphabeticImageryComparator = new Comparator<ImageryInfo>() {
55 @Override
56 public int compare(ImageryInfo ii1, ImageryInfo ii2) {
57 return ii1.getName().toLowerCase(Locale.ENGLISH).compareTo(ii2.getName().toLowerCase(Locale.ENGLISH));
58 }
59 };
60
61 private final transient Action offsetAction = new JosmAction(
62 tr("Imagery offset"), "mapmode/adjustimg", tr("Adjust imagery offset"), null, false, false) {
63 {
64 putValue("toolbar", "imagery-offset");
65 Main.toolbar.register(this);
66 }
67
68 @Override
69 public void actionPerformed(ActionEvent e) {
70 Collection<ImageryLayer> layers = Main.map.mapView.getLayersOfType(ImageryLayer.class);
71 if (layers.isEmpty()) {
72 setEnabled(false);
73 return;
74 }
75 Component source = null;
76 if (e.getSource() instanceof Component) {
77 source = (Component) e.getSource();
78 }
79 JPopupMenu popup = new JPopupMenu();
80 if (layers.size() == 1) {
81 JComponent c = layers.iterator().next().getOffsetMenuItem(popup);
82 if (c instanceof JMenuItem) {
83 ((JMenuItem) c).getAction().actionPerformed(e);
84 } else {
85 if (source == null) return;
86 popup.show(source, source.getWidth()/2, source.getHeight()/2);
87 }
88 return;
89 }
90 if (source == null) return;
91 for (ImageryLayer layer : layers) {
92 JMenuItem layerMenu = layer.getOffsetMenuItem();
93 layerMenu.setText(layer.getName());
94 layerMenu.setIcon(layer.getIcon());
95 popup.add(layerMenu);
96 }
97 popup.show(source, source.getWidth()/2, source.getHeight()/2);
98 }
99 };
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 /* I18N: mnemonic: I */
111 super(trc("menu", "Imagery"));
112 setupMenuScroller();
113 MapView.addLayerChangeListener(this);
114 // build dynamically
115 addMenuListener(new MenuListener() {
116 @Override
117 public void menuSelected(MenuEvent e) {
118 refreshImageryMenu();
119 }
120
121 @Override
122 public void menuDeselected(MenuEvent e) {
123 // Do nothing
124 }
125
126 @Override
127 public void menuCanceled(MenuEvent e) {
128 // Do nothing
129 }
130 });
131 MainMenu.add(subMenu, rectaction);
132 }
133
134 private void setupMenuScroller() {
135 if (!GraphicsEnvironment.isHeadless()) {
136 MenuScroller.setScrollerFor(this, 150, 2);
137 }
138 }
139
140 /**
141 * Refresh imagery menu.
142 *
143 * Outside this class only called in {@link ImageryPreference#initialize()}.
144 * (In order to have actions ready for the toolbar, see #8446.)
145 */
146 public void refreshImageryMenu() {
147 removeDynamicItems();
148
149 addDynamic(offsetMenuItem);
150 addDynamicSeparator();
151
152 // for each configured ImageryInfo, add a menu entry.
153 final List<ImageryInfo> savedLayers = new ArrayList<>(ImageryLayerInfo.instance.getLayers());
154 Collections.sort(savedLayers, alphabeticImageryComparator);
155 for (final ImageryInfo u : savedLayers) {
156 addDynamic(new AddImageryLayerAction(u));
157 }
158
159 // list all imagery entries where the current map location
160 // is within the imagery bounds
161 if (Main.isDisplayingMapView()) {
162 MapView mv = Main.map.mapView;
163 LatLon pos = mv.getProjection().eastNorth2latlon(mv.getCenter());
164 final List<ImageryInfo> inViewLayers = new ArrayList<>();
165
166 for (ImageryInfo i : ImageryLayerInfo.instance.getDefaultLayers()) {
167 if (i.getBounds() != null && i.getBounds().contains(pos)) {
168 inViewLayers.add(i);
169 }
170 }
171 // Do not suggest layers already in use
172 inViewLayers.removeAll(ImageryLayerInfo.instance.getLayers());
173 // For layers containing complex shapes, check that center is in one
174 // of its shapes (fix #7910)
175 for (Iterator<ImageryInfo> iti = inViewLayers.iterator(); iti.hasNext();) {
176 List<Shape> shapes = iti.next().getBounds().getShapes();
177 if (shapes != null && !shapes.isEmpty()) {
178 boolean found = false;
179 for (Iterator<Shape> its = shapes.iterator(); its.hasNext() && !found;) {
180 found = its.next().contains(pos);
181 }
182 if (!found) {
183 iti.remove();
184 }
185 }
186 }
187 if (!inViewLayers.isEmpty()) {
188 Collections.sort(inViewLayers, alphabeticImageryComparator);
189 addDynamicSeparator();
190 for (ImageryInfo i : inViewLayers) {
191 addDynamic(new AddImageryLayerAction(i));
192 }
193 }
194 }
195
196 addDynamicSeparator();
197 JMenu subMenu = Main.main.menu.imagerySubMenu;
198 int heightUnrolled = 30*(getItemCount()+subMenu.getItemCount());
199 if (heightUnrolled < Main.panel.getHeight()) {
200 // add all items of submenu if they will fit on screen
201 int n = subMenu.getItemCount();
202 for (int i = 0; i < n; i++) {
203 addDynamic(subMenu.getItem(i).getAction());
204 }
205 } else {
206 // or add the submenu itself
207 addDynamic(subMenu);
208 }
209 }
210
211 private JMenuItem getNewOffsetMenu() {
212 if (!Main.isDisplayingMapView()) {
213 offsetAction.setEnabled(false);
214 return singleOffset;
215 }
216 Collection<ImageryLayer> layers = Main.map.mapView.getLayersOfType(ImageryLayer.class);
217 if (layers.isEmpty()) {
218 offsetAction.setEnabled(false);
219 return singleOffset;
220 }
221 offsetAction.setEnabled(true);
222 JMenu newMenu = new JMenu(trc("layer", "Offset"));
223 newMenu.setIcon(ImageProvider.get("mapmode", "adjustimg"));
224 newMenu.setAction(offsetAction);
225 if (layers.size() == 1)
226 return (JMenuItem) layers.iterator().next().getOffsetMenuItem(newMenu);
227 for (ImageryLayer layer : layers) {
228 JMenuItem layerMenu = layer.getOffsetMenuItem();
229 layerMenu.setText(layer.getName());
230 layerMenu.setIcon(layer.getIcon());
231 newMenu.add(layerMenu);
232 }
233 return newMenu;
234 }
235
236 public void refreshOffsetMenu() {
237 offsetMenuItem = getNewOffsetMenu();
238 }
239
240 @Override
241 public void activeLayerChange(Layer oldLayer, Layer newLayer) {
242 // Do nothing
243 }
244
245 @Override
246 public void layerAdded(Layer newLayer) {
247 if (newLayer instanceof ImageryLayer) {
248 refreshOffsetMenu();
249 }
250 }
251
252 @Override
253 public void layerRemoved(Layer oldLayer) {
254 if (oldLayer instanceof ImageryLayer) {
255 refreshOffsetMenu();
256 }
257 }
258
259 /**
260 * Collection to store temporary menu items. They will be deleted
261 * (and possibly recreated) when refreshImageryMenu() is called.
262 * @since 5803
263 */
264 private final List<Object> dynamicItems = new ArrayList<>(20);
265
266 /**
267 * Remove all the items in @field dynamicItems collection
268 * @since 5803
269 */
270 private void removeDynamicItems() {
271 for (Object item : dynamicItems) {
272 if (item instanceof JMenuItem) {
273 remove((JMenuItem) item);
274 }
275 if (item instanceof MenuComponent) {
276 remove((MenuComponent) item);
277 }
278 if (item instanceof Component) {
279 remove((Component) item);
280 }
281 }
282 dynamicItems.clear();
283 }
284
285 private void addDynamicSeparator() {
286 JPopupMenu.Separator s = new JPopupMenu.Separator();
287 dynamicItems.add(s);
288 add(s);
289 }
290
291 private void addDynamic(Action a) {
292 dynamicItems.add(this.add(a));
293 }
294
295 private void addDynamic(JMenuItem it) {
296 dynamicItems.add(this.add(it));
297 }
298}
Note: See TracBrowser for help on using the repository browser.