org.openstreetmap.josm.gui.layer

Class AbstractModifiableLayer

java.lang.Object

org.openstreetmap.josm.gui.layer.Layer

org.openstreetmap.josm.gui.layer.AbstractModifiableLayer

All Implemented Interfaces:

ProjectionChangeListener, MapViewPaintable, SaveToFile, UploadToServer, Destroyable

Direct Known Subclasses:

GeoImageLayer, NoteLayer, OsmDataLayer

public abstract class AbstractModifiableLayer
extends Layer
implements UploadToServer, SaveToFile

A modifiable layer.

Since:

7358

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

Field Summary

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
AbstractModifiableLayer(java.lang.String name) Constructs a new ModifiableLayer.

Method Summary

Modifier and Type	Method and Description
AbstractIOTask	createUploadTask(ProgressMonitor monitor) Creates a new AbstractIOTask for uploading data.
AbstractUploadDialog	getUploadDialog() Returns the upload dialog for this layer.
abstract boolean	isModified() Determines if data managed by this layer has been modified.
boolean	isUploadable() Determines if the layer is able to upload data and implements the UploadToServer interface.
boolean	isUploadDiscouraged() Determines if upload of data managed by this layer is discouraged.
void	onPostSaveToFile() Initializes the layer after a successful save of data to a file.
void	onPostUploadToServer() Initializes the layer after a successful upload to the server.
boolean	requiresSaveToFile() Determines if the data managed by this layer needs to be saved to a file.
boolean	requiresUploadToServer() Determines if the data managed by this layer needs to be uploaded to the server because it contains modified data.

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

addPropertyChangeListener, checkSaveConditions, createAndOpenSaveFileChooser, destroy, estimateMemoryUsage, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColor, getIcon, getInfoComponent, getMenuEntries, getName, getOpacity, getToolTipText, hookUpMapView, isBackgroundLayer, isChanged, isInfoResizable, isMergable, isProjectionSupported, isRenamed, isSavable, isVisible, mergeFrom, nameSupportedProjections, onPostLoadFromFile, paint, projectionChanged, removePropertyChangeListener, rename, setAssociatedFile, setBackgroundLayer, setFilterStateChanged, setName, setOpacity, setVisible, toggleVisible, visitBoundingBox

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openstreetmap.josm.gui.layer.SaveToFile

isSavable

Constructor Detail

AbstractModifiableLayer

public AbstractModifiableLayer(java.lang.String name)

Constructs a new ModifiableLayer.

Parameters:

name - Layer name

Method Detail

isUploadable

public boolean isUploadable()

Determines if the layer is able to upload data and implements the UploadToServer interface.

Specified by:

isUploadable in interface UploadToServer

Returns:

true if the layer is able to upload data; false, otherwise

requiresUploadToServer

public boolean requiresUploadToServer()

Determines if the data managed by this layer needs to be uploaded to the server because it contains modified data.

Specified by:

requiresUploadToServer in interface UploadToServer

Returns:

true if the data managed by this layer needs to be uploaded to the server because it contains modified data; false, otherwise

requiresSaveToFile

public boolean requiresSaveToFile()

Determines if the data managed by this layer needs to be saved to a file. Only replies true if a file is assigned to this layer and if the data managed by this layer has been modified since the last save operation to the file.

Specified by:

requiresSaveToFile in interface SaveToFile

Returns:

true if the data managed by this layer needs to be saved to a file

isUploadDiscouraged

public boolean isUploadDiscouraged()

Determines if upload of data managed by this layer is discouraged. This feature allows to use "private" data layers.

Specified by:

isUploadDiscouraged in interface UploadToServer

Returns:

true if upload is discouraged for this layer; false, otherwise

isModified

public abstract boolean isModified()

Determines if data managed by this layer has been modified.

Returns:

true if data has been modified; false, otherwise

onPostSaveToFile

public void onPostSaveToFile()

Initializes the layer after a successful save of data to a file.

Specified by:

onPostSaveToFile in interface SaveToFile

onPostUploadToServer

public void onPostUploadToServer()

Initializes the layer after a successful upload to the server.

Specified by:

onPostUploadToServer in interface UploadToServer

createUploadTask

public AbstractIOTask createUploadTask(ProgressMonitor monitor)

Creates a new AbstractIOTask for uploading data.

Specified by:

createUploadTask in interface UploadToServer

Parameters:

monitor - The progress monitor

Returns:

a new AbstractIOTask for uploading data, or null if not applicable

getUploadDialog

public AbstractUploadDialog getUploadDialog()

Returns the upload dialog for this layer.

Specified by:

getUploadDialog in interface UploadToServer

Returns:

the upload dialog for this layer, or null if not applicable