org.openstreetmap.josm.gui.layer.markerlayer

Class MarkerLayer

java.lang.Object

org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

org.openstreetmap.josm.gui.layer.Layer

org.openstreetmap.josm.gui.layer.markerlayer.MarkerLayer

All Implemented Interfaces:

ProjectionChangeListener, JumpToMarkerActions.JumpToMarkerLayer, MapViewPaintable, Destroyable

public class MarkerLayer
extends Layer
implements JumpToMarkerActions.JumpToMarkerLayer

A layer holding markers. Markers are GPS points with a name and, optionally, a symbol code attached; marker layers can be created from waypoints when importing raw GPS data, but they may also come from other sources. The symbol code is for future use. The data is read only.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	MarkerLayer.MarkerMouseAdapter
private class	MarkerLayer.MoveAudio
static class	MarkerLayer.ShowHideMarkerText
private class	MarkerLayer.SynchronizeAudio

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

Layer.LayerAction, Layer.LayerGpxExportAction, Layer.LayerSaveAction, Layer.LayerSaveAsAction, Layer.MultiLayerAction, Layer.SeparatorLayerAction

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

AbstractMapViewPaintable.CompatibilityModeLayerPainter

Nested classes/interfaces inherited from interface org.openstreetmap.josm.gui.layer.MapViewPaintable

MapViewPaintable.LayerPainter, MapViewPaintable.MapViewEvent, MapViewPaintable.PaintableInvalidationEvent, MapViewPaintable.PaintableInvalidationListener

Field Summary

Fields

Modifier and Type	Field and Description
private static NamedColorProperty	COLOR_PROPERTY
private Marker	currentMarker
java.util.List<Marker>	data A list of markers.
private static java.awt.Color	DEFAULT_COLOR
GpxLayer	fromLayer
private boolean	mousePressed
AudioMarker	syncAudioMarker

Fields inherited from class org.openstreetmap.josm.gui.layer.Layer

FILTER_STATE_PROP, NAME_PROP, OPACITY_PROP, propertyChangeSupport, VISIBLE_PROP

Constructor Summary

Constructors

Constructor and Description
MarkerLayer(GpxData indata, java.lang.String name, java.io.File associatedFile, GpxLayer fromLayer) Constructs a new MarkerLayer.

Method Summary

Modifier and Type	Method and Description
AudioMarker	addAudioMarker(double time, LatLon coor)
MapViewPaintable.LayerPainter	attachToMapView(MapViewPaintable.MapViewEvent event) This method is called whenever this layer is added to a map view.
void	destroy() Called, when the layer is removed from the mapview and is going to be destroyed.
private static Marker	getAdjacentMarker(Marker startMarker, boolean next, Layer layer)
protected NamedColorProperty	getBaseColorProperty() Gets the color property that stores the default color for this layer.
static java.awt.Color	getGenericColor()
javax.swing.Icon	getIcon() Return a static icon.
java.lang.Object	getInfoComponent() Gets the layer information to display to the user.
javax.swing.Action[]	getMenuEntries() Returns list of actions.
java.lang.String	getToolTipText()
boolean	isMergable(Layer other)
private boolean	isTextOrIconShown() Get state of text display.
void	jumpToNextMarker() Jump (move the viewport) to the next marker.
void	jumpToPreviousMarker() Jump (move the viewport) to the previous marker.
void	mergeFrom(Layer from) Merges the given layer into this layer.
void	paint(java.awt.Graphics2D g, MapView mv, Bounds box) Paint the dataset using the engine set.
private static void	playAdjacentMarker(Marker startMarker, boolean next)
static void	playAudio()
static void	playNextMarker()
static void	playPreviousMarker()
boolean	synchronizeAudioMarkers(AudioMarker startMarker)
void	visitBoundingBox(BoundingXYVisitor v) Visits the content bounds of this layer.

Methods inherited from class org.openstreetmap.josm.gui.layer.Layer

addPropertyChangeListener, checkSaveConditions, createAndOpenSaveFileChooser, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColorProperty, getDefaultLayerPosition, getName, getOpacity, getViewProjectionBounds, hookUpMapView, isBackgroundLayer, isInfoResizable, isProjectionSupported, isRenamed, isSavable, isVisible, nameSupportedProjections, onPostLoadFromFile, projectionChanged, removePropertyChangeListener, rename, setAssociatedFile, setBackgroundLayer, setFilterStateChanged, setName, setOpacity, setVisible, toggleVisible, toString

Methods inherited from class org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

addInvalidationListener, createMapViewPainter, invalidate, removeInvalidationListener

Methods inherited from class java.lang.Object

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

Field Detail

data

public final java.util.List<Marker> data

A list of markers.

mousePressed

private boolean mousePressed

fromLayer

public GpxLayer fromLayer

currentMarker

private Marker currentMarker

syncAudioMarker

public AudioMarker syncAudioMarker

DEFAULT_COLOR

private static final java.awt.Color DEFAULT_COLOR

COLOR_PROPERTY

private static final NamedColorProperty COLOR_PROPERTY

Constructor Detail

MarkerLayer

public MarkerLayer(GpxData indata,
                   java.lang.String name,
                   java.io.File associatedFile,
                   GpxLayer fromLayer)

Constructs a new MarkerLayer.

Parameters:

indata - The GPX data for this layer

name - The marker layer name

associatedFile - The associated GPX file

fromLayer - The associated GPX layer

Method Detail

destroy

public void destroy()

Description copied from class: Layer

Called, when the layer is removed from the mapview and is going to be destroyed. This is because the Layer constructor can not add itself safely as listener to the layerlist dialog, because there may be no such dialog yet (loaded via command line parameter).

Specified by:

destroy in interface Destroyable

Overrides:

destroy in class Layer

attachToMapView

public MapViewPaintable.LayerPainter attachToMapView(MapViewPaintable.MapViewEvent event)

Description copied from class: AbstractMapViewPaintable

This method is called whenever this layer is added to a map view.

You need to return a painter here. The MapViewPaintable.LayerPainter.detachFromMapView(org.openstreetmap.josm.gui.layer.MapViewPaintable.MapViewEvent) method is called when the layer is removed from that map view. You are free to reuse painters.

You should always call the super method. See AbstractMapViewPaintable.createMapViewPainter(org.openstreetmap.josm.gui.layer.MapViewPaintable.MapViewEvent) if you want to influence painter creation.

This replaces Layer.hookUpMapView() in the long run.

Overrides:

attachToMapView in class AbstractMapViewPaintable

Parameters:

event - the event.

Returns:

A layer painter.

getIcon

public javax.swing.Icon getIcon()

Return a static icon.

Specified by:

getIcon in class Layer

Returns:

layer icon

getBaseColorProperty

protected NamedColorProperty getBaseColorProperty()

Description copied from class: Layer

Gets the color property that stores the default color for this layer.

Overrides:

getBaseColorProperty in class Layer

Returns:

The property or null if this layer is not colored.

getGenericColor

public static java.awt.Color getGenericColor()

paint

public void paint(java.awt.Graphics2D g,
                  MapView mv,
                  Bounds box)

Description copied from interface: MapViewPaintable

Paint the dataset using the engine set.

Specified by:

paint in interface MapViewPaintable

Parameters:

g - Graphics

mv - The object that can translate GeoPoints to screen coordinates.

box - Bounding box

getToolTipText

public java.lang.String getToolTipText()

Specified by:

getToolTipText in class Layer

Returns:

A small tooltip hint about some statistics for this layer.

mergeFrom

public void mergeFrom(Layer from)

Description copied from class: Layer

Merges the given layer into this layer. Throws if the layer types are incompatible.

Specified by:

mergeFrom in class Layer

Parameters:

from - The layer that get merged into this one. After the merge, the other layer is not usable anymore and passing to one others mergeFrom should be one of the last things to do with a layer.

isMergable

public boolean isMergable(Layer other)

Specified by:

isMergable in class Layer

Parameters:

other - The other layer that is tested to be mergable with this.

Returns:

Whether the other layer can be merged into this layer.

visitBoundingBox

public void visitBoundingBox(BoundingXYVisitor v)

Description copied from class: Layer

Visits the content bounds of this layer. The behavior of this method depends on the layer, but each implementation should attempt to cover the relevant content of the layer in this method.

Specified by:

visitBoundingBox in class Layer

Parameters:

v - The visitor that gets notified about the contents of this layer.

getInfoComponent

public java.lang.Object getInfoComponent()

Description copied from class: Layer

Gets the layer information to display to the user. This is used if the user requests information about this layer. It should display a description of the layer content.

Specified by:

getInfoComponent in class Layer

Returns:

Either a String or a Component describing the layer.

getMenuEntries

public javax.swing.Action[] getMenuEntries()

Description copied from class: Layer

Returns list of actions. Action can implement LayerAction interface when it needs to be represented by other menu component than JMenuItem or when it supports multiple layers. Actions that support multiple layers should also have correct equals implementation. Use Layer.SeparatorLayerAction.INSTANCE instead of new JSeparator

Specified by:

getMenuEntries in class Layer

Returns:

menu actions for this layer

synchronizeAudioMarkers

public boolean synchronizeAudioMarkers(AudioMarker startMarker)

addAudioMarker

public AudioMarker addAudioMarker(double time,
                                  LatLon coor)

jumpToNextMarker

public void jumpToNextMarker()

Description copied from interface: JumpToMarkerActions.JumpToMarkerLayer

Jump (move the viewport) to the next marker.

Specified by:

jumpToNextMarker in interface JumpToMarkerActions.JumpToMarkerLayer

jumpToPreviousMarker

public void jumpToPreviousMarker()

Description copied from interface: JumpToMarkerActions.JumpToMarkerLayer

Jump (move the viewport) to the previous marker.

Specified by:

jumpToPreviousMarker in interface JumpToMarkerActions.JumpToMarkerLayer

playAudio

public static void playAudio()

playNextMarker

public static void playNextMarker()

playPreviousMarker

public static void playPreviousMarker()

getAdjacentMarker

private static Marker getAdjacentMarker(Marker startMarker,
                                        boolean next,
                                        Layer layer)

playAdjacentMarker

private static void playAdjacentMarker(Marker startMarker,
                                       boolean next)

isTextOrIconShown

private boolean isTextOrIconShown()

Get state of text display.

Returns:

true if text should be shown, false otherwise.