Class ecm.widget.CommonPropertiesPane

Extends dijit._Widget, ecm.widget._PropertiesPaneMixin.
Provides a widget that is used to view and edit properties. This widget can be used in dialog boxes for adding documents, creating folders, and editing properties.
Defined in: <ecm\widget\CommonPropertiesPane.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.CommonPropertiesPane()

Field Summary

Field Attributes	Field Name and Description
	dependentPropertyObject An object used to retrieve dependent properties.
	fieldschanged A boolean value.

Method Summary

Method Attributes	Method Name and Description
	ClearChildComponent(childComponentId) Clears child component values
	clearRendering() Clears the current property rendering.
	createControl(kwArgs, attributeDefinition, callback) Creates the appropriate control based on the provided arguments.
	destroy()
	destroyTooltipWidgets()
	getChildComponentValues() Retrieves the array of child component values.
	getControlValueWidthClass(kwArgs) Set the value control column width, can be overridden.
	getFields() Retrieves the properties pane property fields.
	getFieldWithEitherName(fieldNames) Retrieves the field widget for the property identified by one of the property Id strings in `fieldNames`.
	getFieldWithName(fieldName) Retrieves the field widget for the property named `fieldName`.
	getFirstInvalidField() Retrieves the first property field widget that has an invalid value.
	getFirstTextPropertyName() Retrieves the property Id string for the first property field that contains text values.
	getFocusedFieldName() Returns the name of the field that has focus.
	getPropertiesJSON(includeReadonly, includeHidden, excludeEmptyValues) Retrieves the property values JSON string.
	getPropertyDisplayValue(fieldName) Retrieves the display value from the property field identified by `fieldName`.
	getPropertyEditors() Retrieves the properties pane property editors.
	getPropertyValue(fieldName) Retrieves the value for the property field identified by `fieldName`.
	isAttributeShown(attributeDefinition, item) Determines whether the attribute will be shown.
	isFieldDisplayed(fieldName) Returns whether the field widget for the property named `fieldName` is displayed (not hidden).
	onAppendChildComponentClicked(childComponentId, checked) Fired when the append childcomponet checkbox is clicked in multi edit mode.
	onAppendClick(attributeDefId, checked) Fired when the user clicks the Append checkbox for a multi value property in multi edit mode.
	onAttributesRendering(attributeDefinitions) This event method is called before the attributes are rendered.
	onChange() This event method is called after a change in the property pane.
	onChildComponentCleared(childComponentId) Fired when the a child component is cleared in multi edit mode.
	onClearedRendering() This event method is called after a properties rendering has been cleared.
	onClearProperty(kwArgs, clearNode) Called when a property is cleared in multi edit mode.
	onClickReferenceAttribute(evt) This event method is called after the user clicks on a reference attribute.
	onCompleteRendering() This event method is called after the properties have been rendered.
	onMarkingPropertyChange() This event method is called after a marking property value is changed.
	onMultiEditChildComponentChange(childComponentId)
	onNewChildComponent(childComponentId) Fired when the a new child component is added in multi edit mode.
	onPropertyChanged(evt) This event method is called after a property value is changed.
	onPropertyRendered(row, field) This event method is called after a property has been rendered.
	onPropertyValueSet(kwArgs) Called when a property value is changed to a non empty value.
	onRetrySave() When a property change is applied to a field with dependent properties by the user attempting to save the changes, the save is interrupted by returning the field as being invalid until the EDS call completes.
	postCreate()
	renderAttributes(attributeDefinitions, item, reason, isReadOnly, params) Renders the attributes.
	renderChildComponents(childCompDefinitions, item, isReadOnly, newChildComponents, reason) Renders the child components.
	renderTemplateMetadata(item) Renders template metadata
	resize(changeSize) Handles resizing the common properties pane.
	setDisabledNavigation(disableField) Enables or disables each data type `"xs:reference"` property field if it is not read only.
	setFieldError(fieldName, errorMessage, errorValue) Assigns an error to a property field.
	setFieldFocus(fieldName) Places focus in the property field identified by `fieldName`, if found.
	setPropertyDisplayedValue(fieldName, displayValue) Sets the displayed value for the property field identified by `fieldName`.
	setPropertyValue(fieldName, value) Sets the value for the property field identified by `fieldName`.
	validate() Validates all of the property fields.
	validateAll(onEditStatus, onSaveStatus, focus) Checks if the property fields contain valid values.
	validateChangedField() Validates the changed property fields.
	validateRequiredFields() Validates the required property fields.

Constructor Detail

ecm.widget.CommonPropertiesPane()

Field Detail

dependentPropertyObject

An object used to retrieve dependent properties. Used in multi item editing.

fieldschanged

A boolean value. It is true if the value of one or more property fields has changed.

Method Detail

ClearChildComponent(childComponentId)

Clears child component values

Parameters:
childComponentId

clearRendering()

Clears the current property rendering.

createControl(kwArgs, attributeDefinition, callback)

Creates the appropriate control based on the provided arguments. This is done so that subclasses can override and provide a different implementation if needed.

Parameters:
kwArgs
attributeDefinition
callback

destroy()

destroyTooltipWidgets()

getChildComponentValues()

Retrieves the array of child component values.

Returns:: An array of child component values. Each entry contains the set of values for the corresponding child component, in order.

getControlValueWidthClass(kwArgs)

Set the value control column width, can be overridden. Default is 300px (for most controls).

Parameters:
kwArgs

getFields()

Retrieves the properties pane property fields.

Returns:: An array of field widgets.

getFieldWithEitherName(fieldNames)

Retrieves the field widget for the property identified by one of the property Id strings in fieldNames. Each property Id string in the array is checked against the property fields, starting with the first property Id string, until a matching property field is found.

Parameters:
fieldNames: An array of property Id strings.

Returns:: The first matching field widget is returned. The value null is returned if no matching property field is found for any of the string Ids.

getFieldWithName(fieldName)

Retrieves the field widget for the property named fieldName.

Parameters:
fieldName: The string Id of the property.

Returns:: The field widget for the property. The value null is returned if the property field is not found.

getFirstInvalidField()

Retrieves the first property field widget that has an invalid value.

Returns:: A property field widget.

getFirstTextPropertyName()

Retrieves the property Id string for the first property field that contains text values.

Returns:: A property Id string.

getFocusedFieldName()

Returns the name of the field that has focus.

Returns:: The property Id string.

getPropertiesJSON(includeReadonly, includeHidden, excludeEmptyValues)

Retrieves the property values JSON string. See ecm.widget.PropertyEditors getPropertiesJSON for more details.

Parameters:
includeReadonly: A boolean value. If true, values for read only properties are included. Otherwise read only property values are excluded from the JSON.
includeHidden: A boolean value. if true, values for hidden properties are included. The parameter excludeEmptyValues also applies to hidden properties.
excludeEmptyValues: A boolean value. If true, properties with empty values are excluded.

Returns:: The JSON string for the current state of the properties.

getPropertyDisplayValue(fieldName)

Retrieves the display value from the property field identified by fieldName.

Parameters:
fieldName: A property Id string

Returns:: The display value string.

getPropertyEditors()

Retrieves the properties pane property editors.

Returns:: A ecm.widget.PropertyEditors object.

getPropertyValue(fieldName)

Retrieves the value for the property field identified by fieldName.

Parameters:
fieldName: The property Id string.

Returns:: The value for the property field.

isAttributeShown(attributeDefinition, item)

Determines whether the attribute will be shown.

Parameters:
attributeDefinition
item

isFieldDisplayed(fieldName)

Returns whether the field widget for the property named fieldName is displayed (not hidden).

Parameters:
fieldName: The string Id of the property.

Returns:: True if the field is displayed in the property table.

onAppendChildComponentClicked(childComponentId, checked)

Fired when the append childcomponet checkbox is clicked in multi edit mode.

Parameters:
childComponentId
checked

onAppendClick(attributeDefId, checked)

Fired when the user clicks the Append checkbox for a multi value property in multi edit mode.

Parameters:
attributeDefId: String ID value of the attribute for the checkbox clicked.
checked: Boolean indicating whether the checkbox is checked or unchecked.

onAttributesRendering(attributeDefinitions)

This event method is called before the attributes are rendered.

Parameters:
attributeDefinitions

onChange()

This event method is called after a change in the property pane.

onChildComponentCleared(childComponentId)

Fired when the a child component is cleared in multi edit mode.

Parameters:
childComponentId

onClearedRendering()

This event method is called after a properties rendering has been cleared.

onClearProperty(kwArgs, clearNode)

Called when a property is cleared in multi edit mode.

Parameters:
kwArgs
clearNode

onClickReferenceAttribute(evt)

This event method is called after the user clicks on a reference attribute.

Parameters:
evt

onCompleteRendering()

This event method is called after the properties have been rendered.

onMarkingPropertyChange()

This event method is called after a marking property value is changed. (IBM FileNet P8 only)

onMultiEditChildComponentChange(childComponentId)

Parameters:
childComponentId

onNewChildComponent(childComponentId)

Fired when the a new child component is added in multi edit mode.

Parameters:
childComponentId

onPropertyChanged(evt)

This event method is called after a property value is changed. Records that a field was changed and calls the properties pane onChange event method.

Parameters:
evt: An event object.

onPropertyRendered(row, field)

This event method is called after a property has been rendered.

Parameters:
row: The rendered property row that contains the field.
field: The field widget that was rendered in the property row.

onPropertyValueSet(kwArgs)

Called when a property value is changed to a non empty value. Used in multi item property editing.

Parameters:
kwArgs

onRetrySave()

When a property change is applied to a field with dependent properties by the user attempting to save the changes, the save is interrupted by returning the field as being invalid until the EDS call completes. This event is fired after the EDS call returns and the EDS changes are applied so that the save operation can be retried.

postCreate()

renderAttributes(attributeDefinitions, item, reason, isReadOnly, params)

Renders the attributes.

Parameters:
attributeDefinitions: An array of ecm.model.AttributeDefinition objects. Provides the definitions for the attributes in the item parameter.
item: A ecm.model.ContentItem object.
reason: The reason for displaying properties. Pass "create" when creating a new content item, "checkin" when checking in a content item, "editProperties" when editing the properties of a content item, or "multiEditProperties" when editing the properties of multiple content items.
isReadOnly: Pass true if the entire item is read only.
params: A object containing additional parameters. (@since 2.0.3)

renderChildComponents(childCompDefinitions, item, isReadOnly, newChildComponents, reason)

Renders the child components.

Parameters:
childCompDefinitions: An array of ecm.model.ChildComponentDefinition objects.
item: The ecm.model.ContentItem.
isReadOnly: A value of true if the entire item should be treated as read only.
newChildComponents: An array of ecm.model.ChildComponent objects for the item.
reason

renderTemplateMetadata(item)

Renders template metadata

Parameters:
item: The ecm.model.ContentItem.

Since:: 2.0.3.5

resize(changeSize)

Handles resizing the common properties pane.

Parameters:
changeSize

setDisabledNavigation(disableField)

Enables or disables each data type "xs:reference" property field if it is not read only.

Parameters:
disableField: A boolean value. If a property field is not read only and contains data type "xs:reference", then the property field is disabled if disableField is true or enabled if disableField is false. If the field is read only or is not for data type "xs:reference" then no change is made to the field.

setFieldError(fieldName, errorMessage, errorValue)

Assigns an error to a property field.

Parameters:
fieldName: A property Id string.
errorMessage: The error message string.
errorValue: The invalid value.

setFieldFocus(fieldName)

Places focus in the property field identified by fieldName, if found. This is typically used to set the focus on a field that has an invalid value.

Parameters:
fieldName: The property Id string.

setPropertyDisplayedValue(fieldName, displayValue)

Sets the displayed value for the property field identified by fieldName. The actual value might be different.

Parameters:
fieldName: The property Id string.
displayValue: The new display value for the property field.

setPropertyValue(fieldName, value)

Sets the value for the property field identified by fieldName.

Parameters:
fieldName: The property Id string.
value: The new value for the property field.

validate()

Validates all of the property fields.

Returns:: Returns null if all property fields contain valid values. Otherwise, returns the first property field widget that contains an invalid value.

validateAll(onEditStatus, onSaveStatus, focus)

Checks if the property fields contain valid values.

Parameters:
onEditStatus: A boolean value. If true, item properties are being modified. Only required property fields and property fields that have been modified are checked.
onSaveStatus: A boolean value. If true, changes are being saved. The first property field widget from the list of property fields with invalid values is returned.
focus

Since:: 2.0.3.8 A boolean value. If true and there is a field with an invalid value, focus is automatically set to the invalid field.

Returns:: Returns null if all checked property fields contain valid values. Otherwise, returns the first property field widget that contains an invalid value.

validateChangedField()

Validates the changed property fields.

Returns:: Returns null if all the changed property fields contain valid values. Otherwise, returns the first changed property field widget that contains an invalid value.

validateRequiredFields()

Validates the required property fields.

Since:: 2.0.2

Returns:: Returns null if all required fields contain valid values. Otherwise, returns the first required field that contains an invalid value.