org.openstreetmap.josm.gui.layer

Class NoteLayer

java.lang.Object

org.openstreetmap.josm.gui.layer.Layer

org.openstreetmap.josm.gui.layer.AbstractModifiableLayer

org.openstreetmap.josm.gui.layer.NoteLayer

All Implemented Interfaces:

MouseListener, EventListener, ProjectionChangeListener, MapViewPaintable, Destroyable

public class NoteLayer
extends AbstractModifiableLayer
implements MouseListener

A layer to hold Note objects.

Since:

7522

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

Modifier and Type	Field and Description
private NoteData	noteData

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

FILTER_STATE_PROP, ICON_SIZE, NAME_PROP, OPACITY_PROP, propertyChangeSupport, VISIBLE_PROP

Constructor Summary

Constructors

Constructor and Description
NoteLayer() Convenience constructor that creates a layer with an empty note list
NoteLayer(Collection<Note> notes, String name) Create a new note layer with a set of notes

Method Summary

Modifier and Type	Method and Description
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.
AbstractIOTask	createUploadTask(ProgressMonitor monitor) Creates a new AbstractIOTask for uploading data.
Icon	getIcon() Return a representative small image for this layer.
Object	getInfoComponent()
Action[]	getMenuEntries() Returns list of actions.
NoteData	getNoteData() Returns the note data store being used by this layer
String	getToolTipText()
void	hookUpMapView() Initialization code, that depends on Main.map.mapView.
boolean	isMergable(Layer other)
boolean	isModified() Determines if data managed by this layer has been modified.
boolean	isSavable() Replies the savable state of this layer (i.e if it can be saved through a "File->Save" dialog).
void	mergeFrom(Layer from) Merges the given layer into this layer.
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	paint(Graphics2D g, MapView mv, Bounds box) Paint the dataset using the engine set.
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.
void	visitBoundingBox(BoundingXYVisitor v)

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

getUploadDialog, isUploadDiscouraged, onPostSaveToFile, onPostUploadToServer

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

addPropertyChangeListener, checkSaveConditions, destroy, estimateMemoryUsage, fireFilterStateChanged, fireOpacityChanged, fireVisibleChanged, getAssociatedFile, getColor, getName, getOpacity, isBackgroundLayer, isChanged, isInfoResizable, isProjectionSupported, isVisible, nameSupportedProjections, onPostLoadFromFile, projectionChanged, removePropertyChangeListener, setAssociatedFile, setBackgroundLayer, setFilterStateChanged, setName, setOpacity, setVisible, toggleVisible

Methods inherited from class java.lang.Object

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

Field Detail

noteData

private final NoteData noteData

Constructor Detail

NoteLayer

public NoteLayer(Collection<Note> notes,
                 String name)

Create a new note layer with a set of notes

Parameters:

notes - A list of notes to show in this layer

name - The name of the layer. Typically "Notes"

NoteLayer

public NoteLayer()

Convenience constructor that creates a layer with an empty note list

Method Detail

hookUpMapView

public void hookUpMapView()

Description copied from class: Layer

Initialization code, that depends on Main.map.mapView. It is always called in the event dispatching thread. Note that Main.map is null as long as no layer has been added, so do not execute code in the constructor, that assumes Main.map.mapView is not null. Instead override this method. This implementation provides check, if JOSM will be able to use Layer. Layers using a lot of memory, which do know in advance, how much memory they use, should override estimateMemoryUsage method and give a hint. This allows for preemptive warning message for user, instead of failing later on Remember to call super.hookUpMapView() when overriding this method

Overrides:

hookUpMapView in class Layer

getNoteData

public NoteData getNoteData()

Returns the note data store being used by this layer

Returns:

noteData containing layer notes

isModified

public boolean isModified()

Description copied from class: AbstractModifiableLayer

Determines if data managed by this layer has been modified.

Specified by:

isModified in class AbstractModifiableLayer

Returns:

true if data has been modified; false, otherwise

requiresUploadToServer

public boolean requiresUploadToServer()

Description copied from class: AbstractModifiableLayer

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

Overrides:

requiresUploadToServer in class AbstractModifiableLayer

Returns:

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

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

requiresSaveToFile

public boolean requiresSaveToFile()

Description copied from class: AbstractModifiableLayer

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.

Overrides:

requiresSaveToFile in class AbstractModifiableLayer

Returns:

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

paint

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

Description copied from class: Layer

Paint the dataset using the engine set.

Specified by:

paint in interface MapViewPaintable

Specified by:

paint in class Layer

Parameters:

g - Graphics

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

box - Bounding box

getIcon

public Icon getIcon()

Description copied from class: Layer

Return a representative small image for this layer. The image must not be larger than 64 pixel in any dimension.

Specified by:

getIcon in class Layer

Returns:

layer icon

getToolTipText

public 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)

Specified by:

visitBoundingBox in class Layer

getInfoComponent

public Object getInfoComponent()

Specified by:

getInfoComponent in class Layer

getMenuEntries

public 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

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

createAndOpenSaveFileChooser

public 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)

createUploadTask

public AbstractIOTask createUploadTask(ProgressMonitor monitor)

Description copied from class: AbstractModifiableLayer

Creates a new AbstractIOTask for uploading data.

Overrides:

createUploadTask in class AbstractModifiableLayer

Parameters:

monitor - The progress monitor

Returns:

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

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener