Reference > IBM Sales Center extension points

controls

The com.ibm.commerce.telesales.widgets.controls extension point is used to declare controls for use in the IBM Sales Center user interface. Controls can be added to and removed from existing user interfaces or assembled together into a new user interface.

Identifier:

com.ibm.commerce.telesales.controls.controls

Description:

The com.ibm.commerce.telesales.widgets.controls extension point is used to declare controls for use in the IBM Sales Center user interface. Controls can be added to and removed from existing user interfaces or assembled together into a new user interface.

Configuration Markup:

<!ELEMENT extension ( control+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

• point - The fully qualified identifier of the target extension point.

• id - An optional identifier for the target extension point.

• name - An optional name for the extension instance.

<!ELEMENT control ( property*)>

<!ATTLIST control

id CDATA #REQUIRED

type CDATA #IMPLIED

required (true | false)

tooltip CDATA #IMPLIED

font CDATA #IMPLIED

enabled (true | false)

modelPath CDATA #IMPLIED

editable (true | false)

fieldId CDATA #IMPLIED

managerType CDATA #IMPLIED

text CDATA #IMPLIED

userData (true | false)

selection (true | false)

referenceId CDATA #IMPLIED

label CDATA #IMPLIED

multi (true | false)

single (true | false)

check (true | false)

tableDefinitionId CDATA #IMPLIED

compositeDefinitionId CDATA #IMPLIED

validatorType CDATA #IMPLIED

imagePath CDATA #IMPLIED

activityId CDATA #IMPLIED

selectedValue CDATA #IMPLIED

deselectedValue CDATA #IMPLIED

verifyListenerType CDATA #IMPLIED

defaultValue CDATA #IMPLIED

textLimit CDATA #IMPLIED

setFocus CDATA #IMPLIED

childControlId CDATA #IMPLIED

textAlignment (trail|lead)

background CDATA #IMPLIED

foreground CDATA #IMPLIED

formatterType CDATA #IMPLIED

border (true | false)

treePath CDATA #IMPLIED

saveOnModify (true | false) >

This element is used to describe configured controls.

• id - Unique identifier for this control declaration. Use this identifier to refer to this control. It may be necessary to fully qualify references to this identifier if the reference is made from a different namespace context.

• type - Control type. The type is used to identify the control factory that will be used to create the control. The following control types are available with the "com.ibm.commerce.telesales.widgets" plug-in:

  • readOnlyText - read only text control

  • text - text control

  • textarea - text area control

  • label - label control

  • cLabel - cLabel control

  • requiredLabel - label control with a required indicator

  • combo - combo box control

  • list - list box control

  • pushButton - a push button

  • checkBox - check box control

  • radioButton - radio button control

  • table - table control

  • tableTree - table tree control

  • tableList - table list control

  • composite - composite control

  • group - group composite control

  • separator - horizontal separator control

  • scrolledComposite - scrolled composite control

  • tabFolder - tab folder control

  • expandableComposite - expandable composite control

• required - Indicates that this control represents a required input field. The default value is false. This value can be used with any type of control but is expected to be used with controls that handle user input such as "combo" and "text".

• tooltip - The resource key for the tooltip text. This text is displayed when the mouse hovers over the control. The following control types respect this attribute:

  • checkBox

  • combo

  • list

  • pushButton

  • radioButton

  • text

• font - The font that is to be used with this control. This should be a value that can be passed to org.eclipse.jface.resource.JFaceResources.getFont(String symbolicName). If no font is specified, then the font of the parent composite is used. The following control types will respect this attribute:

  • checkBox

  • combo

  • composite

  • list

  • group

  • label

  • pushButton

  • radioButton

  • requiredLabel

  • scrolledComposite

  • readOnlyText

  • text

• enabled - Indicates that this control should be enabled. The default value is true. The following control types will respect this attribute:

  • checkBox

  • combo

  • list

  • pushButton

  • radioButton

  • text

• modelPath - Path to the model data represented by this control. The widget manager may use this information to determine the initial value of the control and as the model save location. The expected pattern is propertyNameA.propertyNameB.propertyNameC where propertyNameA is found in the widget manager's input properties, propertyNameB is a property on the model object found under propertyNameA and propertyNameC points to the value that is to be displayed in the control. The standard widget manager will respect this attribute for the following control types:

  • checkBox

  • combo

  • label

  • cLabel

  • readOnlyText

  • text

  • table

  • tableTree

• editable - Indicates that this control is an editable input field. The default value is true. The following control types will respect this attribute:

  • combo

  • text

• fieldId - The identifier of the input field control associated with this control declaration. For example, if this control declaration represents a label, then the fieldId attribute may be the ID of the entry field that this label is describing. If the control identified in fieldId is declared in the same namespace as this control declaration, then it does not need to be fully qualified. The following control types will respect this attribute:

  • requiredLabel

• managerType - The manager type indicates the type of the widget manager that is expected to manage this control. Widget managers that do not share this manager type should ignore this control. The default value is standard which indicates that the standard widget manager should manage this control. This attribute can be used with all of the control types.

• text - The resource key for the control text. This is normally the label text associated with the control. The following control types will respect this attribute:

  • checkBox

  • group

  • label

  • cLabel

  • pushButton

  • radioButton

  • requiredLabel

• userData - Indicates that this control represents a user data input field. When a the data is stored in the model, it will be marked as a user data property and sent as part of the UserData section of the request BOD. The default value is false. The standard widget manager will respect this attribute for the following control types:

  • text

  • combo

• selection - Indicates that this control should be selected. The default value is false. The following control types will respect this attribute:

  • checkBox

  • combo

  • radioButton

• referenceId - The identifier of a control declaration that this control declaration should be based on. All properties and attributes will be inherited from the reference declaration. Anything defined in this definition will override the value inherited from the reference definition. If the reference control has not been declared in the same namespace as this control declaration, then fully qualify the reference ID. This attribute can be used with any control type.

• label - The resource key for the control label. This is the label that is used to refer to the control when it is necessary to bring it to the attention of the user. This value can be used with any type of control but is expected to be used with controls that handle user input such as "combo" and "text".

• multi - Indicates that this control should allow multiple selection. The default is false. The following control types will respect this attribute:

  • list

  • table

• single - Indicates that this control should allow single selection. The default is false. The following control types will respect this attribute:

  • list

  • table

• check - Indicates that this control should indicate selection with a check. The default is false. The following control types will respect this attribute:

  • table

• tableDefinitionId - Table definition identifier. If the control is a table, then this attribute should contain an identifier of an extension to the com.ibm.commerce.telesales.widgets.tableDefinitions extension point. The following control types will respect this attribute:

  • table

  • tableTree

• compositeDefinitionId - Composite definition identifier. If the control is a composite, then this attribute should contain an identifier of an extension to the com.ibm.commerce.telesales.widgets.compositeDefinitions extension point. The following control types will respect this attribute:

  • composite

  • group

• validatorType - The validator type indicates the type of the validation that is expected to be performed for this control. The widget managers are responsible for interpreting this value and providing appropriate validation.

• imagePath - Indicates the image that has to be set for this control. This attribute is applicable for push buttons and labels.

• activityId - Indicates the control is only added if the given activity ID is enabled. This attribute is applicable for push button, combo, and check box types.

• selectedValue - Value stored in the model that indicates that this control should be selected. The standard widget manager will respect this attribute for the following control types:

  • checkBox

• deselectedValue - Value stored in the model that indicates that this control should be deselected. The standard widget manager will respect this attribute for the following control types:

  • checkBox

• verifyListenerType - The verify listener type indicates the type of the verify listener that is expected to be added to this control. The widget managers are responsible for interpreting this value and assigning an appropriate verify listener. The standard widget manager understands the following values:

  • integer

  • longInteger

• defaultValue - Default value. The following control types will respect this attribute:

  • readOnlyText

  • text

  • textarea

  • combo

  • list

• textLimit - Text limit value. The following control types will respect this attribute:

  • text

  • textarea

  • combo

• setFocus - Indicates that this specified control should be the one given focus. The default value is false. This value can be used with any type of control.

• childControlId - Child control identifier. If the control is a composite that requires a single child, then this attribute should contain an identifier of an extension to the com.ibm.commerce.telesales.widgets.controls extension point. The following control types will respect this attribute:

  • expandableComposite

  • scrolledComposite

• textAlignment - Text alignment value. The following control types will respect this attribute:

  • readOnlyText

  • text

  • label

  • cLabel

  Valid value for this attribute is lead or trail.

• background - Background color. This attribute can be specified as either an RGB color or as one of the predefined values. The color components of an RGB color must be specified as three comma separated integers between 0 and 255. For example "192,192,192"

  The following predefined values may be specified for the background attribute:

  • white

  • black

  • red

  • darkRed

  • green

  • darkGreen

  • yellow

  • darkYellow

  • blue

  • darkBlue

  • magenta

  • darkMagenta

  • cyan

  • darkCyan

  • gray

  • darkGray

  • widgetDarkShadow

  • widgeNormalShadow

  • widgetLightShadow

  • widgetHighlightShadow

  • widgetForeground

  • widgetBackground

  • widgetBorder

  • listForeground

  • listBackground

  • listSelection

  • listSelectionText

  • infoForeground

  • infoBackground

  • titleForeground

  • titleBackground

  • titleBackgroundGradient

  • titleInactiveForeground

  • titleInactiveBackground

  • titleInactiveBackgroundGradient

• foreground - Foreground color. This attribute can be specified as either an RGB color or as one of the predefined values. The color components of an RGB color must be specified as three comma separated integers between 0 and 255. For example "192,192,192"

  The following predefined values may be specified for the foreground attribute:

  • white

  • black

  • red

  • darkRed

  • green

  • darkGreen

  • yellow

  • darkYellow

  • blue

  • darkBlue

  • magenta

  • darkMagenta

  • cyan

  • darkCyan

  • gray

  • darkGray

  • widgetDarkShadow

  • widgeNormalShadow

  • widgetLightShadow

  • widgetHighlightShadow

  • widgetForeground

  • widgetBackground

  • widgetBorder

  • listForeground

  • listBackground

  • listSelection

  • listSelectionText

  • infoForeground

  • infoBackground

  • titleForeground

  • titleBackground

  • titleBackgroundGradient

  • titleInactiveForeground

  • titleInactiveBackground

  • titleInactiveBackgroundGradient

• formatterType - Formatter type to be used. The following pre-defined values are supported :

  • longDateTimeFormat

  • shortDateTimeFormat

  • shortDateFormat

  The following control types will respect this attribute:

  • readOnlyText

  • text

  • textarea

  • label

  • cLabel

• border - Indicates that this control should be drawn with a border. The default value is false. This attribute is respected by the "label" control type.

• treePath - Tree path for this control. The content provider for the control may use this information to determine tree elements. The expected pattern is propertyNameA.propertyNameB.propertyNameC where propertyNameA is the name of a ModelObjectList property found in the model objects in the list of top level tree elements, propertyNameB is the name a ModelObjectList property found in the elements in the propertyNameA list. The following control types will respect this attribute:

  • tableTree

• saveOnModify - Indicates that modifications to this control should be saved immediately. The default value is false. The standard widget manager will respect this attribute for the following control types:

  • text

  • combo

<!ELEMENT property ( value* | property*)>

<!ATTLIST property

name CDATA #REQUIRED

value CDATA #IMPLIED>

This element is used to describe a control property. The property will be available to the control factory when the control is created and to the widget manager when the control is being managed. This attribute can be used to indicate to the "combo" control factory the list of combo values by specifying the list with a property name "list".

• name - The name of the control property. Choose names that don't conflict with attribute names on the control element.

• value - The property value. Use this attribute if the property has a single value.

<!ELEMENT value (#PCDATA)>

Value element. Use this element to provide a property value. This element can be used if the property represents a list.

Examples:

<extension point=
 "com.ibm.commerce.telesales.widgets.controls"
 >    

<control
      id=
 "customerOrganizationGroupLabel"
 
      type=
 "label"
 
      text=
 "CustomerIdentityPage.customerOrganizationGroup"
 
      font=
 "org.eclipse.jface.bannerfont"
 /> 
<control
      id="customerOrganizationGroupLabel"
      type="cLabel"
      text="CustomerIdentityPage.customerOrganizationGroup"
      font="org.eclipse.jface.bannerfont"/>    

<control
      id=
 "customerOrganizationNameLabel"
 
      type=
 "requiredLabel"
 
      text=
 "CustomerIdentityPage.customerOrganizationName"
 
      fieldId=
 "customerOrganizationNameField"
 />    

<control
      id=
 "customerOrganizationNameField"
 
      type=
 "text"
 
      tooltip=
 "CustomerIdentityPage.customerOrganizationNameTooltip"
 
      label=
 "CustomerIdentityPage.customerOrganizationName"
 
      modelPath=
 "organization.organizationName"
 
      managerType=
 "customerEditor"
 
      required=
 "true"
 
      editable=
 "false"
 /> 
</extension>

API Information:

Configured controls can be created using the control factory. Refer to com.ibm.commerce.telesales.widgets.controls.ControlFactory

for more information.

Supplied Implementation:

Many of the editors, dialogs, and views provided with the IBM Sales Center editor have declared their user interface controls using the controls extension point.

Related concepts

Control factories

Related tasks

Add a dialog

Modify a dialog

Modify a page in an editor

Move a user interface element between dialogs or editor pages

+

Search Tips   |   Advanced Search