org.openstreetmap.josm.gui.layer

Class MainLayerManager

java.lang.Object

org.openstreetmap.josm.gui.layer.LayerManager

org.openstreetmap.josm.gui.layer.MainLayerManager

public class MainLayerManager
extends LayerManager

This class extends the layer manager by adding an active and an edit layer.

The active layer is the layer the user is currently working on.

The edit layer is an data layer that we currently work with.

Since:

10279

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MainLayerManager.ActiveLayerChangeEvent This event is fired whenever the active or the edit layer changes.
static interface	MainLayerManager.ActiveLayerChangeListener This listener listens to changes of the active or the edit layer.
static class	MainLayerManager.LayerAvailabilityEvent This event is fired for MainLayerManager.LayerAvailabilityListener
static interface	MainLayerManager.LayerAvailabilityListener A listener that gets informed before any layer is displayed and after all layers are removed.

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

LayerManager.LayerAddEvent, LayerManager.LayerChangeListener, LayerManager.LayerManagerEvent, LayerManager.LayerOrderChangeEvent, LayerManager.LayerRemoveEvent

Field Summary

Fields

Modifier and Type	Field and Description
private Layer	activeLayer The layer from the layers list that is currently active.
private java.util.List<MainLayerManager.ActiveLayerChangeListener>	activeLayerChangeListeners
private OsmDataLayer	editLayer The edit layer is the current active data layer.
private java.util.List<MainLayerManager.LayerAvailabilityListener>	layerAvailabilityListeners

Constructor Summary

Constructors

Constructor and Description
MainLayerManager()

Method Summary

Modifier and Type	Method and Description
void	addActiveLayerChangeListener(MainLayerManager.ActiveLayerChangeListener listener) Adds a active/edit layer change listener
void	addAndFireActiveLayerChangeListener(MainLayerManager.ActiveLayerChangeListener listener) Adds a active/edit layer change listener.
void	addLayerAvailabilityListener(MainLayerManager.LayerAvailabilityListener listener) Add a new MainLayerManager.LayerAvailabilityListener.
private void	fireActiveLayerChange(MainLayerManager.ActiveLayerChangeEvent event)
Layer	getActiveLayer() Replies the currently active layer
DataSet	getEditDataSet() Gets the data set of the active edit layer.
OsmDataLayer	getEditLayer() Replies the current edit layer, if any
java.util.List<Layer>	getVisibleLayersInZOrder() Creates a list of the visible layers in Z-Order, the layer with the lowest Z-Order first, layer with the highest Z-Order last.
protected void	realAddLayer(Layer layer)
protected java.util.Collection<Layer>	realRemoveSingleLayer(Layer layer)
protected void	realResetState()
protected void	realSetActiveLayer(Layer layer)
void	removeActiveLayerChangeListener(MainLayerManager.ActiveLayerChangeListener listener) Removes an active/edit layer change listener.
void	removeLayerAvailabilityListener(MainLayerManager.LayerAvailabilityListener listener) Remove an MainLayerManager.LayerAvailabilityListener.
void	setActiveLayer(Layer layer) Set the active layer.
private void	setActiveLayer(Layer layer, boolean forceEditLayerUpdate)
private Layer	suggestNextActiveLayer(Layer except) Determines the next active data layer according to the following rules: if there is at least one OsmDataLayer the first one becomes active otherwise, the top most layer of any type becomes active

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

addLayer, addLayerChangeListener, addLayerChangeListener, checkContainsLayer, containsLayer, getLayers, getLayersOfType, moveLayer, realMoveLayer, realRemoveLayer, removeLayer, removeLayerChangeListener, removeLayerChangeListener, resetState

Methods inherited from class java.lang.Object

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

Field Detail

activeLayer

private Layer activeLayer

The layer from the layers list that is currently active.

editLayer

private OsmDataLayer editLayer

The edit layer is the current active data layer.

activeLayerChangeListeners

private final java.util.List<MainLayerManager.ActiveLayerChangeListener> activeLayerChangeListeners

layerAvailabilityListeners

private final java.util.List<MainLayerManager.LayerAvailabilityListener> layerAvailabilityListeners

Constructor Detail

MainLayerManager

public MainLayerManager()

Method Detail

addActiveLayerChangeListener

public void addActiveLayerChangeListener(MainLayerManager.ActiveLayerChangeListener listener)

Adds a active/edit layer change listener

Parameters:

listener - the listener.

addAndFireActiveLayerChangeListener

public void addAndFireActiveLayerChangeListener(MainLayerManager.ActiveLayerChangeListener listener)

Adds a active/edit layer change listener. Fire a fake active-layer-changed-event right after adding the listener. The previous layers will be null. The listener is notified in the current thread.

Parameters:

listener - the listener.

removeActiveLayerChangeListener

public void removeActiveLayerChangeListener(MainLayerManager.ActiveLayerChangeListener listener)

Removes an active/edit layer change listener.

Parameters:

listener - the listener.

addLayerAvailabilityListener

public void addLayerAvailabilityListener(MainLayerManager.LayerAvailabilityListener listener)

Add a new MainLayerManager.LayerAvailabilityListener.

Parameters:

listener - The listener

Since:

10508

removeLayerAvailabilityListener

public void removeLayerAvailabilityListener(MainLayerManager.LayerAvailabilityListener listener)

Remove an MainLayerManager.LayerAvailabilityListener.

Parameters:

listener - The listener

Since:

10508

setActiveLayer

public void setActiveLayer(Layer layer)

Set the active layer. If the layer is an OsmDataLayer, the edit layer is also changed.

Parameters:

layer - The active layer.

realSetActiveLayer

protected void realSetActiveLayer(Layer layer)

setActiveLayer

private void setActiveLayer(Layer layer,
                            boolean forceEditLayerUpdate)

fireActiveLayerChange

private void fireActiveLayerChange(MainLayerManager.ActiveLayerChangeEvent event)

realAddLayer

protected void realAddLayer(Layer layer)

Overrides:

realAddLayer in class LayerManager

realRemoveSingleLayer

protected java.util.Collection<Layer> realRemoveSingleLayer(Layer layer)

Overrides:

realRemoveSingleLayer in class LayerManager

suggestNextActiveLayer

private Layer suggestNextActiveLayer(Layer except)

Determines the next active data layer according to the following rules:

• if there is at least one OsmDataLayer the first one becomes active
• otherwise, the top most layer of any type becomes active

Parameters:

except - A layer to ignore.

Returns:

the next active data layer

getActiveLayer

public Layer getActiveLayer()

Replies the currently active layer

Returns:

the currently active layer (may be null)

getEditLayer

public OsmDataLayer getEditLayer()

Replies the current edit layer, if any

Returns:

the current edit layer. May be null.

getEditDataSet

public DataSet getEditDataSet()

Gets the data set of the active edit layer.

Returns:

That data set, null if there is no edit layer.

getVisibleLayersInZOrder

public java.util.List<Layer> getVisibleLayersInZOrder()

Creates a list of the visible layers in Z-Order, the layer with the lowest Z-Order first, layer with the highest Z-Order last.

The active data layer is pulled above all adjacent data layers.

Returns:

a list of the visible in Z-Order, the layer with the lowest Z-Order first, layer with the highest Z-Order last.

realResetState

protected void realResetState()

Overrides:

realResetState in class LayerManager