Package org.openstreetmap.josm.gui

Class MapView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

org.openstreetmap.josm.gui.NavigatableComponent

org.openstreetmap.josm.gui.MapView

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, Helpful, LayerManager.LayerChangeListener, MainLayerManager.ActiveLayerChangeListener, PreferenceChangedListener

public class MapView
extends NavigatableComponent
implements java.beans.PropertyChangeListener, PreferenceChangedListener, LayerManager.LayerChangeListener, MainLayerManager.ActiveLayerChangeListener

This is a component used in the MapFrame for browsing the map. It use is to provide the MapMode's enough capabilities to operate.

MapView holds meta-data about the data set currently displayed, as scale level, center point viewed, what scrolling mode or editing mode is selected or with what projection the map is viewed etc..

MapView is able to administrate several layers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	MapView.LayerInvalidatedListener	An invalidation listener that simply calls repaint() for now.
static interface	MapView.RepaintListener	This is a listener that gets informed whenever repaint is called for this MapView.
private static class	MapView.WarningLayerPainter	A layer painter that issues a warning when being called.

Nested classes/interfaces inherited from class org.openstreetmap.josm.gui.NavigatableComponent

NavigatableComponent.ZoomChangeListener

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
private MapView.LayerInvalidatedListener	invalidatedListener	The listener that listens to invalidations of all layers.
private java.awt.Rectangle	lastClipBounds
java.awt.event.MouseEvent	lastMEvent	The last event performed by mouse.
private int	lastViewID
private MainLayerManager	layerManager	A list of all layers currently loaded.
private MapMover	mapMover
private java.util.List<? extends javax.swing.JComponent>	mapNavigationComponents
private java.util.List<Layer>	nonChangedLayers
private java.awt.image.BufferedImage	nonChangedLayersBuffer
private java.awt.image.BufferedImage	offscreenBuffer
private java.awt.Point	oldLoc
private java.awt.Dimension	oldSize
private java.util.concurrent.atomic.AtomicBoolean	paintPreferencesChanged
PlayHeadMarker	playHeadMarker	The play head marker: there is only one of these so it isn't in any specific layer
private java.util.HashMap<Layer,MapViewPaintable.LayerPainter>	registeredLayers	This is a map of all Layers that have been added to this view.
private java.util.concurrent.CopyOnWriteArrayList<MapView.RepaintListener>	repaintListeners
private DataSelectionListener	repaintSelectionChangedListener
private java.util.Set<MapViewPaintable>	temporaryLayers	Temporary layers (selection rectangle, etc.) that are never cached and drawn on top of regular layers.
private boolean	virtualNodesEnabled
private java.awt.Stroke	worldBorderStroke

Fields inherited from class org.openstreetmap.josm.gui.NavigatableComponent

cursorManager, initialViewport, isSelectablePredicate, PROP_SNAP_DISTANCE, PROP_ZOOM_INTERMEDIATE_STEPS, PROP_ZOOM_RATIO, PROP_ZOOM_SCALE_FOLLOW_NATIVE_RES_AT_LOAD

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
MapView(MainLayerManager layerManager, ViewportData viewportData)	Constructs a new MapView.

Method Summary

Modifier and Type	Method	Description
void	activeOrEditLayerChanged(MainLayerManager.ActiveLayerChangeEvent e)	Called whenever the active or edit layer changed.
void	addRepaintListener(MapView.RepaintListener l)	Adds a listener that gets informed whenever repaint() is called for this class.
boolean	addTemporaryLayer(MapViewPaintable mvp)	Adds a new temporary layer.
void	destroy()	Destroy this map view panel.
private void	drawMapContent(java.awt.Graphics2D g)
private void	drawTemporaryLayers(java.awt.Graphics2D tempG, Bounds box)
private void	drawWorldBorders(java.awt.Graphics2D tempG)
private static java.awt.image.BufferedImage	getAcceleratedImage(java.awt.Component mv, int width, int height)
java.lang.String	getLayerInformationForSourceTag()	Get a string representation of all layers suitable for the source changeset tag.
MainLayerManager	getLayerManager()	Returns the layer manager.
MapMover	getMapMover()	Returns the internal MapMover.
static java.util.List<? extends javax.swing.JComponent>	getMapNavigationComponents(MapView forMapView)	Adds the map navigation components to a
java.util.List<MapViewPaintable>	getTemporaryLayers()	Gets a list of temporary layers.
boolean	isActiveLayerDrawable()	Replies true if the active data layer (edit layer) is drawable.
boolean	isActiveLayerVisible()	Replies true if the active data layer is visible.
boolean	isVirtualNodesEnabled()	Checks if virtual nodes should be drawn.
void	layerAdded(LayerManager.LayerAddEvent e)	Notifies this listener that a layer has been added.
void	layerOrderChanged(LayerManager.LayerOrderChangeEvent e)	Notifies this listener that the order of layers was changed.
void	layerRemoving(LayerManager.LayerRemoveEvent e)	Notifies this listener that a layer was just removed.
void	moveLayer(Layer layer, int pos)	Moves the layer to the given new position.
void	paint(java.awt.Graphics g)	Draw the component.
void	paintLayer(Layer layer, java.awt.Graphics2D g)	Paints the given layer to the graphics object, using the current state of this map view.
void	preferenceChanged(PreferenceChangeEvent e)	Triggered when a preference entry value changes.
boolean	prepareToDraw()	Sets up the viewport to prepare for drawing the view.
void	propertyChange(java.beans.PropertyChangeEvent evt)
void	rememberLastPositionOnScreen()	Call this method to keep map position on screen during next repaint
void	removeRepaintListener(MapView.RepaintListener l)	Removes a registered repaint listener.
boolean	removeTemporaryLayer(MapViewPaintable mvp)	Removes a layer previously added as temporary layer.
void	repaint()
void	repaint(long tm, int x, int y, int width, int height)
void	scheduleZoomTo(ViewportData viewportData)	Schedule a zoom to the given position on the next redraw.
void	setMapNavigationComponentVisibility(boolean visible)	Set the visibility of the navigation component
void	setVirtualNodesEnabled(boolean enabled)	Enables or disables drawing of the virtual nodes.

Methods inherited from class org.openstreetmap.josm.gui.NavigatableComponent

addNotify, addPrimitiveHoverListener, addZoomChangeListener, firePrimitiveHovered, fireZoomChanged, fixProjection, getAffineTransform, getAllNearest, getAllNearest, getCenter, getCursorManager, getDist100Pixel, getDist100Pixel, getDist100PixelText, getDistText, getDistText, getEastNorth, getLatLon, getLatLon, getLatLonBounds, getMaxProjectionBounds, getMaxScale, getNativeScaleLayer, getNearestNode, getNearestNode, getNearestNode, getNearestNodeOrWay, getNearestNodes, getNearestNodes, getNearestNodesOrWays, getNearestNodesOrWays, getNearestWay, getNearestWays, getNearestWays, getNearestWaySegment, getNearestWaySegment, getNearestWaySegment, getNearestWaySegments, getNearestWaySegments, getPoint, getPoint, getPoint, getPoint, getPoint2D, getPoint2D, getPoint2D, getPoint2D, getProjection, getProjectionBounds, getProjectionBounds, getRealBounds, getScale, getState, getViewID, hasZoomRedoEntries, hasZoomUndoEntries, helpTopic, isVisibleOnScreen, project, removeNotify, removePrimitiveHoverListener, removeZoomChangeListener, resetCursor, scaleFloor, scaleRound, scaleSnap, scaleZoomIn, scaleZoomManyTimes, scaleZoomOut, setNativeScaleLayer, setNewCursor, setNewCursor, smoothScrollTo, updateLocationState, zoomIn, zoomManyTimes, zoomNext, zoomOut, zoomPrevious, zoomTo, zoomTo, zoomTo, zoomTo, zoomTo, zoomTo, zoomTo, zoomTo, zoomTo, zoomToFactor, zoomToFactor, zoomToFactor

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

layerManager

private final MainLayerManager layerManager

A list of all layers currently loaded. If we support multiple map views, this list may be different for each of them.

playHeadMarker

public transient PlayHeadMarker playHeadMarker

The play head marker: there is only one of these so it isn't in any specific layer

lastMEvent

public java.awt.event.MouseEvent lastMEvent

The last event performed by mouse.

temporaryLayers

private final transient java.util.Set<MapViewPaintable> temporaryLayers

Temporary layers (selection rectangle, etc.) that are never cached and drawn on top of regular layers. Access must be synchronized.

nonChangedLayersBuffer

private transient java.awt.image.BufferedImage nonChangedLayersBuffer

offscreenBuffer

private transient java.awt.image.BufferedImage offscreenBuffer

nonChangedLayers

private final transient java.util.List<Layer> nonChangedLayers

lastViewID

private int lastViewID

paintPreferencesChanged

private final java.util.concurrent.atomic.AtomicBoolean paintPreferencesChanged

lastClipBounds

private java.awt.Rectangle lastClipBounds

mapMover

private transient MapMover mapMover

mapNavigationComponents

private final java.util.List<? extends javax.swing.JComponent> mapNavigationComponents

worldBorderStroke

private final java.awt.Stroke worldBorderStroke

invalidatedListener

private final MapView.LayerInvalidatedListener invalidatedListener

The listener that listens to invalidations of all layers.

registeredLayers

private final java.util.HashMap<Layer,MapViewPaintable.LayerPainter> registeredLayers

This is a map of all Layers that have been added to this view.

oldSize

private java.awt.Dimension oldSize

oldLoc

private java.awt.Point oldLoc

virtualNodesEnabled

private boolean virtualNodesEnabled

repaintSelectionChangedListener

private final transient DataSelectionListener repaintSelectionChangedListener

repaintListeners

private final transient java.util.concurrent.CopyOnWriteArrayList<MapView.RepaintListener> repaintListeners

Constructor Detail

MapView

public MapView(MainLayerManager layerManager,
               ViewportData viewportData)

Constructs a new MapView.

Parameters:

layerManager - The layers to display.

viewportData - the initial viewport of the map. Can be null, then the viewport is derived from the layer data.

Since:

11713

Method Detail

getMapNavigationComponents

public static java.util.List<? extends javax.swing.JComponent> getMapNavigationComponents(MapView forMapView)

Adds the map navigation components to a

Parameters:

forMapView - The map view to get the components for.

Returns:

A list containing the correctly positioned map navigation components.

getAcceleratedImage

private static java.awt.image.BufferedImage getAcceleratedImage(java.awt.Component mv,
                                                                int width,
                                                                int height)

rememberLastPositionOnScreen

public void rememberLastPositionOnScreen()

Call this method to keep map position on screen during next repaint

layerAdded

public void layerAdded(LayerManager.LayerAddEvent e)

Description copied from interface: LayerManager.LayerChangeListener

Notifies this listener that a layer has been added.

Listeners are called in the EDT thread. You should not do blocking or long-running tasks in this method.

Specified by:

layerAdded in interface LayerManager.LayerChangeListener

Parameters:

e - The new added layer event

isActiveLayerDrawable

public boolean isActiveLayerDrawable()

Replies true if the active data layer (edit layer) is drawable.

Returns:

true if the active data layer (edit layer) is drawable, false otherwise

isActiveLayerVisible

public boolean isActiveLayerVisible()

Replies true if the active data layer is visible.

Returns:

true if the active data layer is visible, false otherwise

layerRemoving

public void layerRemoving(LayerManager.LayerRemoveEvent e)

Description copied from interface: LayerManager.LayerChangeListener

Notifies this listener that a layer was just removed.

Listeners are called in the EDT thread after the layer was removed. Use LayerManager.LayerRemoveEvent.scheduleRemoval(Collection) to remove more layers. You should not do blocking or long-running tasks in this method.

Specified by:

layerRemoving in interface LayerManager.LayerChangeListener

Parameters:

e - The layer to be removed (as event)

setVirtualNodesEnabled

public void setVirtualNodesEnabled(boolean enabled)

Enables or disables drawing of the virtual nodes.

Parameters:

enabled - if virtual nodes are enabled

isVirtualNodesEnabled

public boolean isVirtualNodesEnabled()

Checks if virtual nodes should be drawn. Default is false

Returns:

The virtual nodes property.

See Also:

Rendering.render(org.openstreetmap.josm.data.osm.OsmData<?, ?, ?, ?>, boolean, org.openstreetmap.josm.data.Bounds)

moveLayer

public void moveLayer(Layer layer,
                      int pos)

Moves the layer to the given new position. No event is fired, but repaints according to the new Z-Order of the layers.

Parameters:

layer - The layer to move

pos - The new position of the layer

layerOrderChanged

public void layerOrderChanged(LayerManager.LayerOrderChangeEvent e)

Description copied from interface: LayerManager.LayerChangeListener

Notifies this listener that the order of layers was changed.

Listeners are called in the EDT thread. You should not do blocking or long-running tasks in this method.

Specified by:

layerOrderChanged in interface LayerManager.LayerChangeListener

Parameters:

e - The order change event.

paintLayer

public void paintLayer(Layer layer,
                       java.awt.Graphics2D g)

Paints the given layer to the graphics object, using the current state of this map view.

Parameters:

layer - The layer to draw.

g - A graphics object. It should have the width and height of this component

Throws:

java.lang.IllegalArgumentException - If the layer is not part of this map view.

Since:

11226

paint

public void paint(java.awt.Graphics g)

Draw the component.

Overrides:

paint in class javax.swing.JComponent

drawMapContent

private void drawMapContent(java.awt.Graphics2D g)

drawTemporaryLayers

private void drawTemporaryLayers(java.awt.Graphics2D tempG,
                                 Bounds box)

drawWorldBorders

private void drawWorldBorders(java.awt.Graphics2D tempG)

prepareToDraw

public boolean prepareToDraw()

Sets up the viewport to prepare for drawing the view.

Returns:

true if the view can be drawn, false otherwise.

activeOrEditLayerChanged

public void activeOrEditLayerChanged(MainLayerManager.ActiveLayerChangeEvent e)

Description copied from interface: MainLayerManager.ActiveLayerChangeListener

Called whenever the active or edit layer changed.

You can be sure that this layer is still contained in this set.

Listeners are called in the EDT thread and you can manipulate the layer manager in the current thread.

Specified by:

activeOrEditLayerChanged in interface MainLayerManager.ActiveLayerChangeListener

Parameters:

e - The change event.

addTemporaryLayer

public boolean addTemporaryLayer(MapViewPaintable mvp)

Adds a new temporary layer.

A temporary layer is a layer that is painted above all normal layers. Layers are painted in the order they are added.

Parameters:

mvp - The layer to paint.

Returns:

true if the layer was added.

removeTemporaryLayer

public boolean removeTemporaryLayer(MapViewPaintable mvp)

Removes a layer previously added as temporary layer.

Parameters:

mvp - The layer to remove.

Returns:

true if that layer was removed.

getTemporaryLayers

public java.util.List<MapViewPaintable> getTemporaryLayers()

Gets a list of temporary layers.

Returns:

The layers in the order they are added.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

preferenceChanged

public void preferenceChanged(PreferenceChangeEvent e)

Description copied from interface: PreferenceChangedListener

Triggered when a preference entry value changes.

Specified by:

preferenceChanged in interface PreferenceChangedListener

Parameters:

e - the preference change event

destroy

public void destroy()

Destroy this map view panel. Should be called once when it is not needed any more.

getLayerInformationForSourceTag

public java.lang.String getLayerInformationForSourceTag()

Get a string representation of all layers suitable for the source changeset tag.

Returns:

A String of sources separated by ';'

addRepaintListener

public void addRepaintListener(MapView.RepaintListener l)

Adds a listener that gets informed whenever repaint() is called for this class.

Parameters:

l - The listener.

removeRepaintListener

public void removeRepaintListener(MapView.RepaintListener l)

Removes a registered repaint listener.

Parameters:

l - The listener.

repaint

public void repaint(long tm,
                    int x,
                    int y,
                    int width,
                    int height)

Overrides:

repaint in class javax.swing.JComponent

repaint

public void repaint()

Overrides:

repaint in class java.awt.Component

getLayerManager

public final MainLayerManager getLayerManager()

Returns the layer manager.

Returns:

the layer manager

Since:

10282

scheduleZoomTo

public void scheduleZoomTo(ViewportData viewportData)

Schedule a zoom to the given position on the next redraw. Temporary, may be removed without warning.

Parameters:

viewportData - the viewport to zoom to

Since:

10394

getMapMover

public final MapMover getMapMover()

Returns the internal MapMover.

Returns:

the internal MapMover

Since:

13126

setMapNavigationComponentVisibility

public void setMapNavigationComponentVisibility(boolean visible)

Set the visibility of the navigation component

Parameters:

visible - true to make the navigation component visible

Since:

18755