Class ecm.widget.ItemEditPane

Extends dijit.layout.ContentPane.
Provides a widget that is used to edit a folder or a document in a repository.
Defined in: <ecm\widget\ItemEditPane.js>.

Constructor Summary

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

Method Summary

Method Attributes	Method Name and Description
	canModifySecurity() Determines if security can be modified.
	destroy() Destroys the widget.
	getContentClassSelector() Retrieves the content class selector widget.
	getFieldsChanged() Determines if any of the item's property field values have changed.
	getItem() Returns the folder or document that is being edited.
	isAnyOtherChanged() Determines if there has been a change in anything other than properties, security, and class of the item that needs to be saved such as a new comment that hasn't been saved yet.
	isClassChanged() Determines if the item's content class has changed.
	isDirty() Determines if the item has been modified.
	isFolderETChanged() Determines if the entry template folder association has changed.
	isReadOnly() Determines if the entire item is read only (properties, security, and so on.
	isSecurityChanged() Determines if the item security has changed.
	isValid(focus, onEditStatus, onSaveStatus) Checks if the property fields contain valid values.
	onAnyOtherChange() This event method is called when there has been a change made on anything other than properties, security, and class of the item.
	onCancel() Handles the the cancel event.
	onChangeProperties(evt) This event method is called when an item property field value is changed.
	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 when the item properties have finished rendering.
	onFolderETChange() This event method is called when the entry templates folder association is changed.
	onNotelogChange()
	onRetrySave() This event is fired when a save operation can be retried.
	onSecurityChange() This event method is called when item security is changed.
	postCreate()
	save(callback) Saves the changes made to the item.
	setDisabledNavigation(disableField) Enables or disables each data type `"xs:reference"` property field if it is not read only.
	setItem(item, callback, teamspace, entryTemplate) Sets the folder or document that will be edited.

Constructor Detail

ecm.widget.ItemEditPane()

Method Detail

{Boolean} canModifySecurity()

Determines if security can be modified.

Returns:: {Boolean} A value of true if security can be modified, otherwise false.

destroy()

Destroys the widget.

getContentClassSelector()

Retrieves the content class selector widget.

Returns:: A ecm.widget.ContentClassSelector widget.

{Boolean} getFieldsChanged()

Determines if any of the item's property field values have changed.

Returns:: {Boolean} A value of true if an item property field value has changed, otherwise false.

getItem()

Returns the folder or document that is being edited.

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

{Boolean} isAnyOtherChanged()

Determines if there has been a change in anything other than properties, security, and class of the item that needs to be saved such as a new comment that hasn't been saved yet.

Returns:: {Boolean} A value of true if there has been a change hasn't been saved yet, otherwise false.

{Boolean} isClassChanged()

Determines if the item's content class has changed.

Returns:: {Boolean} A value of true if the item's content class has changed, otherwise false.

{Boolean} isDirty()

Determines if the item has been modified.

Returns:: {Boolean} A value of true if the item has been modified, otherwise false.

{Boolean} isFolderETChanged()

Determines if the entry template folder association has changed.

Returns:: {Boolean} A value of true if the selected entry template has changed, otherwise false.

{Boolean} isReadOnly()

Determines if the entire item is read only (properties, security, and so on.)

Returns:: {Boolean} A value of true if the entire item is read only, otherwise false. If the entire item is not read only, some settings (such as some properties and security settings) can still be read only.

{Boolean} isSecurityChanged()

Determines if the item security has changed.

Returns:: {Boolean} A value of true if the item's security has changed, otherwise false.

{Boolean} isValid(focus, onEditStatus, onSaveStatus)

Checks if the property fields contain valid values. See ecm.widget.ItemPropertiesPane validate.

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.

Returns:: {Boolean} A value of true if all property fields contain valid values, otherwise false.

onAnyOtherChange()

This event method is called when there has been a change made on anything other than properties, security, and class of the item.

onCancel()

Handles the the cancel event.

onChangeProperties(evt)

This event method is called when an item property field value is changed.

Parameters:
evt

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 when the item properties have finished rendering.

onFolderETChange()

This event method is called when the entry templates folder association is changed.

onNotelogChange()

Since:: 2.0.3 This event method is called when the notelog is changed.

onRetrySave()

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

onSecurityChange()

This event method is called when item security is changed.

postCreate()

save(callback)

Saves the changes made to the item.

Parameters:
callback: A method that is called after the item is saved.

setDisabledNavigation(disableField)

Enables or disables each data type "xs:reference" property field if it is not read only. See ecm.widget.ItemPropertiesPane 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.

setItem(item, callback, teamspace, entryTemplate)

Sets the folder or document that will be edited.

Parameters:
item: A folder or document ecm.model.ContentItem.
callback: A callback method that is called after the properties have been rendered.
teamspace: The ecm.model.Teamspace for the current teamspace.
entryTemplate: A ecm.model.EntryTemplate object to use for property rendering (@since 2.0.3)