net.refractions.udig.project
Interface ProjectBlackboardConstants


public interface ProjectBlackboardConstants

Lists the keys of common items that are put on the Map blackboard and the Layer blackboard

Since:
1.1.0
Author:
Jesse

Field Summary
static java.lang.String LAYER__DATA_QUERY
          If a filter or a query is on a layer's blackboard under the key: the LAYER__DATA_QUERY then the interceptor ShowViewInterceptor will return the "view" see DataStore#getView(Query).
static java.lang.String LAYER__EDIT_APPLICABILITY
          Key to indicate a layer may be edited.
static java.lang.String LAYER__FEATURES_ADD_APPLICABILITY
          NOT USED at the current codebase
static java.lang.String LAYER__FEATURES_MODIFY_APPLICABILITY
          NOT USED at the current codebase
static java.lang.String LAYER__FEATURES_REMOVE_APPLICABILITY
          FALSE boolean value contained in layer's blackboard advises the platform to block removing of features functionality in the target layer.
static java.lang.String LAYER__LAST_RESORT_RENDERER
          Provides a way to influence the choice of renderers.
static java.lang.String LAYER__MAXIMUM_ZOOM_SCALE
          NOT USED at the current codebase.
static java.lang.String LAYER__MINIMUM_ZOOM_SCALE
           
static java.lang.String LAYER__PREFERRED_RENDERER
          Provides a way to influence the choice of renderers.
static java.lang.String MAP__BACKGROUND_COLOR
          The key to the map's background color on the blackboard.
static java.lang.String MAP__DATA_QUERY
          If a filter or a query is on the map blackboard under the key: the MAP__DATA_QUERY then the interceptor ShowViewInterceptor will return the "view" see DataStore#getView(Query).
static java.lang.String MAP__LAST_RESORT_RENDERER
          Provides a way to influence the choice of renderers.
static java.lang.String MAP__PREFERRED_RENDERER
          Provides a way to influence the choice of renderers.
static java.lang.String MAP__RENDERING_FILTER
          Any filter in this entry will be used to filter out features from the rendering.
 

Field Detail

MAP__PREFERRED_RENDERER

static final java.lang.String MAP__PREFERRED_RENDERER
Provides a way to influence the choice of renderers. The value of a blackboard entry must a string which is the id of the Renderer as declared in the Extension definition. For example "BasicFeatureRenderer".

If an entry is on the Map's blackboard with this key then that renderer will be preferred over other renderers unless there is also an entry on a layer. In that case the layer's renderer still has precidence.

IMPORTANT: don't forget to append the plugin ID to the id entered into the id field.

See Also:
LAYER__PREFERRED_RENDERER, MAP__LAST_RESORT_RENDERER

MAP__LAST_RESORT_RENDERER

static final java.lang.String MAP__LAST_RESORT_RENDERER
Provides a way to influence the choice of renderers. The value of a blackboard entry must a string which is the id of the Renderer as declared in the Extension definition. For example "BasicFeatureRenderer".

If an entry is on the Map's blackboard with this key then that renderer will be negatively weighted compared to other renderers.

IMPORTANT: don't forget to append the plugin ID to the id entered into the id field.

See Also:
LAYER__LAST_RESORT_RENDERER, MAP__PREFERRED_RENDERER

MAP__BACKGROUND_COLOR

static final java.lang.String MAP__BACKGROUND_COLOR
The key to the map's background color on the blackboard. The object returned will be null or a Color

See Also:
Constant Field Values

MAP__DATA_QUERY

static final java.lang.String MAP__DATA_QUERY
If a filter or a query is on the map blackboard under the key: the MAP__DATA_QUERY then the interceptor ShowViewInterceptor will return the "view" see DataStore#getView(Query). In addition Renderers should attempt to use the query to filter what is displayed.

If a filter is on the map blackboard then it will apply to all layers.

If a query is on the Map blackboard then it will be applied only those layers who's typename is the same as that in the query.

If there is a filter or query on both the Map blackboard and the layer blackboard then the item on the layer blackboard will take precedence.

See Also:
LAYER__DATA_QUERY, Constant Field Values

MAP__RENDERING_FILTER

static final java.lang.String MAP__RENDERING_FILTER
Any filter in this entry will be used to filter out features from the rendering. For example if a fid filter is here that feature WILL NOT be rendered.

See Also:
Constant Field Values

LAYER__PREFERRED_RENDERER

static final java.lang.String LAYER__PREFERRED_RENDERER
Provides a way to influence the choice of renderers. The value of a blackboard entry must a string which is the id of the Renderer as declared in the Extension definition. For example "BasicFeatureRenderer".

If an entry is on a Layer's blackboard with this key then that renderer will be preferred over other renderers.

IMPORTANT: don't forget to append the plugin ID to the id entered into the id field.

See Also:
MAP__PREFERRED_RENDERER, LAYER__LAST_RESORT_RENDERER

LAYER__LAST_RESORT_RENDERER

static final java.lang.String LAYER__LAST_RESORT_RENDERER
Provides a way to influence the choice of renderers. The value of a blackboard entry must a string which is the id of the Renderer as declared in the Extension definition. For example "BasicFeatureRenderer".

If an entry is on a Layer's blackboard with this key then that renderer will be negatively weighted compared to other renderers.

IMPORTANT: don't forget to append the plugin ID to the id entered into the id field.

See Also:
MAP__LAST_RESORT_RENDERER, LAYER__PREFERRED_RENDERER

LAYER__DATA_QUERY

static final java.lang.String LAYER__DATA_QUERY
If a filter or a query is on a layer's blackboard under the key: the LAYER__DATA_QUERY then the interceptor ShowViewInterceptor will return the "view" see DataStore#getView(Query). In addition Renderers should attempt to use the query to filter what is displayed.

If a filter is in the layer StyleBlackboard then the filter will only apply to that layer.

If a query is in the Layer StyleBlackboard then it will be applied to the layer even if the type name is incorrect

If there is a filter or query on both the Map blackboard and the layer StyleBlackboard then the item on the layer StyleBlackboard will take precedence.

If the query is found on the map

See Also:
MAP__DATA_QUERY, Constant Field Values

LAYER__EDIT_APPLICABILITY

static final java.lang.String LAYER__EDIT_APPLICABILITY
Key to indicate a layer may be edited.

See Also:
UDIGFeatureStore, Constant Field Values

LAYER__MINIMUM_ZOOM_SCALE

static final java.lang.String LAYER__MINIMUM_ZOOM_SCALE
See Also:
net.refractions.udig.project.preferences.PreferenceConstants.P_MINIMUM_ZOOM_SCALE, Constant Field Values

LAYER__MAXIMUM_ZOOM_SCALE

static final java.lang.String LAYER__MAXIMUM_ZOOM_SCALE
NOT USED at the current codebase.

See Also:
Constant Field Values

LAYER__FEATURES_REMOVE_APPLICABILITY

static final java.lang.String LAYER__FEATURES_REMOVE_APPLICABILITY
FALSE boolean value contained in layer's blackboard advises the platform to block removing of features functionality in the target layer.

See Also:
Constant Field Values

LAYER__FEATURES_ADD_APPLICABILITY

static final java.lang.String LAYER__FEATURES_ADD_APPLICABILITY
NOT USED at the current codebase

See Also:
Constant Field Values

LAYER__FEATURES_MODIFY_APPLICABILITY

static final java.lang.String LAYER__FEATURES_MODIFY_APPLICABILITY
NOT USED at the current codebase

See Also:
Constant Field Values