%printing.ui.boxFactories.name
Identifier:
net.refractions.udig.printing.ui.boxFactories
Since:
[Enter the first release in which this extension point appears.]
Description:
[Enter description of this extension point.]
Configuration Markup:
<!ELEMENT extension (boxprinter+ , editActionGroup*)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED
>
Defines box printers. A box printer is the object that is responsible for printing and previewing a box. For a template to be able to use/save/load boxes (and their box printers) the box printer must have a boxprinter extension definition. This is required because of the classloading enforced by eclipse.
<!ELEMENT boxprinter EMPTY>
<!ATTLIST boxprinter
class CDATA #REQUIRED
visible (true | false) "true"
description CDATA #IMPLIED
name CDATA #REQUIRED
smallImage CDATA #IMPLIED
largeImage CDATA #IMPLIED
defaultAction CDATA #IMPLIED
>
boxprinter provides the declaration for BoxPrinter classes. They must implement net.refractions.udig.printing.model.BoxPrinter. The class attribute must contain this class name. The visible element should be set to false if the user should not be able to create their own instances of this box. It will not appear in the slide-out palette in the UI.
- class - The class that will be instantiated.
- visible - The visible element should be set to false if the user should not be able to create their own instances of this box. It will not appear in the slide-out palette in the UI.
- description - A brief description of the purpose of the box. Good for a tooltip
- name - The name of the icon that will be displayed on the tool palette.
- smallImage - A small 16X16 icon that represents the box. Will be put on the tool palette.
- largeImage - A 24x24 pixel icon that represents the box. Will be put on the tool palette.
- defaultAction - The id of the "Default" action. In practice this is the action that will be executed on a double click.
IMPORTANT: The id defined in the extension's id field must be specified AND the id of the plugin it is defined int.
Example: if the ID is mapEditorAction and the plugin is net.refractions.udig.printing then the id entered must be:
net.refractions.udig.printing.mapEditorAction
See the net.refractions.udig.editAction extension point. It is the id of the editAction sub-element in that extension.
The editActionGroup element is deprecated
<!ELEMENT editActionGroup (editAction+)>
<!ATTLIST editActionGroup
acceptable CDATA #REQUIRED
>
A group of edit actions that can operate on a given BoxPrinter class
- acceptable - the type of boxprinter that the actions can operate on.
The editAction element is deprecated
<!ELEMENT editAction EMPTY>
<!ATTLIST editAction
class CDATA #REQUIRED
name CDATA #REQUIRED
image CDATA #IMPLIED
id CDATA #REQUIRED
>
an edit action that will operate on the "acceptable" type of boxprinter. See editActionGroup for the definition of acceptable.
- class - The action that will perform the changes indicated by the policy.
- name - The display name of the action
- image - The image that will appear in the context menu.
- id -
Examples:
[Enter extension point usage example here.]
API Information:
[Enter API information here.]
Supplied Implementation:
[Enter information about supplied implementation of this extension point.]