WTP UI Action
Identifier:
org.eclipse.wst.common.frameworks.ui.wtpuiAction
Since:
1.0
Description:
This extension point is for WTP Operations which need to be tied to a generic UI action, such as CUT, COPY, PASTE, DELETE, and RENAME.
Configuration Markup:
<!ELEMENT extension ((masterOperation | slaveOperation))>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
- point - a fully qualified identifier of the target extension point
- id - an optional identifier of the extension instance
- name - an optional name of the extension instance
<!ELEMENT masterOperation (selectionEnablement)>
<!ATTLIST masterOperation
extendedGenericId CDATA #REQUIRED
operationClass CDATA #IMPLIED
name CDATA #REQUIRED
description CDATA #IMPLIED
populatorClass CDATA #REQUIRED
alwaysExecute (true | false)
overrideId CDATA #IMPLIED
id CDATA #IMPLIED>
A masterOperation enables an existing WTP Operation to be used in a UI action. Generic Ids aggregate a set of masterOperations for the same Abstract action (like a "CUT" operation). WTP Operations are themselves extendible, so for any masterOperation defined, there may be any number of pre|post operations. These pre|post operation can have slaveOperation elements defined which indicate the pre|post operation may be run independently.
- extendedGenericId - The ID of the Generic Action you would like to contribute to. (e.g. The id for CUT, COPY, PASTE, DELETE, RENAME).
- operationClass - The fully qualified class of your operation. Your operation must be a WTPOperation and must provide a no-arguments default constructor. If this attribute is not provided, the getDefaultOperation() returned by the dataModel will be used.
- name - A name to display in the dialog for your action (if the operation is optional). You can use the standard "%key" for translatable text stored in plugin.properties.
- description - A description to display in the dialog for your action (if the operation is optional). You can use the standard "%key" for translatable text stored in plugin.properties.
- populatorClass - The populatorClass knows how to provide a WTP Operation Data Model based on a given selection. The getDefaultOperation() method of the data model will be ignored if the operationClass is provided.
- alwaysExecute - optional setting to determine execution context
- overrideId - optional setting to define an overridable id
- id - optional identification for operation instance
<!ELEMENT selectionEnablement (objectClass | or)>
The selectionEnablement element allows you to filter which kinds of selection your object is applicable to using Standard Eclipse Action Expresions.
<!ELEMENT slaveOperation EMPTY>
<!ATTLIST slaveOperation
operationClass CDATA #REQUIRED
name CDATA #REQUIRED
description CDATA #IMPLIED>
The slaveOperation element defines display information for operations which extend a declared master operation. If a pre|post operation of a master does not have a corresponding slaveOperation element, then the pre|post operation will be consider required, and not be displayed to the user.
- operationClass - The fully qualified class of your operation. Your operation must be a WTPOperation and must provide a no-arguments default constructor. For slave operations, the data model of the master operation will be provided. Therefore, slaves cannot override the data model using a seperate populatorClass.
- name - A name to display in the dialog for your action (if the operation is optional). You can use the standard "%key" for translatable text stored in plugin.properties.
- description - A description to display in the dialog for your action (if the operation is optional). You can use the standard "%key" for translatable text stored in plugin.properties.
<!ELEMENT or (objectClass | and | objectState)>
<!ELEMENT objectClass EMPTY>
<!ATTLIST objectClass
name CDATA #IMPLIED
adaptable CDATA #IMPLIED>
- name - fully qualified name of the object class
- adaptable - optional setting to specify the object class as adaptable
<!ELEMENT and (objectClass | or)>
<!ELEMENT objectState EMPTY>
<!ATTLIST objectState
value CDATA #IMPLIED
name CDATA #IMPLIED>
- value - optional setting for the value of a specific object state
- name - optional setting for an object state name to check the selected object's value is matching with
Examples:
Copyright (c) 2005 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html