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

Last change on this file since 2104 was 2025, checked in by Gubaer, 15 years ago

new: improved dialog for uploading/saving modified layers on exit
new: improved dialog for uploading/saving modified layers if layers are deleted
new: new progress monitor which can delegate rendering to any Swing component
more setters/getters for properties in OSM data classes (fields are @deprecated); started to update references in the code base

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