Class ecm.widget.ChildComponentPropertiesPane
Extends
dijit._Widget.
Provides a widget that is used to view and edit the attributes of a child component of an IBM Content
Manager item type.
A child item type can have unique attributes. For example, IBM Content Collector uses child components to store email instance information and references to attributes of the distinct email item type.
Defined in: <ecm\widget\ChildComponentPropertiesPane.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Instance of ecm.model.ChildComponentDefinition.
|
|
Instance of ecm.model.ChildComponent.
|
|
Boolean indicating the child component has been changed when in multi edit mode.
|
|
Boolean indicating used in multi-item edit.
|
|
Boolean indicating read only.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
Clear()
|
|
destroy()
Destroys the widget.
|
|
Returns the first invalid field.
|
|
Returns an array containing objects with index and values.
|
|
onAppendClicked(childComponentId, checked)
Fired when the Append checkbox is clicked
|
|
onChange()
This event is fired when the field is changed.
|
|
onClear(childComponentId)
Fired when the Clear button is clicked
|
|
This event is fired when the user clicks on the reference attribute.
|
|
This event method is called after the child component has finished rendering.
|
|
onMultiEditChildComponentChange(childComponentId)
Fired in multi object editing when child component changed.
|
|
onNew(childComponentId)
Fired when the New button is clicked
|
|
Renders the data.
|
|
resize()
Resizes the widget.
|
|
setChildCompDefinition(childComponentDefinition)
Sets child component definition, the title on the title pane, and the hover help.
|
|
setFieldError(fieldName, errorMessage, invalidItems)
Indicates that the field is in error.
|
|
setFieldFocus(field)
Places focus in the provided property field widget.
|
|
validate(onEditStatus, onSaveStatus)
Validates the data.
|
|
Validates the changed field.
|
|
validateField(field)
|
|
Validates the required property fields.
|
Field Detail
childComponentDefinition
Instance of ecm.model.ChildComponentDefinition.
childComponentItem
Instance of ecm.model.ChildComponent.
multiEditChanged
Boolean indicating the child component has been changed when in multi edit mode.
multiSelectEdit
Boolean indicating used in multi-item edit.
readOnly
Boolean indicating read only.
Method Detail
Clear()
destroy()
Destroys the widget.
getFirstInvalidField()
Returns the first invalid field.
- Returns:
- The first field widget that contains an invalid value. If all values are valid,
null
is returned.
getValues()
Returns an array containing objects with index and values.
- Returns:
- An array of value objects with the following properties:
- name - The property Id string.
- value - The property value.
- dataType - A ecm.model.AttributeDefinition
dataType
value. - label - The property display name.
onAppendClicked(childComponentId, checked)
Fired when the Append checkbox is clicked
- Parameters:
- childComponentId
- checked
onChange()
This event is fired when the field is changed.
onClear(childComponentId)
Fired when the Clear button is clicked
- Parameters:
- childComponentId
onClickReferenceAttribute(evt)
This event is fired when the user clicks on the reference attribute.
- Parameters:
- evt
- The event.
onDataRendered()
This event method is called after the child component has finished rendering.
onMultiEditChildComponentChange(childComponentId)
Fired in multi object editing when child component changed.
- Parameters:
- childComponentId
- The String id of this child component.
onNew(childComponentId)
Fired when the New button is clicked
- Parameters:
- childComponentId
postCreate()
renderData()
Renders the data.
resize()
Resizes the widget.
setChildCompDefinition(childComponentDefinition)
Sets child component definition, the title on the title pane, and the hover help.
- Parameters:
- childComponentDefinition
- Instance of ecm.model.ChildComponentDefinition.
setFieldError(fieldName, errorMessage, invalidItems)
Indicates that the field is in error. This is used for custom validation.
- Parameters:
- fieldName
- A child component property Id string.
- errorMessage
- The error message string.
- invalidItems
- The invalid values.
setFieldFocus(field)
Places focus in the provided property field widget. This is typically used
to set the focus on a field that has an invalid value.
- Parameters:
- field
- A field widget.
validate(onEditStatus, onSaveStatus)
Validates the data.
- Parameters:
- onEditStatus
- onSaveStatus
- Returns:
- A field widget that contains an invalid value. If all fields contain valid values,
null
is returned.
validateChangedField()
Validates the changed field.
- Returns:
- If the modified value is invalid, the field widget is returned. If the modified value is valid
null
is returned.
validateField(field)
- Parameters:
- field
- Since:
- 2.0.3.8
- Returns:
- True if this field is valid, else if it is not valid false is returned.
validateRequiredFields()
Validates the required property fields.
- Since:
- 2.0.3
- Returns:
- Returns
null
if all required fields contain valid values. Otherwise, returns the first required field that contains an invalid value.