Editing Capabilities

Identifier:

com.ibm.xtools.common.ui.reduction.editingCapabilities

Since:

This extension point is new to Version 7.0.5.

Description:

This extension point allows contributing eclipse activities / capabilities to participate in UI reduction. These capabilities will be dynamically enabled / disabled depending on the workbench selection. If the workbench selection is, or can be adapted to, a modeling element, then the participating capabilities may be enabled / disabled if the modeling element contains reduction data in the form of editing capabilities.

Viewpoints are used as a means to further reduce the UI. By default the MODEL viewpoint is enabled, which means that the editing capabilities determined from the modeling element in context should be enabled. If a custom viewpoint is enabled, then the intersection between the viewpoint capabilities and the modeling element context editing capabilities is computed and the resulting set is enabled.

A viewpoint may only contain capabilities which have been registered to participate in UI reduction.

Configuration Markup:

<!ELEMENT extension (activity* , viewpoint* , viewpointCategory* , viewpointCategoryBinding* , viewpointListener* , viewpointElement* , viewpointType* , viewpointActivityBinding* , viewpointElementDataBinding*)+>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

point - The identifier of the extension point.
id - The identifier of the extension.
name - The name of the extension.

<!ELEMENT activity EMPTY>

<!ATTLIST activity

ref CDATA #REQUIRED

match (equals|pattern) "equals">

A reference to eclipse activities which participate in UI reduction.

ref - The activity reference.
match - Defines whether the ref attribute is to be an exact match or a regex pattern.

<!ELEMENT viewpoint (activity*)+>

<!ATTLIST viewpoint

id CDATA #REQUIRED

name CDATA #REQUIRED>

Defines a new viewpoint.

id - The viewpoint identifier.
name - The viewpoint name.

<!ELEMENT viewpointCategory EMPTY>

<!ATTLIST viewpointCategory

id CDATA #REQUIRED

label CDATA #REQUIRED>

Categories are strictly a UI feature used to categorize viewpoints.

id - The category identifier.
label - The category label to surface in the UI.

<!ELEMENT viewpointCategoryBinding EMPTY>

<!ATTLIST viewpointCategoryBinding

categoryRef CDATA #REQUIRED

viewpointRef CDATA #REQUIRED>

Binds a viewpoint to a category.

categoryRef - The category reference to bind a viewpoint to.
viewpointRef - The viewpoint reference to bind in a category.

<!ELEMENT viewpointElement (data*)>

<!ATTLIST viewpointElement

type CDATA #REQUIRED

viewpoint_id CDATA #REQUIRED>

Defines a new predefined viewpoint element for the specified type and viewpoint.

type - The viewpoint type to bind with.
viewpoint_id - The viewpoint id to bind with.

<!ELEMENT viewpointListener EMPTY>

<!ATTLIST viewpointListener

class CDATA #REQUIRED>

Defines a new viewpoint listener which will be registered to listen to the viewpoint manager.

class - Specifies a concrete implementation of IViewpointListener.

<!ELEMENT data (#PCDATA)>

Specifies the data structure which will be read by the viewpoint type handler. This data can be plain text, XML, or any other data structure required by the handler.

<!ELEMENT viewpointType EMPTY>

<!ATTLIST viewpointType

configuration_page CDATA #IMPLIED

type CDATA #REQUIRED

handler CDATA #REQUIRED>

Defines a new viewpoint type.

configuration_page - Specifies a concrete implementation of IViewpointElementContent.
type - The unique viewpoint type identifier.
handler - Specifies a concrete implementation of IViewpointElementDataHandler.

<!ELEMENT viewpointActivityBinding (activity)*>

<!ATTLIST viewpointActivityBinding

viewpointRef CDATA #REQUIRED>

Bind existing activities to a viewpoint

viewpointRef - The viewpoint reference to bind with.

<!ELEMENT viewpointElementDataBinding (data*)>

<!ATTLIST viewpointElementDataBinding

viewpoint_id CDATA #REQUIRED

type CDATA #REQUIRED>

Bind data to existing viewpoint element.

viewpoint_id - The viewpoint id to bind with.
type - The viewpoint type to bind with.

Examples:


   <extension
         point="com.ibm.xtools.common.ui.reduction.editingCapabilities">
      <activity
            ref="com.ibm.xtools.example.activity1"
            match="equals"/>
      <activity
            ref="com\.ibm\.xtools\.examples\.services\..*"
            match="pattern"/>
      <viewpoint
            name="Viewpoint 1"
            id="com.ibm.xtools.common.ui.reduction.tests.viewpoint1">
         <activity
               ref="com.ibm.xtools.example.activity1"
               match="equals"/>
      </viewpoint>
      <viewpointCategory
            id="com.ibm.xtools.common.ui.reduction.tests.viewpointCategory1"
            label="Viewpoint Category 1"/>
      <viewpointCategoryBinding
            categoryRef="com.ibm.xtools.common.ui.reduction.tests.viewpointCategory1"
            viewpointRef="com.ibm.xtools.common.ui.reduction.tests.viewpoint1"/>
   </extension>

API Information:

Viewpoints are managed through the com.ibm.xtools.common.ui.reduction.viewpoints.IViewpointManager.

Supplied Implementation:

None.