mapInterceptor

Identifier:
net.refractions.udig.project.mapInterceptor

Since:
1.1

Description:
This extension point allows interceptor actions to be run at various points during the lifecycle of a Map.

Configuration Markup:

<!ELEMENT extension (mapCreation | mapOpening | mapClosing | layerAdded | layerRemoved)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED

>


<!ELEMENT mapCreation EMPTY>

<!ATTLIST mapCreation

id    CDATA #REQUIRED

name  CDATA #IMPLIED

class CDATA #REQUIRED

>

This element declares an interceptor that will be ran after the map is created but before any layers have been added. So the default map name will have been assigned and the eResource will have already been set on the map.



<!ELEMENT mapOpening EMPTY>

<!ATTLIST mapOpening

id    CDATA #REQUIRED

name  CDATA #IMPLIED

class CDATA #REQUIRED

>

An interceptor that is ran before a map opens



<!ELEMENT mapClosing EMPTY>

<!ATTLIST mapClosing

id    CDATA #REQUIRED

name  CDATA #IMPLIED

class CDATA #REQUIRED

>

An interceptor that is ran as the map is closing. The map will still be open but will close. This cannot cancel closing.



The layerAdded element is deprecated

<!ELEMENT layerAdded EMPTY>

<!ATTLIST layerAdded

id    CDATA #REQUIRED

name  CDATA #IMPLIED

class CDATA #REQUIRED

>

See the LayerInterceptor extension point



The layerRemoved element is deprecated

<!ELEMENT layerRemoved EMPTY>

<!ATTLIST layerRemoved

id    CDATA #REQUIRED

name  CDATA #IMPLIED

class CDATA #REQUIRED

>

See the LayerInterceptor extension point



Examples:
Example: Used to add a fixed set of default layers to every new map

Example: Used to configure layer with a default style

API Information:
MapInterceptor is used to apply actions against a Map. LayerInterceptor is used to apply actions against a Layer.

Supplied Implementation:
Developers Guide entry on MapInterceptor and LayerInterceptor


(c) 2006 udig.refractions.net