net.refractions.udig.style
Identifier:
net.refractions.udig.style.net.refractions.udig.style
Since:
1.0
Description:
The extension point for a UI element for editing a style on a layer's style blackboard.
Configuration Markup:
<!ELEMENT extension (styleConfigurator+)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
>
Allows the definition of a StyleConfigurator - presenting a user interface to items on the StyleBlackboard.
<!ELEMENT styleConfigurator EMPTY>
<!ATTLIST styleConfigurator
id CDATA #IMPLIED
label CDATA #REQUIRED
requires CDATA #IMPLIED
class CDATA #REQUIRED
styleId CDATA #REQUIRED
>
Configures a IStyleConfigurator with responsibilities for:
- Creating a ui to allow user configuration of a style object.
- Placing style object information onto the style blackboard of a layer.
- Determining if a style configurator can be used to configure the style of a particular layer.
The user interface provided here will be shown in both the Style View and in the Style Dialog Editor.
- id - Optional identifier used to indicate the ui in error and log messages.
- label - This should be a human readable label which can be used to identify the style configurator in the ui.
- requires - This is the data access API you are expecting to control; for example FeatureSource.
If defined, the selected layer must resolve this class in order for this configurator to be displayed
- class - Aninstance of IStyleConfigurator providing a user interface for editing the indicated styleId.
- styleId - The id of the style extension that the configurator is intended to work with. This extension point works in conjunction with the net.refractions.udig.project.style extension point. The "id" attribute of an extension of that type should match the "styleId" attribute of an extension of this type.
Examples:
Here is an example use from the uDig application:
...
There is a complete examples in net.refractions.udig.tutorials.style
API Information:
Implemententors must provide an implementation of IStyleConfigurator; this class is used to construct a user interface for display in the StyleEditor or in the StyleView. The class is expected to work directly with the contents of a layer style blackboard.
If possible try and perform spot changes on the StyleBlackboard (in case other style configurators are working on the same blackboard entry as you).
In the case of StyleView any changes you make to the StyleBlackboard will cause an immediate redraw; for the StyleEditor the user will need to hit Apply or OK to cause a redraw.
Supplied Implementation:
This extension is focused on the user interface only; the definition of style content and the definition of new renderers is handled elsewhere.
uDig - User Friendly Desktop Internet GIS client