org.ka2ddo.yaac.gui

Class LayerCreator

java.lang.Object

org.ka2ddo.yaac.gui.LayerCreator

All Implemented Interfaces:

java.lang.Comparable<LayerCreator>

Direct Known Subclasses:

GeographicalMap.DefaultOSMLayerCreator, GeographicalMap.StationRendererCreator

public abstract class LayerCreator
extends java.lang.Object
implements java.lang.Comparable<LayerCreator>

This abstract class provides the infrastructure for adding a layer to the map, so that YAAC plugins can insert other layers at appropriate Z-levels into the maps. Note that such plugins should report at least the Provider.AFTERINSTALL_ONLY_NEW_MAPS status for their installation.

Since:

PROVIDER_API_VERSION == 56

Author:

Andrew Pavlin, KA2DDO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LayerCreator(int layerZOrder) Create a LayerCreator object with the specified Z order value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(LayerCreator o) Compares this object with the specified object for order.
void	doPostProcForLayer(com.bbn.openmap.MapBean mapBean, com.bbn.openmap.Layer newlyCreatedLayer) Does any post-processing needed after the Layer obtained from the getLayer(MapBean, GeoMapGuiIfc2, MouseDelegator, Preferences) method is added to the MapHandler.
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
abstract com.bbn.openmap.Layer	getLayer(com.bbn.openmap.MapBean mapBean, GeoMapGuiIfc2 geoMapGuiIfc2, com.bbn.openmap.MouseDelegator mouseDelegator, java.util.prefs.Preferences prefs) Create a layer object using the specified context values.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayerCreator

protected LayerCreator(int layerZOrder)

Create a LayerCreator object with the specified Z order value.

Parameters:

layerZOrder - int Z order value, arbitrary value with higher numbers added later to the map

Method Detail

getLayer

public abstract com.bbn.openmap.Layer getLayer(com.bbn.openmap.MapBean mapBean,
                                               GeoMapGuiIfc2 geoMapGuiIfc2,
                                               com.bbn.openmap.MouseDelegator mouseDelegator,
                                               java.util.prefs.Preferences prefs)

Create a layer object using the specified context values.

Parameters:

mapBean - MapBean which will contain the generated Layer

geoMapGuiIfc2 - GeoMapGuiIfc2 implementing object containing the MapBean

mouseDelegator - MouseDelegator for the MapBean

prefs - Preferences object for this profile of YAAC

Returns:

a Layer to append to the MapHandler in its z order

doPostProcForLayer

public void doPostProcForLayer(com.bbn.openmap.MapBean mapBean,
                               com.bbn.openmap.Layer newlyCreatedLayer)

Does any post-processing needed after the Layer obtained from the getLayer(MapBean, GeoMapGuiIfc2, MouseDelegator, Preferences) method is added to the MapHandler. By default, this does nothing.

Parameters:

mapBean - MapBean newly containing the Layer

newlyCreatedLayer - the newly added Layer

compareTo

public final int compareTo(LayerCreator o)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable<LayerCreator>

Parameters:

o - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.ClassCastException - if the specified object's type prevents it from being compared to this object.

equals

public boolean equals(java.lang.Object obj)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.