# Presentation View Providers

###### Identifier:

org.eclipse.gmf.runtime.diagram.core.viewProviders

###### Since:

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

###### Description:

[Enter description of this extension point.]

###### Configuration Markup:

<!ELEMENT extension (viewProvider+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED

>

- point - The identifier of the extension point, i.e. `org.eclipse.gmf.runtime.diagram.core.viewProviders`
- id - The identifier of the extension, e.g. viewProvider.
- name - The name of the extension, e.g. %ext.viewProvider.

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

<!ATTLIST viewProvider

class CDATA #REQUIRED

>

The view provider description tag. A provider's description outlines zero or more objects to be referenced by the provider's contexts, and then lists zero or more contexts supported by the provider.

- class - The fully qualified name of the view provider class

<!ELEMENT Priority EMPTY>

<!ATTLIST Priority

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

>

The description for the priority of the view provider

- name - The priority of the provider. It can be one of the following values: >Lowest, Low, Medium, High, Highest>. Consideration of dependencies has to be done when choosing the priority. A provider that adds contributions to paths (menus | groups) contributed by other providers has to have a higher priority than them.

<!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 can have an optional set of methods to call upon.

- id - A unique (within the context of this provider XML definition) identifier for the object
- class - The fully qualified name of a class/interface who is assignable from or adaptable to the object. The name could be followed (between paranthesis "()") by the id of a plugin whose classloader is able to load that class. The finaly syntax is: className<(plugin id)>?

<!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.

- name - The name of the Static Method, the format should be PluginID\ClassName.method followed by an optional paramter set between paranthesis "()". The parameter set can contain any number of primitive parameters or %Context(pluginID/className) to use the context object as a parameter . other param types are not supported. The method name could contain nested calling separated by "." The general format for this method name is : <pluginID/ClassName.func(<param<,param>*>?).<<func(<param<,param>*>?)>*
- value - A comma-separated (",") list of string representations of the method return value. The string representation of the value is expected to be "one" of those in the list. The syntax to use is the following: <string><,<string>>* If (",") is expected to be in one of the strings, it has to be escaped by a forward slash ("\"). "null" is accepted as a string and it means (a null object).
- notValue - A comma-separated (",") list of string representations of the method return value that is not expected (the execulsion set). The string representation of the value is expected "not" to be "one" of those in the list. The syntax to use is the following: <string><,<string>>* If (",") is expected to be in one of the strings, it has to be escaped by a forward slash ("\"). "null" is accepted as a string and it means (a null 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.

- name - The name of the method followed by an optional paramter set between paranthesis "()". The parameter set can contain any number of string parameters (literals). other param types are not supported. The method name could contain nested calling separated by "." The general format for this method name is : <func(<param<,param>*>?).<<func(<param<,param>*>?)>*
- value - A comma-separated (",") list of string representations of the method return value. The string representation of the value is expected to be "one" of those in the list. The syntax to use is the following: <string><,<string>>* If (",") is expected to be in one of the strings, it has to be escaped by a forward slash ("\"). "null" is accepted as a string and it means (a null object).
- notValue - A comma-separated (",") list of string representations of the method return value that is not expected (the execulsion set). The string representation of the value is expected "not" to be "one" of those in the list. The syntax to use is the following: <string><,<string>>* If (",") is expected to be in one of the strings, it has to be escaped by a forward slash ("\"). "null" is accepted as a string and it means (a null object).

<!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.

- class - The fully qualified name of a class/interface that is assignable from or adaptable to the "value" object. The name could be followed (between paranthesis "()") by the id of a plugin whose classloader is able to load that class. The finaly syntax is: className<(plugin id)>?

<!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.

- class - The fully qualified name of a class/interface that is assignable from or adaptable to the "value" object. The name could be followed (between paranthesis "()") by the id of a plugin whose classloader is able to load that class. The finaly syntax is: className<(plugin id)>?

<!ELEMENT context EMPTY>

<!ATTLIST context

viewClass (org.eclipse.gmf.runtime.notation.Node|org.eclipse.gmf.runtime.notation.Diagram|org.eclipse.gmf.runtime.notation.Edge)

elements CDATA #IMPLIED

containerViews CDATA #IMPLIED

semanticHints CDATA #IMPLIED

>

A context supported by the view provider which contains values for the different hint parameters needed to create views.

- viewClass - A fully qualified name of a view class from a list of different kinds of views createable by the view service that the provider can accept in this context. This field is an enumeration consisting of one of the following possible values: org.eclipse.gmf.runtime.notation.Node org.eclipse.gmf.runtime.notation.Diagram org.eclipse.gmf.runtime.notation.Edge
- elements - A comma-separated list of object ids (from the provider XML definition) that represents elements that this provider can accept for in this context.
- containerViews - A comma-separated list of object ids (from the provider XML definition) that represents container views that this provider can accept in this context.
- semanticHints - A comma-separated list of strings that represents semantic hints that this provider can accept in this context.

###### Examples:

[Enter extension point usage example here.]

###### 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