Icon Providers Extension Point

org.eclipse.gmf.runtime.common.ui.services.iconProviders

This extension point is used to define icon providers for the icon service (org.eclipse.gmf.runtime.common.ui.services.icon.IconService).

The icon service supplies an icon for a given element.

<!ELEMENT extension (IconProvider)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT IconProvider (Priority , Policy? , object* , context*)>

<!ATTLIST IconProvider

class CDATA #REQUIRED>


<!ELEMENT Priority EMPTY>

<!ATTLIST Priority

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


<!ELEMENT Policy EMPTY>

<!ATTLIST Policy

class CDATA #REQUIRED>


<!ELEMENT object (method*)>

<!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 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 context EMPTY>

<!ATTLIST context

elements CDATA #IMPLIED>

A context supported by the editpart provider.



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



Following is an example of an icon provider extension:

   

<extension id=

"iconProviders"

name=

"%ext.iconProviders"

point=

"org.eclipse.gmf.runtime.common.ui.services.iconProviders"

>

<IconProvider class=

"org.eclipse.test.project.providers.icon.MyIconProvider"

>

<Priority name=

"Lowest"

>

</Priority>

</IconProvider>

</extension>

The value of the class attribute must be the fully qualified name of a class that implements org.eclipse.gmf.runtime.common.ui.services.icon.IIconProvider.