org.openstreetmap.josm.gui.layer

Class ValidatorLayer

java.lang.Object

org.openstreetmap.josm.gui.layer.AbstractMapViewPaintable

org.openstreetmap.josm.gui.layer.Layer

org.openstreetmap.josm.gui.layer.ValidatorLayer

All Implemented Interfaces:

ProjectionChangeListener, LayerManager.LayerChangeListener, MapViewPaintable, Destroyable

public class ValidatorLayer
extends Layer
implements LayerManager.LayerChangeListener

A layer showing error messages.

Since:

3669 (creation), 10386 (new LayerChangeListener interface)

Nested Class Summary

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 java.lang.Runnable	invalidator

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
ValidatorLayer() Constructs a new Validator layer

Method Summary

Modifier and Type	Method and Description
boolean	checkSaveConditions() Checks whether it is ok to launch a save (whether we have data, there is no conflict etc.)
java.io.File	createAndOpenSaveFileChooser() Creates a new "Save" dialog for this layer and makes it visible. When the user has chosen a file, checks the file extension, and confirms overwrite if needed.
void	destroy() Called, when the layer is removed from the mapview and is going to be destroyed.
LayerPositionStrategy	getDefaultLayerPosition() Gets the strategy that specifies where this layer should be inserted in a layer list.
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)
boolean	isSavable() Replies the savable state of this layer (i.e if it can be saved through a "File->Save" dialog).
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) If layer is the OSM Data layer, remove all errors
void	mergeFrom(Layer from) Merges the given layer into this layer.
void	paint(java.awt.Graphics2D g, MapView mv, Bounds bounds) Draw all primitives in this layer but do not draw modified ones (they are drawn by the edit layer).
void	visitBoundingBox(BoundingXYVisitor v) Visits the content bounds of this layer.

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

addPropertyChangeListener, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getBaseColorProperty, getColorProperty, getName, getOpacity, getViewProjectionBounds, hookUpMapView, isBackgroundLayer, isInfoResizable, isProjectionSupported, isRenamed, 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, attachToMapView, createMapViewPainter, invalidate, removeInvalidationListener

Methods inherited from class java.lang.Object

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

Field Detail

invalidator

private final java.lang.Runnable invalidator

Constructor Detail

ValidatorLayer

public ValidatorLayer()

Constructs a new Validator layer

Method Detail

getIcon

public javax.swing.Icon getIcon()

Return a static icon.

Specified by:

getIcon in class Layer

Returns:

layer icon

paint

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

Draw all primitives in this layer but do not draw modified ones (they are drawn by the edit layer). Draw nodes last to overlap the ways they belong to.

Specified by:

paint in interface MapViewPaintable

Parameters:

g - Graphics

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

bounds - 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

isSavable

public boolean isSavable()

Description copied from class: Layer

Replies the savable state of this layer (i.e if it can be saved through a "File->Save" dialog).

Overrides:

isSavable in class Layer

Returns:

true if this layer can be saved to a file

checkSaveConditions

public boolean checkSaveConditions()

Description copied from class: Layer

Checks whether it is ok to launch a save (whether we have data, there is no conflict etc.)

Overrides:

checkSaveConditions in class Layer

Returns:

true, if it is safe to save.

createAndOpenSaveFileChooser

public java.io.File createAndOpenSaveFileChooser()

Description copied from class: Layer

Creates a new "Save" dialog for this layer and makes it visible.
When the user has chosen a file, checks the file extension, and confirms overwrite if needed.

Overrides:

createAndOpenSaveFileChooser in class Layer

Returns:

The output File

See Also:

SaveActionBase.createAndOpenSaveFileChooser(java.lang.String, org.openstreetmap.josm.actions.ExtensionFileFilter)

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.

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

layerRemoving

public void layerRemoving(LayerManager.LayerRemoveEvent e)

If layer is the OSM Data layer, remove all errors

Specified by:

layerRemoving in interface LayerManager.LayerChangeListener

Parameters:

e - The layer to be removed (as event)

getDefaultLayerPosition

public LayerPositionStrategy getDefaultLayerPosition()

Description copied from class: Layer

Gets the strategy that specifies where this layer should be inserted in a layer list.

Overrides:

getDefaultLayerPosition in class Layer

Returns:

That strategy.

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