Operation
Identifier:
net.refractions.udig.ui.Operation
Since:
UDIG 1.0
Description:
Contribute operations to the user interface; will show up in menu bars, toolbars and context menus as appropriate.
Configuration Markup:
<!ELEMENT extension (category* , operation*)+>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED
>
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
menuPath CDATA #IMPLIED
context CDATA #IMPLIED
>
A way of organizing operations in menus. The operation menus will be organized into submenus for each category of operations.
For example: "net.refractions.udig.ui.edit"
- id -
- name -
- menuPath - Location in the menu bar for operation category.
- context - Optional context used to contribute operation group into the appropriate context menus.
<!ELEMENT operation (enablement)>
<!ATTLIST operation
id CDATA #REQUIRED
name CDATA #REQUIRED
icon CDATA #IMPLIED
class CDATA #REQUIRED
targetClass CDATA #REQUIRED
categoryId CDATA #IMPLIED
menuPath CDATA #IMPLIED
enablesFor CDATA "1"
>
An definition for an operation on a data element. Operations can be performed on objects including but not limited to Layers, FeatureSources/Stores, IGeoResources, etc...
The type object that the operation operates on is declared in this extension point and when the selection includes objects that the operation can be performed on, a menu item will be enabled in the Operations menu and available in the context menu in the view where the selection occurred
- id -
- name -
- icon -
- class - The operation class that will perform an operation on the targetClass.
- targetClass - The class of objects that the declared operation can operate on.
- categoryId - The category that this operation is part of.
- menuPath - If the menuPath attribute is used to define a location in the menubar for the operation to appear.
For example if the menuPath=layer/additions then the operation will appear the layer menu.
- enablesFor -
a value indicating the selection count which must be met to enable the action. If specified and the condition is not met, the action is disabled. If omitted, the value is assumed to be 1. The following attribute formats are supported:
- + - 1 or more items selected
- multiple, 2+ - 2 or more items selected
- n - a precise number of items selected.a precise number of items selected. For example: enablesFor=" 4" enables the action only when 4 items are selected
<!ELEMENT and (adaptsTo* , property* , and* , or* , not*)>
<!ELEMENT or (adaptsTo* , property* , and* , or* , not*)>
<!ELEMENT not (adaptsTo | property | and | or | not)>
<!ELEMENT enablement (adaptsTo | and | or | not | property)>
<!ELEMENT adaptsTo EMPTY>
<!ATTLIST adaptsTo
target CDATA #IMPLIED
>
<!ELEMENT property EMPTY>
<!ATTLIST property
name CDATA #IMPLIED
target CDATA #IMPLIED
propertyId CDATA #REQUIRED
expectedValue CDATA #REQUIRED
>
See objectProperty.exsd
Declares the propertyName that a condition element operates on.
TODO: Need to place a link here to a spot where valid propertyNames are declared.
- Deprecated name - The id of the property extension to use.
See net.refractions.udig.ui.objectProperty
It is the id of the property element which is a grandchild of the ObjectProperty element.
- Deprecated target - The value that "property" is compared to.
- propertyId - The id of the property extension to use.
See net.refractions.udig.ui.objectProperty
It is the id of the property element which is a grandchild of the ObjectProperty element.
- expectedValue - The value that the property is expected to match
Examples:
[Enter extension point usage example here.]
API Information:
[Enter API information here.]
Supplied Implementation:
[Enter information about supplied implementation of this extension point.]