Modeling Assistant Providers

Identifier:
org.eclipse.gmf.runtime.emf.ui.modelingAssistantProviders

Since:
[Enter the first release in which this extension point appears.]

Description:
This extension point is used to define modeling assistant providers for the modeling assistant service. The modeling assistant service allows plug-ins to modify or contribute to the modeling assistant behavior (e.g. connector handles).

Configuration Markup:

<!ELEMENT extension (modelingAssistantProvider+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT modelingAssistantProvider (Priority , object* , context*)>

<!ATTLIST modelingAssistantProvider

class CDATA #REQUIRED>

The modeling assistant provider description tag



<!ELEMENT Priority EMPTY>

<!ATTLIST Priority

name (Lowest|Low|Medium|High|Highest) >

The description for the priority of the modeling assistant provider



<!ELEMENT object (method* , staticMethod*)>

<!ATTLIST object

id    CDATA #REQUIRED

class CDATA #IMPLIED>

A descriptor of an object that is examined by this provider. The object descriptor can include an optional set of methods to call on the object.



<!ELEMENT method (value* , notValue*)>

<!ATTLIST method

name     CDATA #REQUIRED

value    CDATA #IMPLIED

notValue CDATA #IMPLIED>

A method to call by reflection on the object. The method has a name and a value. The value could be described by its string representation (value & notValue), or as an object "value" or "notValue". The rules of evaluation are as follows: 1- The return value string has to be in the "value" string set. 2- The return value string has to be not in the "notValue" string set. 3- The return value object has to be in the "value" object set. 4- The return value object has to be not in the "notValue" object set.



<!ELEMENT staticMethod (value* , notValue*)>

<!ATTLIST staticMethod

name     CDATA #REQUIRED

value    CDATA #IMPLIED

notValue CDATA #IMPLIED>

A static method to call by reflection on the class. The static method has a name and a value. The value could be described by its string representation (value & notValue), or as an object "value" or "notValue". The rules of evaluation are as follows: 1- The return value string has to be in the "value" string set. 2- The return value string has to be not in the "notValue" string set. 3- The return value object has to be in the "value" object set. 4- The return value object has to be not in the "notValue" object set.



<!ELEMENT value (method*)>

<!ATTLIST value

class CDATA #IMPLIED>

A descriptor of an object that represents a method's returned value. The descriptor can include an optional set of methods to call on the "value" object.



<!ELEMENT notValue (method*)>

<!ATTLIST notValue

class CDATA #IMPLIED>

A descriptor of an object that represents a method's returned value that is not required. The descriptor can include an optional set of methods to call on the "notValue" object.



<!ELEMENT context EMPTY>

<!ATTLIST context

operationId CDATA #IMPLIED

elements    CDATA #IMPLIED>

The context of a modeling assistant provider.



Examples:
Here is an example for a modeling assistant provider that provides types for all outgoing connector handle gestures on classes and interfaces.

   <extension id="LogicModelingAssistantProvider" name="%logic.provider.modelingassistant" point="org.eclipse.gmf.runtime.emf.ui.modelingAssistantProviders">
      <modelingAssistantProvider class="org.eclipse.gmf.examples.runtime.diagram.logic.internal.providers.LogicModelingAssistantProvider">
         <Priority name="Low"/>
         <object class="org.eclipse.gmf.examples.runtime.diagram.logic.internal.editparts.ConnectionPointEditPart(org.eclipse.gmf.examples.runtime.diagram.logic)" 
          id="CONNECTIONPOINT">                        
         </object>
         <object class="org.eclipse.gmf.examples.runtime.diagram.logic.internal.editparts.LogicFlowCompartmentEditPart(org.eclipse.gmf.examples.runtime.diagram.logic)" 
          id="LOGIC_FLOW_COMPARTMENT">               
         </object>
         <object class="org.eclipse.gmf.examples.runtime.diagram.logic.internal.editparts.LogicShapeCompartmentEditPart(org.eclipse.gmf.examples.runtime.diagram.logic)" 
          id="LOGIC_SHAPE_COMPARTMENT">               
         </object>
         <context elements="CONNECTIONPOINT,LOGIC_FLOW_COMPARTMENT,LOGIC_SHAPE_COMPARTMENT"/>
      </modelingAssistantProvider>
   </extension>

Supplied Implementation:
[Enter information about supplied implementation of this extension point.]


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