source: josm/trunk/src/org/openstreetmap/josm/gui/MapView.java@ 2646

Last change on this file since 2646 was 2626, checked in by jttt, 14 years ago

Fixed some of the warnings found by FindBugs
  • Property svn:eol-style set to native
File size: 23.2 KB
Line 
1// License: GPL. See LICENSE file for details.
2
3package org.openstreetmap.josm.gui;
4
5import static org.openstreetmap.josm.tools.I18n.tr;
6
7import java.awt.Color;
8import java.awt.Graphics;
9import java.awt.Graphics2D;
10import java.awt.Point;
11import java.awt.Rectangle;
12import java.awt.event.ComponentAdapter;
13import java.awt.event.ComponentEvent;
14import java.awt.event.MouseEvent;
15import java.awt.event.MouseMotionListener;
16import java.awt.geom.Area;
17import java.awt.geom.GeneralPath;
18import java.awt.image.BufferedImage;
19import java.beans.PropertyChangeEvent;
20import java.beans.PropertyChangeListener;
21import java.util.ArrayList;
22import java.util.Collection;
23import java.util.Collections;
24import java.util.Comparator;
25import java.util.Enumeration;
26import java.util.LinkedList;
27import java.util.List;
28import java.util.concurrent.CopyOnWriteArrayList;
29
30import javax.swing.AbstractButton;
31import javax.swing.JComponent;
32import javax.swing.JOptionPane;
33
34import org.openstreetmap.josm.Main;
35import org.openstreetmap.josm.actions.AutoScaleAction;
36import org.openstreetmap.josm.actions.JosmAction;
37import org.openstreetmap.josm.actions.MoveAction;
38import org.openstreetmap.josm.actions.mapmode.MapMode;
39import org.openstreetmap.josm.data.Bounds;
40import org.openstreetmap.josm.data.SelectionChangedListener;
41import org.openstreetmap.josm.data.coor.LatLon;
42import org.openstreetmap.josm.data.osm.DataSet;
43import org.openstreetmap.josm.data.osm.DataSource;
44import org.openstreetmap.josm.data.osm.OsmPrimitive;
45import org.openstreetmap.josm.data.osm.visitor.BoundingXYVisitor;
46import org.openstreetmap.josm.gui.layer.GpxLayer;
47import org.openstreetmap.josm.gui.layer.Layer;
48import org.openstreetmap.josm.gui.layer.MapViewPaintable;
49import org.openstreetmap.josm.gui.layer.OsmDataLayer;
50import org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer;
51import org.openstreetmap.josm.gui.layer.markerlayer.PlayHeadMarker;
52import org.openstreetmap.josm.tools.AudioPlayer;
53
54/**
55 * This is a component used in the MapFrame for browsing the map. It use is to
56 * provide the MapMode's enough capabilities to operate.
57 *
58 * MapView hold meta-data about the data set currently displayed, as scale level,
59 * center point viewed, what scrolling mode or editing mode is selected or with
60 * what projection the map is viewed etc..
61 *
62 * MapView is able to administrate several layers.
63 *
64 * @author imi
65 */
66public class MapView extends NavigatableComponent implements PropertyChangeListener {
67
68 /**
69 * Interface to notify listeners of the change of the active layer.
70 * @author imi
71 */
72 public interface LayerChangeListener {
73 void activeLayerChange(Layer oldLayer, Layer newLayer);
74 void layerAdded(Layer newLayer);
75 void layerRemoved(Layer oldLayer);
76 }
77
78 /**
79 * the layer listeners
80 */
81 private static final Collection<MapView.LayerChangeListener> layerChangeListeners = new CopyOnWriteArrayList<MapView.LayerChangeListener>();
82
83 /**
84 * Removes a layer change listener
85 *
86 * @param listener the listener. Ignored if null or already registered.
87 */
88 public static void removeLayerChangeListener(MapView.LayerChangeListener listener) {
89 if (listener != null && layerChangeListeners.contains(listener)) {
90 layerChangeListeners.remove(listener);
91 }
92 }
93
94 /**
95 * Adds a layer change listener
96 *
97 * @param listener the listener. Ignored if null or already registered.
98 */
99 public static void addLayerChangeListener(MapView.LayerChangeListener listener) {
100 if (listener != null && ! layerChangeListeners.contains(listener)) {
101 layerChangeListeners.add(listener);
102 }
103 }
104
105 protected static void fireActiveLayerChanged(Layer oldLayer, Layer newLayer) {
106 for (LayerChangeListener l : layerChangeListeners) {
107 l.activeLayerChange(oldLayer, newLayer);
108 }
109 }
110
111 protected static void fireLayerAdded(Layer newLayer) {
112 for (MapView.LayerChangeListener l : MapView.layerChangeListeners) {
113 l.layerAdded(newLayer);
114 }
115 }
116
117 protected static void fireLayerRemoved(Layer layer) {
118 for (MapView.LayerChangeListener l : MapView.layerChangeListeners) {
119 l.layerRemoved(layer);
120 }
121 }
122
123 /**
124 * A list of all layers currently loaded.
125 */
126 private ArrayList<Layer> layers = new ArrayList<Layer>();
127 /**
128 * The play head marker: there is only one of these so it isn't in any specific layer
129 */
130 public PlayHeadMarker playHeadMarker = null;
131
132 /**
133 * The layer from the layers list that is currently active.
134 */
135 private Layer activeLayer;
136
137 /**
138 * The last event performed by mouse.
139 */
140 public MouseEvent lastMEvent;
141
142 private LinkedList<MapViewPaintable> temporaryLayers = new LinkedList<MapViewPaintable>();
143
144 private BufferedImage offscreenBuffer;
145
146 public MapView() {
147 addComponentListener(new ComponentAdapter(){
148 @Override public void componentResized(ComponentEvent e) {
149 removeComponentListener(this);
150
151 MapSlider zoomSlider = new MapSlider(MapView.this);
152 add(zoomSlider);
153 zoomSlider.setBounds(3, 0, 114, 30);
154
155 MapScaler scaler = new MapScaler(MapView.this);
156 add(scaler);
157 scaler.setLocation(10,30);
158
159 if (!zoomToEditLayerBoundingBox()) {
160 new AutoScaleAction("data").actionPerformed(null);
161 }
162
163 new MapMover(MapView.this, Main.contentPane);
164 JosmAction mv;
165 mv = new MoveAction(MoveAction.Direction.UP);
166 if (mv.getShortcut() != null) {
167 Main.contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(mv.getShortcut().getKeyStroke(), "UP");
168 Main.contentPane.getActionMap().put("UP", mv);
169 }
170 mv = new MoveAction(MoveAction.Direction.DOWN);
171 if (mv.getShortcut() != null) {
172 Main.contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(mv.getShortcut().getKeyStroke(), "DOWN");
173 Main.contentPane.getActionMap().put("DOWN", mv);
174 }
175 mv = new MoveAction(MoveAction.Direction.LEFT);
176 if (mv.getShortcut() != null) {
177 Main.contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(mv.getShortcut().getKeyStroke(), "LEFT");
178 Main.contentPane.getActionMap().put("LEFT", mv);
179 }
180 mv = new MoveAction(MoveAction.Direction.RIGHT);
181 if (mv.getShortcut() != null) {
182 Main.contentPane.getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(mv.getShortcut().getKeyStroke(), "RIGHT");
183 Main.contentPane.getActionMap().put("RIGHT", mv);
184 }
185 }
186 });
187
188 // listend to selection changes to redraw the map
189 DataSet.selListeners.add(new SelectionChangedListener(){
190 public void selectionChanged(Collection<? extends OsmPrimitive> newSelection) {
191 repaint();
192 }
193 });
194
195 //store the last mouse action
196 this.addMouseMotionListener(new MouseMotionListener() {
197 public void mouseDragged(MouseEvent e) {
198 mouseMoved(e);
199 }
200 public void mouseMoved(MouseEvent e) {
201 lastMEvent = e;
202 }
203 });
204 }
205
206 /**
207 * Adds a GPX layer. A GPX layer is added below the lowest data layer.
208 *
209 * @param layer the GPX layer
210 */
211 protected void addGpxLayer(GpxLayer layer) {
212 if (layers.isEmpty()) {
213 layers.add(layer);
214 return;
215 }
216 for (int i=layers.size()-1; i>= 0; i--) {
217 if (layers.get(i) instanceof OsmDataLayer) {
218 if (i == layers.size()-1) {
219 layers.add(layer);
220 } else {
221 layers.add(i+1, layer);
222 }
223 return;
224 }
225 }
226 layers.add(layer);
227 }
228
229 /**
230 * Add a layer to the current MapView. The layer will be added at topmost
231 * position.
232 */
233 public void addLayer(Layer layer) {
234 if (layer instanceof MarkerLayer && playHeadMarker == null) {
235 playHeadMarker = PlayHeadMarker.create();
236 }
237
238 if (layer instanceof GpxLayer) {
239 addGpxLayer((GpxLayer)layer);
240 } else if (layer.isBackgroundLayer() || layers.isEmpty()) {
241 layers.add(layer);
242 } else {
243 layers.add(0, layer);
244 }
245 fireLayerAdded(layer);
246 if (layer instanceof OsmDataLayer || activeLayer == null) {
247 // autoselect the new layer
248 setActiveLayer(layer);
249 }
250 layer.addPropertyChangeListener(this);
251 AudioPlayer.reset();
252 repaint();
253 }
254
255 @Override
256 protected DataSet getCurrentDataSet() {
257 if(activeLayer != null && activeLayer instanceof OsmDataLayer)
258 return ((OsmDataLayer)activeLayer).data;
259 return null;
260 }
261
262 /**
263 * Replies true if the active layer is drawable.
264 *
265 * @return true if the active layer is drawable, false otherwise
266 */
267 public boolean isActiveLayerDrawable() {
268 return activeLayer != null && activeLayer instanceof OsmDataLayer;
269 }
270
271 /**
272 * Replies true if the active layer is visible.
273 *
274 * @return true if the active layer is visible, false otherwise
275 */
276 public boolean isActiveLayerVisible() {
277 return isActiveLayerDrawable() && activeLayer.isVisible();
278 }
279
280
281 /**
282 * Determines the next active data layer according to the following
283 * rules:
284 * <ul>
285 * <li>if there is at least one {@see OsmDataLayer} the first one
286 * becomes active</li>
287 * <li>otherwise, the top most layer of any type becomes active</li>
288 * </ul>
289 *
290 * @return the next active data layer
291 */
292 protected Layer determineNextActiveLayer() {
293 if (layers.isEmpty()) return null;
294 // if possible, activate the first data layer
295 //
296 List<OsmDataLayer> dataLayers = getLayersOfType(OsmDataLayer.class);
297 if (!dataLayers.isEmpty())
298 return dataLayers.get(0);
299
300 // else the first layer of any type
301 //
302 return layers.get(0);
303 }
304
305 /**
306 * Remove the layer from the mapview. If the layer was in the list before,
307 * an LayerChange event is fired.
308 */
309 public void removeLayer(Layer layer) {
310 boolean deletedLayerWasActiveLayer = false;
311
312 if (layer == activeLayer) {
313 activeLayer = null;
314 deletedLayerWasActiveLayer = true;
315 fireActiveLayerChanged(layer, null);
316 }
317 if (layers.remove(layer)) {
318 fireLayerRemoved(layer);
319 }
320 layer.removePropertyChangeListener(this);
321 layer.destroy();
322 AudioPlayer.reset();
323 if (deletedLayerWasActiveLayer) {
324 Layer l = determineNextActiveLayer();
325 if (l != null) {
326 activeLayer = l;
327 fireActiveLayerChanged(null, l);
328 }
329 }
330 repaint();
331 }
332
333 private boolean virtualNodesEnabled = false;
334
335 public void setVirtualNodesEnabled(boolean enabled) {
336 if(virtualNodesEnabled != enabled) {
337 virtualNodesEnabled = enabled;
338 repaint();
339 }
340 }
341 public boolean isVirtualNodesEnabled() {
342 return virtualNodesEnabled;
343 }
344
345 /**
346 * Moves the layer to the given new position. No event is fired, but repaints
347 * according to the new Z-Order of the layers.
348 *
349 * @param layer The layer to move
350 * @param pos The new position of the layer
351 */
352 public void moveLayer(Layer layer, int pos) {
353 int curLayerPos = layers.indexOf(layer);
354 if (curLayerPos == -1)
355 throw new IllegalArgumentException(tr("Layer not in list."));
356 if (pos == curLayerPos)
357 return; // already in place.
358 layers.remove(curLayerPos);
359 if (pos >= layers.size()) {
360 layers.add(layer);
361 } else {
362 layers.add(pos, layer);
363 }
364 AudioPlayer.reset();
365 repaint();
366 }
367
368 public int getLayerPos(Layer layer) {
369 int curLayerPos = layers.indexOf(layer);
370 if (curLayerPos == -1)
371 throw new IllegalArgumentException(tr("Layer not in list."));
372 return curLayerPos;
373 }
374
375 /**
376 * Creates a list of the visible layers in Z-Order, the layer with the lowest Z-Order
377 * first, layer with the highest Z-Order last.
378 *
379 * @return a list of the visible in Z-Order, the layer with the lowest Z-Order
380 * first, layer with the highest Z-Order last.
381 */
382 protected List<Layer> getVisibleLayersInZOrder() {
383 ArrayList<Layer> ret = new ArrayList<Layer>();
384 for (Layer l: layers) {
385 if (l.isVisible()) {
386 ret.add(l);
387 }
388 }
389 // sort according to position in the list of layers, with one exception:
390 // an active data layer always becomes a higher Z-Order than all other
391 // data layers
392 //
393 Collections.sort(
394 ret,
395 new Comparator<Layer>() {
396 public int compare(Layer l1, Layer l2) {
397 if (l1 instanceof OsmDataLayer && l2 instanceof OsmDataLayer) {
398 if (l1 == getActiveLayer()) return -1;
399 if (l2 == getActiveLayer()) return 1;
400 return Integer.valueOf(layers.indexOf(l1)).compareTo(layers.indexOf(l2));
401 } else
402 return Integer.valueOf(layers.indexOf(l1)).compareTo(layers.indexOf(l2));
403 }
404 }
405 );
406 Collections.reverse(ret);
407 return ret;
408 }
409
410 /**
411 * Draw the component.
412 */
413 @Override public void paint(Graphics g) {
414 if (center == null)
415 return; // no data loaded yet.
416
417 // re-create offscreen-buffer if we've been resized, otherwise
418 // just re-use it.
419 if (null == offscreenBuffer || offscreenBuffer.getWidth() != getWidth()
420 || offscreenBuffer.getHeight() != getHeight()) {
421 offscreenBuffer = new BufferedImage(getWidth(), getHeight(),
422 BufferedImage.TYPE_INT_ARGB);
423 }
424
425 Graphics2D tempG = offscreenBuffer.createGraphics();
426 tempG.setClip(g.getClip());
427 tempG.setColor(Main.pref.getColor("background", Color.BLACK));
428 tempG.fillRect(0, 0, getWidth(), getHeight());
429
430 Bounds box = getLatLonBounds(g.getClipBounds());
431
432 for (Layer l: getVisibleLayersInZOrder()) {
433 l.paint(tempG, this, box);
434 }
435 for (MapViewPaintable mvp : temporaryLayers) {
436 mvp.paint(tempG, this, box);
437 }
438
439 // draw world borders
440 tempG.setColor(Color.WHITE);
441 Bounds b = getProjection().getWorldBoundsLatLon();
442 double lat = b.getMin().lat();
443 double lon = b.getMin().lon();
444
445 Point p = getPoint(b.getMin());
446
447 GeneralPath path = new GeneralPath();
448
449 path.moveTo(p.x, p.y);
450 double max = b.getMax().lat();
451 for(; lat <= max; lat += 1.0)
452 {
453 p = getPoint(new LatLon(lat >= max ? max : lat, lon));
454 path.lineTo(p.x, p.y);
455 }
456 lat = max; max = b.getMax().lon();
457 for(; lon <= max; lon += 1.0)
458 {
459 p = getPoint(new LatLon(lat, lon >= max ? max : lon));
460 path.lineTo(p.x, p.y);
461 }
462 lon = max; max = b.getMin().lat();
463 for(; lat >= max; lat -= 1.0)
464 {
465 p = getPoint(new LatLon(lat <= max ? max : lat, lon));
466 path.lineTo(p.x, p.y);
467 }
468 lat = max; max = b.getMin().lon();
469 for(; lon >= max; lon -= 1.0)
470 {
471 p = getPoint(new LatLon(lat, lon <= max ? max : lon));
472 path.lineTo(p.x, p.y);
473 }
474
475 int w = offscreenBuffer.getWidth();
476 int h = offscreenBuffer.getHeight();
477
478 // Work around OpenJDK having problems when drawing out of bounds
479 final Area border = new Area(path);
480 // Make the viewport 1px larger in every direction to prevent an
481 // additional 1px border when zooming in
482 final Area viewport = new Area(new Rectangle(-1, -1, w + 2, h + 2));
483 border.intersect(viewport);
484 tempG.draw(border);
485
486 if (playHeadMarker != null) {
487 playHeadMarker.paint(tempG, this);
488 }
489
490 g.drawImage(offscreenBuffer, 0, 0, null);
491 super.paint(g);
492 }
493
494 /**
495 * Set the new dimension to the view.
496 */
497 public void recalculateCenterScale(BoundingXYVisitor box) {
498 if (box == null) {
499 box = new BoundingXYVisitor();
500 }
501 if (box.getBounds() == null) {
502 box.visit(getProjection().getWorldBoundsLatLon());
503 }
504 if (!box.hasExtend()) {
505 box.enlargeBoundingBox();
506 }
507
508 zoomTo(box.getBounds());
509 }
510
511 /**
512 * @return An unmodifiable collection of all layers
513 */
514 public Collection<Layer> getAllLayers() {
515 return Collections.unmodifiableCollection(layers);
516 }
517
518 /**
519 * @return An unmodifiable ordered list of all layers
520 */
521 public List<Layer> getAllLayersAsList() {
522 return Collections.unmodifiableList(layers);
523 }
524
525 /**
526 * Replies an unmodifiable list of layers of a certain type.
527 *
528 * Example:
529 * <pre>
530 * List<WMSLayer> wmsLayers = getLayersOfType(WMSLayer.class);
531 * </pre>
532 *
533 * @return an unmodifiable list of layers of a certain type.
534 */
535 public <T> List<T> getLayersOfType(Class<T> ofType) {
536 ArrayList<T> ret = new ArrayList<T>();
537 for (Layer layer : getAllLayersAsList()) {
538 if (ofType.isInstance(layer)) {
539 ret.add(ofType.cast(layer));
540 }
541 }
542 return ret;
543 }
544
545 /**
546 * Replies the number of layers managed by this mav view
547 *
548 * @return the number of layers managed by this mav view
549 */
550 public int getNumLayers() {
551 return layers.size();
552 }
553
554 /**
555 * Replies true if there is at least one layer in this map view
556 *
557 * @return true if there is at least one layer in this map view
558 */
559 public boolean hasLayers() {
560 return getNumLayers() > 0;
561 }
562
563 /**
564 * Sets the active layer to <code>layer</code>. If <code>layer</code> is an instance
565 * of {@see OsmDataLayer} also sets {@see #editLayer} to <code>layer</code>.
566 *
567 * @param layer the layer to be activate; must be one of the layers in the list of layers
568 * @exception IllegalArgumentException thrown if layer is not in the lis of layers
569 */
570 public void setActiveLayer(Layer layer) {
571 if (!layers.contains(layer))
572 throw new IllegalArgumentException(tr("Layer ''{0}'' must be in list of layers", layer.toString()));
573 if (! (layer instanceof OsmDataLayer)) {
574 if (getCurrentDataSet() != null) {
575 getCurrentDataSet().setSelected();
576 }
577 }
578 Layer old = activeLayer;
579 activeLayer = layer;
580 if (old != layer) {
581 fireActiveLayerChanged(old, layer);
582 }
583 if (layer instanceof OsmDataLayer) {
584 refreshTitle((OsmDataLayer)layer);
585 }
586
587 /* This only makes the buttons look disabled. Disabling the actions as well requires
588 * the user to re-select the tool after i.e. moving a layer. While testing I found
589 * that I switch layers and actions at the same time and it was annoying to mind the
590 * order. This way it works as visual clue for new users */
591 for (Enumeration<AbstractButton> e = Main.map.toolGroup.getElements() ; e.hasMoreElements() ;) {
592 AbstractButton x=e.nextElement();
593 x.setEnabled(((MapMode)x.getAction()).layerIsSupported(layer));
594 }
595 AudioPlayer.reset();
596 repaint();
597 }
598
599 /**
600 * Replies the currently active layer
601 *
602 * @return the currently active layer (may be null)
603 */
604 public Layer getActiveLayer() {
605 return activeLayer;
606 }
607
608 /**
609 * Replies the current edit layer, if any
610 *
611 * @return the current edit layer. May be null.
612 */
613 public OsmDataLayer getEditLayer() {
614 if (activeLayer instanceof OsmDataLayer)
615 return (OsmDataLayer)activeLayer;
616
617 // the first OsmDataLayer is the edit layer
618 //
619 for (Layer layer : layers) {
620 if (layer instanceof OsmDataLayer)
621 return (OsmDataLayer)layer;
622 }
623 return null;
624 }
625
626 /**
627 * replies true if the list of layers managed by this map view contain layer
628 *
629 * @param layer the layer
630 * @return true if the list of layers managed by this map view contain layer
631 */
632 public boolean hasLayer(Layer layer) {
633 return layers.contains(layer);
634 }
635
636 /**
637 * Tries to zoom to the download boundingbox[es] of the current edit layer
638 * (aka {@link OsmDataLayer}). If the edit layer has multiple download bounding
639 * boxes it zooms to a large virtual bounding box containing all smaller ones.
640 * This implementation can be used for resolving ticket #1461.
641 *
642 * @return <code>true</code> if a zoom operation has been performed
643 */
644 public boolean zoomToEditLayerBoundingBox() {
645 // workaround for #1461 (zoom to download bounding box instead of all data)
646 // In case we already have an existing data layer ...
647 OsmDataLayer layer= getEditLayer();
648 if (layer == null)
649 return false;
650 Collection<DataSource> dataSources = layer.data.dataSources;
651 // ... with bounding box[es] of data loaded from OSM or a file...
652 BoundingXYVisitor bbox = new BoundingXYVisitor();
653 for (DataSource ds : dataSources) {
654 bbox.visit(ds.bounds);
655 if (bbox.hasExtend()) {
656 // ... we zoom to it's bounding box
657 recalculateCenterScale(bbox);
658 return true;
659 }
660 }
661 return false;
662 }
663
664 public boolean addTemporaryLayer(MapViewPaintable mvp) {
665 if (temporaryLayers.contains(mvp)) return false;
666 return temporaryLayers.add(mvp);
667 }
668
669 public boolean removeTemporaryLayer(MapViewPaintable mvp) {
670 return temporaryLayers.remove(mvp);
671 }
672
673 public void propertyChange(PropertyChangeEvent evt) {
674 if (evt.getPropertyName().equals(Layer.VISIBLE_PROP)) {
675 repaint();
676 } else if (evt.getPropertyName().equals(OsmDataLayer.REQUIRES_SAVE_TO_DISK_PROP)
677 || evt.getPropertyName().equals(OsmDataLayer.REQUIRES_UPLOAD_TO_SERVER_PROP)) {
678 OsmDataLayer layer = (OsmDataLayer)evt.getSource();
679 if (layer == getEditLayer()) {
680 refreshTitle(layer);
681 }
682 }
683 }
684
685 protected void refreshTitle(OsmDataLayer layer) {
686 boolean dirty = layer.requiresSaveToFile() || layer.requiresUploadToServer();
687 if (dirty) {
688 JOptionPane.getFrameForComponent(Main.parent).setTitle("* " + tr("Java OpenStreetMap Editor"));
689 } else {
690 JOptionPane.getFrameForComponent(Main.parent).setTitle(tr("Java OpenStreetMap Editor"));
691 }
692 }
693
694}
Note: See TracBrowser for help on using the repository browser.