com.luciad.lucy.addons.grid.mgrs.lightspeed

Defense SymbologyClass TLcyLspMGRSGridAddOn

java.lang.Object

com.luciad.lucy.addons.ALcyAddOn

com.luciad.lucy.addons.ALcyPreferencesAddOn

com.luciad.lucy.addons.lightspeed.ALcyLspFormatAddOn

com.luciad.lucy.addons.grid.mgrs.lightspeed.TLcyLspMGRSGridAddOn

public class TLcyLspMGRSGridAddOn
extends ALcyLspFormatAddOn

This add-on adds the capability to add a MGRS grid layer to every Lightspeed map.

The configuration options allow to add such a layer automatically to every new map. Manually adding a grid layer is possible using the action in the menu bar.

The layers will be encoded in the workspace. This add-on can add the grid to newly created Lightspeed maps, but when loading a map from a workspace the layers are only added if they were saved in the workspace.

Since:

2012.1

See Also:

TLcyLspGridAddOn

Constructor Summary

Constructors

Constructor and Description
TLcyLspMGRSGridAddOn() Default constructor

Method Summary

Modifier and Type	Method and Description
protected ALcyLspFormat	createBaseFormat() Returns a new data format for this add-on.
protected ALcyLspFormat	createFormatWrapper(ALcyLspFormat aBaseFormat) Returns a new data format wrapper for this add-on.
ILcdAction	getAddGridActionForMap(ILcyGenericMapComponent<?,?> aMapComponent) Returns the ILcdAction which can be used to add a MGRS grid on the specified map.
void	plugInto(ILcyLucyEnv aLucyEnv) Creates and plugs in the add-on's format and preferences tool.

Methods inherited from class com.luciad.lucy.addons.lightspeed.ALcyLspFormatAddOn

createFormatTool, getFormat, unplugFrom

Methods inherited from class com.luciad.lucy.addons.ALcyPreferencesAddOn

createPreferencesTool, getLongPrefix, getLucyEnv, getPreferences, getPreferencesTool, getShortPrefix

Methods inherited from class com.luciad.lucy.addons.ALcyAddOn

getConfigSourceName, getDisplayName, setConfigSourceName, setDisplayName

Methods inherited from class java.lang.Object

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

Constructor Detail

TLcyLspMGRSGridAddOn

public TLcyLspMGRSGridAddOn()

Default constructor

Method Detail

plugInto

public void plugInto(ILcyLucyEnv aLucyEnv)

Description copied from class: ALcyLspFormatAddOn

Creates and plugs in the add-on's format and preferences tool.

Overrides:

plugInto in class ALcyLspFormatAddOn

Parameters:

aLucyEnv - the Lucy environment to plug into

See Also:

ALcyAddOn.unplugFrom(com.luciad.lucy.ILcyLucyEnv)

createBaseFormat

protected ALcyLspFormat createBaseFormat()

Description copied from class: ALcyLspFormatAddOn

Returns a new data format for this add-on. Override this method to extend the default format with new functionality.

For example, to alter the icon of the layers of this format, you can decorate the layer factory created in the format:

 @Override
 protected ALcyLspFormat createBaseFormat() {
   return new ALcyLspFormatWrapper(super.createBaseFormat()){
     @Override
     protected ILspLayerFactory createLayerFactory(){
       final ILspLayerFactory delegate = super.createLayerFactory();
       return new ILspLayerFactory(){
         @Override
         public boolean canCreateLayers(ILcdModel aModel){
           return delegate.canCreateLayers(aModel);
         }

         @Override
         public Collection<ILspLayer> createLayers(ILcdModel aModel){
           Collection<ILspLayer> layers = delegate.createLayers(aModel);
           for(ILspLayer layer : layers){
             ILcdIcon icon = ...;
             layer.setIcon(icon)
           }
           return layers;
         }
       }
     }
   }
 }
 

Specified by:

createBaseFormat in class ALcyLspFormatAddOn

Returns:

a new format for this add-on

createFormatWrapper

protected final ALcyLspFormat createFormatWrapper(ALcyLspFormat aBaseFormat)

Description copied from class: ALcyLspFormatAddOn

Returns a new data format wrapper for this add-on. A format wrapper extends the base format with aspects such as safe guarding, etc.

Overriding this method of an existing add-on should be done with extreme care as add-ons typically rely on the wrappers that should be present (e.g. a safe guard).

Specified by:

createFormatWrapper in class ALcyLspFormatAddOn

Parameters:

aBaseFormat - the base format to wrap

Returns:

a new format for this add-on

See Also:

ALcyLspFormatWrapper

getAddGridActionForMap

public final ILcdAction getAddGridActionForMap(ILcyGenericMapComponent<?,?> aMapComponent)

Returns the ILcdAction which can be used to add a MGRS grid on the specified map.

Parameters:

aMapComponent - The map component

Returns:

the ILcdAction which can be used to add a MGRS grid on aMapComponent, or null when no such action is available (for example when the map has already been closed).