Model Viewer Participant

com.sodius.mdw.platform.model.viewerParticipant

MDWorkbench 3.0.0

Enables to adapt the structure and the display of model elements.

A metamodel administrator may provide label decorations and filters that the end-user can activate or deactivate at any time in the model editor. He may also contribute to display the documentation of model elements in tooltips.

Keywords: keywords are used to create a lightweight connections between views displaying various model elements and viewer participants (label decorators, content providers and filters). Rather than explicitly having to reference specific views, a viewer participant states the kind of elements it can handle, though the use of keywords. Each view declares the keywords it can handle, letting the platform bind the corresponding viewer participants.

Here are some notable keywords:

Keyword	Description	Class
`instance`	instances contained in a model	`com.sodius.mdw.model.MDWObject`
`feature`	feature of a metatype	`org.eclipse.emf.ecore.EStructuralFeature`
`attribute`	attribute of a metatype	`org.eclipse.emf.ecore.EAttribute`
`reference`	reference of a metatype	`org.eclipse.emf.ecore.EReference`

<!ELEMENT extension (labelDecorator* , viewerFilter* , contentProvider* , documentationProvider*)>

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

<!ATTLIST labelDecorator

id CDATA #REQUIRED

name CDATA #REQUIRED

description CDATA #IMPLIED

metamodel CDATA #IMPLIED

class CDATA #REQUIRED

enabled (true | false)

keywords CDATA #REQUIRED>

a decorator in charge to customize the labels of model elements. This is used for example by the platform to suffix model elements with their respective type names. A decorator may be activated or deactivated at any time by the user.

id - a unique name that will be used to identify this decorator
name - a translatable name that will be used in the UI for this decorator
description - a description of the purpose of this decorator
metamodel - the id of the metamodel this decorator applies to (e.g. "uml21"). Leave empty if it applies to any metamodel.
class - a class that implement org.eclipse.jface.viewers.ILabelDecorator
enabled - if true, this decorator will be activated by default
keywords - a comma-separated list of keywords this decorator applies to

<!ELEMENT viewerFilter EMPTY>

<!ATTLIST viewerFilter

id CDATA #REQUIRED

name CDATA #REQUIRED

description CDATA #IMPLIED

metamodel CDATA #IMPLIED

class CDATA #REQUIRED

enabled (true | false)

keywords CDATA #REQUIRED>

a filter used to hide some model elements based on a specific criterium. A filter may be activated or deactivated at any time by the user.

id - a unique name that will be used to identify this filter
name - a translatable name that will be used in the UI for this filter
description - a description of the purpose of this filter
metamodel - the id of the metamodel this filter applies to (e.g. "uml21"). Leave empty if it applies to any metamodel.
class - a class that extends org.eclipse.jface.viewers.ViewerFilter
enabled - if true, this filter will be activated by default
keywords - a comma-separated list of keywords this filter applies to

<!ELEMENT contentProvider EMPTY>

<!ATTLIST contentProvider

id CDATA #REQUIRED

name CDATA #REQUIRED

description CDATA #IMPLIED

metamodel CDATA #IMPLIED

enabled (true | false)

keywords CDATA #REQUIRED

contentProvider CDATA #REQUIRED

labelProvider CDATA #IMPLIED

viewerSorter CDATA #IMPLIED

viewerFilter CDATA #IMPLIED

a content provider used to add additional contents to elements displayed in the model editor. A content provider may be activated or deactivated at any time by the user.

id - a unique name that will be used to identify this provider
name - a translatable name that will be used in the UI for this provider
description - a description of the purpose of this provider
metamodel - the id of the metamodel this provider applies to (e.g. "uml21"). Leave empty if it applies to any metamodel.
enabled - if true, this provider will be activated by default
keywords - a comma-separated list of keywords this provider applies to
contentProvider - a class that implements org.eclipse.jface.viewers.ITreeContentProvider
labelProvider - an optional class that implement org.eclipse.jface.viewers.ILabelProvider, in case provided elements cannot be correctly displayed by the default label provider.
viewerSorter - an optional class that extends FilteredViewerSorter, to add a sorter when this content provider is activated.
viewerFilter - an optional class that extends org.eclipse.jface.viewers.ViewerFilter, to add a filter when this content provided is activated.
priority - indicates the relative priority of this extension to other extensions.

<!ELEMENT documentationProvider EMPTY>

<!ATTLIST documentationProvider

id CDATA #REQUIRED

metamodel CDATA #REQUIRED

class CDATA #REQUIRED>

provides documentation for model elements of a particular metamodel. This documentation is shown in a tooltip in the model editor. Only one documentation provider may be contributed per metamodel. For example, a documentation provider is contributed by UML 2.1 metamodel to show the body of the first Comment attached to a model element.

id - a unique name that will be used to identify this provider
metamodel - the id of the metamodel this provider applies to (e.g. "uml21").
class - a class that implements DocumentationProvider

Following is an example of a Label Decorator extension enabled for all metamodels:

<extension
    point=
"com.sodius.mdw.platform.model.viewerParticipant"
>
  <labelDecorator
    class=
"com.sodius.mdw.ext.platform.model.adapter.SuffixTypeDecorator"

    description=
"Suffix instances with their type name.\ne.g. MyClass (Class)"

    enabled=
"true"


    id=
"com.sodius.mdw.platform.model.SuffixTypeDecorator"

    keywords=
"instance"

    name=
"Suffix instances with type name"
/>
</extension>

Following is an example of a Documentation Provider extension for the UML 2.1 metamodel:

<extension
    point=
"com.sodius.mdw.platform.model.viewerParticipant"
>
  <documentationProvider
    class=
"com.sodius.mdw.metamodel.uml21.ide.UMLDocumentationProvider"

    id=
"com.sodius.mdw.metamodel.uml21.documentationProvider"

     metamodel=
"uml21"
/>

</extension>

SODIUS

Model Viewer Participant

Identifier:

Since:

Description:

Configuration Markup:

Examples: