Metamodel Integration UI Providers

Identifier:
com.ibm.xtools.mmi.ui.MMIUIProviders

Since:
This extension point is new to Version 7.0.

Description:
This extension point defines the semantics of Meta Model Integration User Interface providers. A Meta Model Integration User Interface Provider provides handlers that handle common diagramming tasks, such as extracting the sources from an UI object or obtaining the EClass of a source element. This extension point also provides internal support for Browse Diagrams and Related Elements handlers.

Configuration Markup:

<!ELEMENT extension (MMIUIProvider*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT MMIUIProvider (Priority , MMIUIHandler* , MMIShowRelatedElementsHandler* , MMIBrowseDiagramHandler* , OpenStructuredReferenceHandler*)>

<!ATTLIST MMIUIProvider

class CDATA #REQUIRED>

Visualization UI provider provides handlers for base ui operations, relationships for Browse Diagrams, show related elements, open VizRef.



<!ELEMENT Priority EMPTY>

<!ATTLIST Priority

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

Priority of this provider



<!ELEMENT MMIUIHandler (enablement)>

<!ATTLIST MMIUIHandler

uiObjectClass CDATA #REQUIRED

name          CDATA #IMPLIED>

Description of handler for base visualization ui operations. A MMIUIHandler is defined by the class of the objects that this handler can handle, and the kind of the diagram on which this object is handled. Name of the MMIUIHandler is optional.



<!ELEMENT MMIShowRelatedElementsHandler (StructuredReferenceProviderId+)>

<!ATTLIST MMIShowRelatedElementsHandler

name CDATA #IMPLIED>

Internal handler for showing related MMI elements.



<!ELEMENT MMIBrowseDiagramHandler (StructuredReferenceProviderId+)>

<!ATTLIST MMIBrowseDiagramHandler

name CDATA #IMPLIED>

Internal handler to return relationships to consider when making a Browse Diagram. Look at IBrowseDiagramHandler for more details.



<!ELEMENT StructuredReferenceProviderId EMPTY>

<!ATTLIST StructuredReferenceProviderId

id CDATA #REQUIRED>

Description of StructuredReferenceProviderId, similar to one described in StructuredReerenceProviders.exsd.



<!ELEMENT OpenStructuredReferenceHandler (StructuredReferenceProviderId+)>

<!ATTLIST OpenStructuredReferenceHandler

name CDATA #IMPLIED>

Handler that handles the action to perform when user requests to perform an open action on a StructuredReference.



The DiagramType element is deprecated

<!ELEMENT DiagramType EMPTY>

<!ATTLIST DiagramType

id CDATA #REQUIRED>

The string representation of the diagram's type, e.g. "Freeform"



<!ELEMENT enablement (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

A generic root element. The element can be used inside an extension point to define its enablement expression. The children of an enablement expression are combined using the "and" operator.



<!ELEMENT not (not | and | or | instanceof | test | systemTest | equals | count | with | resolve | adapt | iterate | reference)>

This element represents a NOT operation on the result of evaluating its sub-element expression.



<!ELEMENT and (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

This element represents an AND operation on the result of evaluating all its sub-elements expressions.



<!ELEMENT or (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

This element represent an OR operation on the result of evaluating all its sub-element expressions.



<!ELEMENT instanceof EMPTY>

<!ATTLIST instanceof

value CDATA #REQUIRED>

This element is used to perform an instanceof check of the object in focus. The expression returns EvaluationResult.TRUE if the object's type is a sub type of the type specified by the attribute value. Otherwise EvaluationResult.FALSE is returned.



<!ELEMENT test EMPTY>

<!ATTLIST test

property              CDATA #REQUIRED

args                  CDATA #IMPLIED

value                 CDATA #IMPLIED

forcePluginActivation (true | false) >

This element is used to evaluate the property state of the object in focus. The set of testable properties can be extended using the org.eclipse.core.expressions.propertyTesters extension point. The test expression returns EvaluationResult.NOT_LOADED if the property tester doing the actual testing isn't loaded yet and the attribute forcePluginActivation is set to false. If forcePluginActivation is set to true and the evaluation context used to evaluate this expression support plug-in activation then evaluating the property will result in activating the plug-in defining the tester.



<!ELEMENT systemTest EMPTY>

<!ATTLIST systemTest

property CDATA #REQUIRED

value    CDATA #REQUIRED>

Tests a system property by calling the System.getProperty method and compares the result with the value specified through the value attribute.



<!ELEMENT equals EMPTY>

<!ATTLIST equals

value CDATA #REQUIRED>

This element is used to perform an equals check of the object in focus. The expression returns EvaluationResult.TRUE if the object is equal to the value provided by the attribute value. Otherwise EvaluationResult.FALSE is returned.



<!ELEMENT count EMPTY>

<!ATTLIST count

value CDATA #REQUIRED>

This element is used to test the number of elements in a collection.



<!ELEMENT with (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

<!ATTLIST with

variable CDATA #REQUIRED>

This element changes the object to be inspected for all its child element to the object referenced by the given variable. If the variable can not be resolved then the expression will throw an ExpressionException when evaluating it. The children of a with expression are combined using the "and" operator.



<!ELEMENT resolve (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

<!ATTLIST resolve

variable CDATA #REQUIRED

args     CDATA #IMPLIED>

This element changes the object to be inspected for all its child element to the object referenced by the given variable. If the variable can not be resolved then the expression will throw an ExpressionException when evaluating it. The children of a resolve expression are combined using the "and" operator.



<!ELEMENT adapt (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

<!ATTLIST adapt

type CDATA #REQUIRED>

This element is used to adapt the object in focus to the type specified by the attribute type. The expression returns EvaluationResult.NOT_LOADED if either the adapter or the type referenced isn't loaded yet. It throws an ExpressionException during evaluation if the type name doesn't exist at all. The children of an adapt expression are combined using the "and" operator.



<!ELEMENT iterate (not , and , or , instanceof , test , systemTest , equals , count , with , resolve , adapt , iterate , reference)*>

<!ATTLIST iterate

operator (or|and)

ifEmpty  (true | false) >

This element is used to iterate over a variable that is of type java.util.Collection, or a variable that adapts to org.eclipse.core.expressions.IIterable. If the object in focus is not one of the above then a CoreException with an ExpressionStatus will be thrown while evaluating the expression. The child expressions of an iterate expression are combined using the "and" operator.



<!ELEMENT reference EMPTY>

<!ATTLIST reference

definitionId IDREF #REQUIRED>

This element is used to reference an expression from the org.eclipse.core.expressions.definitions extension point. The expression definition will be evaluated within the current expression element using the current evaluation context.



Examples:
Following is an example of a MMI UI Provider.


<extension
      id="pdeumlvizuiprovider"
      name="MMI UI Provider for PDE"
      point="com.ibm.xtools.mmi.ui.MMIUIProviders">
   <MMIUIProvider class="com.ibm.xtools.umlviz.ui.examples.pde.internal.ui.providers.PdeUmlVizUIProvider">
      <Priority name="Medium"/>
      <MMIUIHandler
            name="PdeVizUIHandler"
            uiObjectClass="org.eclipse.core.resources.IFile">
         <enablement>
            <or>
               <test property="com.ibm.xtools.mmi.ui.DiagramTypePropertyTester" value="Freeform"/>
               <test property="com.ibm.xtools.mmi.ui.DiagramTypePropertyTester" value="Class"/>
               <test property="com.ibm.xtools.mmi.ui.DiagramTypePropertyTester" value="Deployment"/>
            </or>
         </enablement>
      </MMIUIHandler>
      <OpenStructuredReferenceHandler name="PdeVizOpenHandler">
         <StructuredReferenceProviderId id="pde.IPluginBase"/>
      </OpenStructuredReferenceHandler>
   </MMIUIProvider>
</extension>

API Information:
The interface com.ibm.xtools.mmi.ui.services.IMMIUIProvider is to be implemented.

Supplied Implementation:
The platform itself does not have any predefined MMIUIProvider Particular product installs may include MMI UI providers as required. Please see the Example PDE Visualizer for an example MMIUIProvider.


Copyright (c) 2004, 2018 Model RealTime, HCL and others. All Rights Reserved.