Rational Developer for System z

CARMA Custom Parameter Controls

Identifier:

com.ibm.carma.ui.customParameterControls

Since:

8.0

Description:

This extension point is used to register custom parameter controls. Custom parameter controls can be used to create custom user interface widgets for action parameters in the CARMA user interface.

Configuration Markup:

<!ELEMENT extension (customParameterControl*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT customParameterControl EMPTY>

<!ATTLIST customParameterControl

parameterId CDATA #IMPLIED

actionId    CDATA #IMPLIED

uniqueId    CDATA #REQUIRED

class       CDATA #REQUIRED>

Defines a custom parameter control. While more than one custom parameter control can be defined for a given parameter, the custom parameter registry will return only one custom parameter control when asked for one. Preference will be given to a registered custom control whose parameter ID matches the requested parameter ID exactly, rather than a custom control that is defined with a wildcard as a parameter ID. If more than one of these is registered, preference will be given to a registered custom control whose action ID matches the requested action ID exactly, rather than a custom control that is defined with a wildcard as an action ID. If more than one of these is registered, the registry's choice is undefined.



Examples:

Registering a custom parameter control:

<extension point="com.ibm.carma.ui.customParameterControls">
  <customParameterControl
    parameterId="042"
    actionId="021"
    uniqueId="MYRAM"
    class="com.example.MyCustomParameterControl"/>
</extension>

API Information:

The value of the class attribute must represent an implementor of com.ibm.carma.ui.action.custom.ICustomParameterControl.

Supplied Implementation:

Plug-ins may use this extension point to add custom parameter controls to the user interface of actions defined in a CARMA RAM.


Copyright IBM Corp. 2010 All Rights Reserved


Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)