compositeDefinitions

The com.ibm.commerce.telesales.widgets.compositeDefinitions extension point is used to declare configured composite definitions for use in the IBM Sales Center user interface.

Identifier:

com.ibm.commerce.telesales.widgets.compositeDefinitions

Description:

The com.ibm.commerce.telesales.widgets.compositeDefinitions extension point is used to declare configured composite definitions for use in the IBM Sales Center user interface.

Configuration Markup:

<!ELEMENT extension ( gridCompositeDefinition | formCompositeDefinition | stackCompositeDefinition | rowCompositeDefinition)>

<!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 gridCompositeDefinition ( row | repeatableFragment)*>

<!ATTLIST gridCompositeDefinition

id CDATA #REQUIRED

layoutId CDATA #IMPLIED

referenceId CDATA #IMPLIED>

This element is used to describe configured composites with a grid layout.

  • id - Unique identifier for this composite declaration. Use this identifier to refer to this composite. It may be necessary to fully qualify references to this identifier if the reference is made from a different namespace context.
  • layoutId - The identifier of the grid layout declaration associated with this grid composite declaration. This layout identifier must match the id attribute of a gridLayout element defined as an extension to the com.ibm.commerce.telesales.widgets.gridLayouts extension point.
  • referenceId - The identifier of a grid composite definition declaration that this grid composite definition 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. All of the rows found in the reference declaration will appear before any rows defined in this declaration. If the reference composite definition has not been declared in the same namespace as this composite definition declaration, then you must fully qualify the reference ID.

<!ELEMENT formCompositeDefinition ( control*)>

<!ATTLIST formCompositeDefinition

id CDATA #REQUIRED

layoutId CDATA #IMPLIED

referenceId CDATA #IMPLIED>

This element is used to describe configured composites with a form layout.

  • id - Unique identifier for this composite declaration. Use this identifier to refer to this composite. It may be necessary to fully qualify references to this identifier if the reference is made from a different namespace context.
  • layoutId - The identifier of the form layout declaration associated with this form composite declaration. This layout identifier must match the id attribute of a formLayout element defined as an extension to the com.ibm.commerce.widgets.formLayouts extension point.
  • referenceId - The identifier of a form composite definition declaration that this form composite definition 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. All of the controls found in the reference declaration will appear in this form composite. If the reference composite definition has not been declared in the same namespace as this composite definition declaration, then you must fully qualify the reference ID.

<!ELEMENT row ( control | repeatableFragment)*>

<!ATTLIST row

id CDATA #IMPLIED

referenceId CDATA #IMPLIED>

This element is used to describe grid composite rows.

  • id - Unique identifier for this grid composite row declaration. Use this identifier to refer to this row. It may be necessary to fully qualify references to this identifier if the reference is made from a different namespace context.
  • referenceId - The identifier of a grid composite row declaration that this row declaration should be based on. You should not define any attributes or child elements for a row element that defines a reference identifier.

<!ELEMENT control ( leftAttachment? , rightAttachment? , topAttachment? , bottomAttachment?)>

<!ATTLIST control

controlId CDATA #REQUIRED

dataId CDATA #IMPLIED

height CDATA #IMPLIED

width CDATA #IMPLIED

horizontalSpan CDATA #IMPLIED

topControl (true | false) >

This element is used to describe composite child controls.

  • controlId - The identifier of the control declaration that will be used to create the child control. This identifier must match the id attribute of a control element defined as an extension to the com.ibm.commerce.widgets.controls extension point.
  • dataId - The identifier of the grid data declaration associated with this control declaration. This identifier must match the id attribute of a gridData element defined as an extension to the com.ibm.commerce.widgets.gridDatas extension point. This attribute should only be specified if this control is part of a grid composite definition.
  • height - The height in pixels. This attribute should only be specified if this control is part of a form composite definition.
  • width - The width in pixels. This attribute should only be specified if this control is part of a form composite definition.
  • horizontalSpan - The number of column cells that the control will take up. This value will override the horizontal span that is defined in the associated grid data declaration. This attribute should only be specified if this control is part of a grid composite definition.
  • topControl - Top control attribute. The default value is false. Set this value to true to indicate that this control should appear on the top of the stack composite. This attribute should only be specified if this control is part of a stack composite definition.

<!ELEMENT leftAttachment EMPTY>

<!ATTLIST leftAttachment

offset CDATA "0"

numerator CDATA "0"

denominator CDATA "100"

alignment (DEFAULT|CENTER|LEFT|RIGHT|TOP|BOTTOM) "DEFAULT"

relativeControlId CDATA #IMPLIED>

This element is used to describe the form attachment on the left side of the control. This element should only be specified if the control is part of a form composite.

  • offset - The offset, in pixels, of the control side from the attachment position. If the offset is positive, then the control side is offset to the right of or below the attachment position. If it is negative, then the control side is offset to the left of or above the attachment position. This is equivalent to the "b" term in the equation y = ax + b. The default value is 0.
  • numerator - The numerator of the "a" term in the equation, y = ax + b, which defines the attachment.
  • denominator - The denominator of the "a" term in the equation, y = ax + b, which defines the attachment. The default value is 100.
  • alignment - The alignment of the control side that is attached to a control. For top and bottom attachments, TOP, BOTTOM and CENTER are used. For left and right attachments, LEFT, RIGHT and CENTER are used. If any other case occurs, the default will be used instead. Possible values are: TOP: Attach the side to the top side of the specified control. BOTTOM : Attach the side to the bottom side of the specified control. LEFT: Attach the side to the left side of the specified control. RIGHT: Attach the side to the right side of the specified control. CENTER: Attach the side at a position which will center the control on the specified control. DEFAULT: Attach the side to the adjacent side of the specified control.
  • relativeControlId - The identifier of the control to which the control side is attached. This identifier must match the controlId of another control defined in this form composite declaration.

<!ELEMENT rightAttachment EMPTY>

<!ATTLIST rightAttachment

offset CDATA "0"

numerator CDATA "0"

denominator CDATA "100"

alignment (DEFAULT|CENTER|LEFT|RIGHT|TOP|BOTTOM) "DEFAULT"

relativeControlId CDATA #IMPLIED>

This element is used to describe the form attachment on the right side of the control. This element should only be specified if the control is part of a form composite.

  • offset - The offset, in pixels, of the control side from the attachment position. If the offset is positive, then the control side is offset to the right of or below the attachment position. If it is negative, then the control side is offset to the left of or above the attachment position. This is equivalent to the "b" term in the equation y = ax + b. The default value is 0.
  • numerator - The numerator of the "a" term in the equation, y = ax + b, which defines the attachment.
  • denominator - The denominator of the "a" term in the equation, y = ax + b, which defines the attachment. The default value is 100.
  • alignment - The alignment of the control side that is attached to a control. For top and bottom attachments, TOP, BOTTOM and CENTER are used. For left and right attachments, LEFT, RIGHT and CENTER are used. If any other case occurs, the default will be used instead. Possible values are: TOP: Attach the side to the top side of the specified control. BOTTOM : Attach the side to the bottom side of the specified control. LEFT: Attach the side to the left side of the specified control. RIGHT: Attach the side to the right side of the specified control. CENTER: Attach the side at a position which will center the control on the specified control. DEFAULT: Attach the side to the adjacent side of the specified control.
  • relativeControlId - The identifier of the control to which the control side is attached. This identifier must match the controlId of another control defined in this form composite declaration.

<!ELEMENT topAttachment EMPTY>

<!ATTLIST topAttachment

offset CDATA "0"

numerator CDATA "0"

denominator CDATA "100"

alignment (DEFAULT|CENTER|LEFT|RIGHT|TOP|BOTTOM) "DEFAULT"

relativeControlId CDATA #IMPLIED>

This element is used to describe the form attachment on the top of the control. This element should only be specified if the control is part of a form composite.

  • offset - The offset, in pixels, of the control side from the attachment position. If the offset is positive, then the control side is offset to the right of or below the attachment position. If it is negative, then the control side is offset to the left of or above the attachment position. This is equivalent to the "b" term in the equation y = ax + b. The default value is 0.
  • numerator - The numerator of the "a" term in the equation, y = ax + b, which defines the attachment.
  • denominator - The denominator of the "a" term in the equation, y = ax + b, which defines the attachment. The default value is 100.
  • alignment - The alignment of the control side that is attached to a control. For top and bottom attachments, TOP, BOTTOM and CENTER are used. For left and right attachments, LEFT, RIGHT and CENTER are used. If any other case occurs, the default will be used instead. Possible values are: TOP: Attach the side to the top side of the specified control. BOTTOM : Attach the side to the bottom side of the specified control. LEFT: Attach the side to the left side of the specified control. RIGHT: Attach the side to the right side of the specified control. CENTER: Attach the side at a position which will center the control on the specified control. DEFAULT: Attach the side to the adjacent side of the specified control.
  • relativeControlId - The identifier of the control to which the control side is attached. This identifier must match the controlId of another control defined in this form composite declaration.

<!ELEMENT bottomAttachment EMPTY>

<!ATTLIST bottomAttachment

offset CDATA "0"

numerator CDATA "0"

denominator CDATA "100"

alignment (DEFAULT|CENTER|LEFT|RIGHT|TOP|BOTTOM) "DEFAULT"

relativeControlId CDATA #IMPLIED>

This element is used to describe the form attachment on the bottom of the control. This element should only be specified if the control is part of a form composite.

  • offset - The offset, in pixels, of the control side from the attachment position. If the offset is positive, then the control side is offset to the right of or below the attachment position. If it is negative, then the control side is offset to the left of or above the attachment position. This is equivalent to the "b" term in the equation y = ax + b. The default value is 0.
  • numerator - The numerator of the "a" term in the equation, y = ax + b, which defines the attachment.
  • denominator - The denominator of the "a" term in the equation, y = ax + b, which defines the attachment. The default value is 100.
  • alignment - The alignment of the control side that is attached to a control. For top and bottom attachments, TOP, BOTTOM and CENTER are used. For left and right attachments, LEFT, RIGHT and CENTER are used. If any other case occurs, the default will be used instead. Possible values are: TOP: Attach the side to the top side of the specified control. BOTTOM : Attach the side to the bottom side of the specified control. LEFT: Attach the side to the left side of the specified control. RIGHT: Attach the side to the right side of the specified control. CENTER: Attach the side at a position which will center the control on the specified control. DEFAULT: Attach the side to the adjacent side of the specified control.
  • relativeControlId - The identifier of the control to which the control side is attached. This identifier must match the controlId of another control defined in this form composite declaration.

<!ELEMENT stackCompositeDefinition ( control*)>

<!ATTLIST stackCompositeDefinition

id CDATA #REQUIRED

layoutId CDATA #IMPLIED

referenceId CDATA #IMPLIED>

  • id - Unique identifier for this composite declaration. Use this identifier to refer to this composite. It may be necessary to fully qualify references to this identifier if the reference is made from a different namespace context.
  • layoutId - The identifier of the stack layout declaration associated with this stack composite declaration. This layout identifier must match the id attribute of a stackLayout element defined as an extension to the com.ibm.commerce.widgets.stackLayouts extension point.
  • referenceId - The identifier of a stack composite definition declaration that this stack composite definition 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. All of the controls found in the reference declaration will appear in this stack composite. If the reference composite definition has not been declared in the same namespace as this composite definition declaration, then you must fully qualify the reference ID.

<!ELEMENT rowCompositeDefinition ( control*)>

<!ATTLIST rowCompositeDefinition

id CDATA #REQUIRED

layoutId CDATA #IMPLIED

referenceId CDATA #IMPLIED>

This element is used to describe configured composites with a row layout.

  • id - Unique identifier for this composite declaration. Use this identifier to refer to this composite. It may be necessary to fully qualify references to this identifier if the reference is made from a different namespace context.
  • layoutId - The identifier of the form layout declaration associated with this row composite declaration. This layout identifier must match the id attribute of a rowLayout element defined as an extension to the com.ibm.commerce.widgets.rowLayouts extension point.
  • referenceId - The identifier of a row composite definition declaration that this form composite definition 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. All of the controls found in the reference declaration will appear in this row composite. If the reference composite definition has not been declared in the same namespace as this composite definition declaration, then you must fully qualify the reference ID.

<!ELEMENT repeatableFragment ( row | control | repeatableFragment)*>

<!ATTLIST repeatableFragment

type CDATA #IMPLIED

managerClass CDATA #REQUIRED>

This element is used to describe a repeatable grid composite fragment. If a repeatable fragment is the child of a grid composite definition, then its children can only be rows or repeatable fragments. If a repeatable fragment is the child of a row, then its children can only be controls or repeatable fragments.

  • type - The type of repeatable frament. This value can be used by the repeatable fragment manager to identify the repeatable fragment.
  • managerClass - Repeatable fragment manager class. This class must implement com.ibm.commerce.telesales.widgets.composites.IFragmentManager. It is used to determine the number of times the fragment is to be repeated.

Examples:


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

      
 <gridCompositeDefinition
         id=
 "customerNameComposite.default"
 
         layoutId=
 "standardGridLayout"
 >
         
 <row id=
 "customerNameGroupLabelRow"
 >
            
 <control controlId=
 "customerNameGroupLabel"
  dataId=
 "headerLabelGridData"
 />
         
 </row>
         
 <row id=
 "customerUserNameRow"
 >
            
 <control controlId=
 "customerUserNameLabel"
  dataId=
 "requiredLabelGridData"
 />
            
 <control controlId=
 "customerUserNameField"
  dataId=
 "requiredFieldGridData"
 />
         
 </row>
         
 <row id=
 "customerTitleRow"
 >
            
 <control controlId=
 "customerTitleLabel"
  dataId=
 "requiredLabelGridData"
 />
            
 <control controlId=
 "customerTitleField"
  dataId=
 "requiredFieldGridData"
 />
         
 </row>
         
 <row id=
 "customerFirstNameRow"
 >
            
 <control controlId=
 "customerFirstNameLabel"
  dataId=
 "requiredLabelGridData"
 />
            
 <control controlId=
 "customerFirstNameField"
  dataId=
 "requiredFieldGridData"
 />
         
 </row>
         
 <row id=
 "customerMiddleNameRow"
 >
            
 <control controlId=
 "customerMiddleNameLabel"
  dataId=
 "requiredLabelGridData"
 />
            
 <control controlId=
 "customerMiddleNameField"
  dataId=
 "requiredFieldGridData"
 />
         
 </row>
         
 <row id=
 "customerLastNameRow"
 >
            
 <control controlId=
 "customerLastNameLabel"
  dataId=
 "requiredLabelGridData"
 />
            
 <control controlId=
 "customerLastNameField"
  dataId=
 "requiredFieldGridData"
 />
         
 </row>
      
 </gridCompositeDefinition>

      
 <gridCompositeDefinition
         id=
 "customerNameComposite.zh_CN"
 
         layoutId=
 "standardGridLayout"
 >
         
 <row referenceId=
 "customerNameGroupLabelRow"
 />
         
 <row referenceId=
 "customerUserNameRow"
 />
         
 <row referenceId=
 "customerLastNameRow"
 />
         
 <row referenceId=
 "customerMiddleNameRow"
 />
         
 <row referenceId=
 "customerFirstNameRow"
 />
         
 <row referenceId=
 "customerTitleRow"
 />
      
 </gridCompositeDefinition>

      
 <gridCompositeDefinition
         id=
 "customerNameComposite.ja_JP"
 
         layoutId=
 "standardGridLayout"
 >
         
 <row referenceId=
 "customerNameGroupLabelRow"
 />
         
 <row referenceId=
 "customerUserNameRow"
 />
         
 <row referenceId=
 "customerLastNameRow"
 />
         
 <row referenceId=
 "customerMiddleNameRow"
 />
         
 <row referenceId=
 "customerFirstNameRow"
 />
         
 <row referenceId=
 "customerTitleRow"
 />
      
 </gridCompositeDefinition>

      
 <formCompositeDefinition
         id=
 "customerIdentityComposite.default"
 
         layoutId=
 "standardFormLayout"
 >
         
 <control controlId=
 "customerNameComposite"
 >
            
 <leftAttachment
               offset=
 "0"
 
               numerator=
 "0"
 />
            
 <rightAttachment
               offset=
 "-15"
 
               numerator=
 "50"
 />
         
 </control>
         
 <control controlId=
 "customerEmploymentComposite"
 >
            
 <topAttachment
               offset=
 "15"
 
               relativeControlId=
 "customerNameComposite"
 />
            
 <leftAttachment
               numerator=
 "0"
 
               offset=
 "0"
 />
            
 <rightAttachment
               numerator=
 "50"
 
               offset=
 "-15"
 />
         
 </control>
         
 <control controlId=
 "customerAddressComposite"
 >
            
 <leftAttachment
               offset=
 "15"
 
               relativeControlId=
 "customerNameComposite"
 />
            
 <rightAttachment
               numerator=
 "100"
 
               offset=
 "-15"
 />
         
 </control>
      
 </formCompositeDefinition>

   
 </extension>

API Information:

Composite definitions can be created using the composite definition factory. Refer to

com.ibm.commerce.telesales.widgets.composites.CompositeDefinitionFactory

for more information. Normally a composite definition is not constructed directly but is referenced by the

compositeDefinitionId

attribute of a composite control declaration. Refer to the

com.ibm.commerce.telesales.widgets.controls

extension point for more information.

Supplied Implementation:

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