Class ecm.widget.ItemPropertiesPane

Extends dijit._Widget.
Provides a widget that is used to edit the properties of an item.
Defined in: <ecm\widget\ItemPropertiesPane.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	commonPropertiesPaneClass A string value of the CommonPropertiesPane class to be created.
	reason A string value passed to the CommonPropertiesPane widget to set the reason (or mode) for property rendering.
	useContentClassSelector A boolean value.

Method Summary

Method Attributes	Method Name and Description
	clearRendering(setToNull) Clears the current property rendering.
	destroy()
	getChildComponentValues() Retrieves the array of child component values.
	getContentClass() Retrieves the content class.
	getContentClassSelector() Retrieves the content class selector widget.
	getItem() Returns the folder or document that is being edited.
	getPropertiesJSON(includeReadonly, includeHidden, excludeEmptyValues) Retrieves the property values JSON string.
<static>	ecm.widget.ItemPropertiesPane.ItemPropertiesPane.addExtension(itemPropertiesExtensionClass) This static method allows the `ItemPropertiesPane` to be extended with additional sections.
	onChange() This event method is called when a property field value changes.
	onClassChange() This event method is called when the item content class is changed.
	onClickReferenceAttribute() This event method is called when a reference attribute is clicked.
	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).
	onRetrySave() This event is fired when a save operation can be retried.
	postCreate()
	resizeLayout() Resizes the layout 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.
	setItem(item, isReadOnly, params) Sets the folder or document that will be edited.
	validate(focus, onEditStatus, onSaveStatus) Checks if the property fields contain valid values.

Constructor Detail

ecm.widget.ItemPropertiesPane()

Field Detail

commonPropertiesPaneClass

A string value of the CommonPropertiesPane class to be created. This allows plugin writers to provide a custom CommonPropertiesPane widget.

Since:: 2.0.2

reason

A string value passed to the CommonPropertiesPane widget to set the reason (or mode) for property rendering.

Since:: 2.0.2

useContentClassSelector

A boolean value. Determines whether or not the content class selector widget is displayed. If true it is displayed. Otherwise, only the class name is displayed.

Method Detail

clearRendering(setToNull)

Clears the current property rendering.

Parameters:
setToNull: Boolean flag indicating whether to additional set the common properties widget to null.

destroy()

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.

getContentClass()

Retrieves the content class.

Returns:: A ecm.model.ContentClass.

getContentClassSelector()

Retrieves the content class selector widget.

Returns:: A ecm.widget.ContentClassSelector widget.

getItem()

Returns the folder or document that is being edited.

Returns:: The folder or document ecm.model.ContentItem.

getPropertiesJSON(includeReadonly, includeHidden, excludeEmptyValues)

Retrieves the property values JSON string. See ecm.widget.CommonPropertiesPane 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.

<static> ecm.widget.ItemPropertiesPane.ItemPropertiesPane.addExtension(itemPropertiesExtensionClass)

This static method allows the ItemPropertiesPane to be extended with additional sections.

Parameters:
itemPropertiesExtensionClass: The constructor function for creating an instance of the extenstion.

onChange()

This event method is called when a property field value changes. See ecm.widget.CommonPropertiesPane onChange.

onClassChange()

This event method is called when the item content class is changed.

onClickReferenceAttribute()

This event method is called when a reference attribute is clicked. This method is not called if the reference attribute field is disabled.

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). See ecm.widget.CommonPropertiesPane onMarkingPropertyChange.

onRetrySave()

This event is fired when a save operation can be retried. See ecm.widget.CommonPropertiesPane onRetrySave.

postCreate()

resizeLayout()

Resizes the layout properties pane.

setDisabledNavigation(disableField)

Enables or disables each data type "xs:reference" property field if it is not read only. See ecm.widget.CommonPropertiesPane setDisabledNavigation.

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.

setItem(item, isReadOnly, params)

Sets the folder or document that will be edited.

Parameters:
item: A folder or document ecm.model.ContentItem.
isReadOnly: A boolean. If true the entire item is read only.
params: An object containing additional parameters and objects for the property pane. (@since 2.0.3)

validate(focus, onEditStatus, onSaveStatus)

Checks if the property fields contain valid values. See ecm.widget.CommonPropertiesPane validateAll.

Parameters:
focus: A boolean value. If true and there is a field with an invalid value, focus is automatically set to the invalid field.
onEditStatus: A boolean value. If true, item properties are being modified. Only 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.

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