Class ecm.widget.dialog.EditPropertiesDialog


Extends ecm.widget.dialog.BaseDialog.
Provides a dialog box that is used to edit the properties of a document or folder.
Defined in: <ecm\widget\dialog\EditPropertiesDialog.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
ecm.widget.dialog.EditPropertiesDialog()
Fields borrowed from class ecm.widget.dialog.BaseDialog:
fitContentArea, lockFullscreen

Method Summary

Method Attributes Method Name and Description
 
destroy()
 
hide()
 
onCancel()
Called when the Cancel button is clicked.
 
onPrevious()
Called when the previous button is clicked.
 
onSave()
Called when the ok/save button is clicked.
 
postCreate()
 
show(item, callback, teamspace, entryTemplate)
Show the edit properties dialog.
 
showProperties(item, callback, teamspace)
This is the recommended method to call for displaying the Properties dialog.
Methods borrowed from class ecm.widget.dialog.BaseDialog:
addButton, appendSecondaryMessage, buildRendering, clearMessage, clearSecondaryMessage, isMaximized, onDragOver, resize, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, showActionBar

Constructor Detail

ecm.widget.dialog.EditPropertiesDialog()

Method Detail

destroy()

hide()

onCancel()

Called when the Cancel button is clicked. Closes the dialog without saving.

onPrevious()

Called when the previous button is clicked. Pops the breadcrumb and shows the previous panel.

onSave()

Called when the ok/save button is clicked. Validates the data and saves it.

postCreate()

show(item, callback, teamspace, entryTemplate)

Show the edit properties dialog.
Parameters:
item
The ecm.model.Item item whose properties will be edited.
callback
Callback method that is called when the property changes are saved.
teamspace
The active teamspace as a ecm.model.Teamspace object.
entryTemplate
A ecm.model.EntryTemplate object that should be applied when displaying properties. This object is usually passed in from showProperties. (@since 2.0.3)

showProperties(item, callback, teamspace)

This is the recommended method to call for displaying the Properties dialog. If the content item was created using an entry template, this method retrieves the entry template and if it is enabled for properties, applies it to the Properties dialog.
Parameters:
item
The ecm.model.ContentItem that will be displayed in the properties dialog.
callback
A function that is called after the content item is displayed in properties dialog.
teamspace
The ecm.model.Teamspace for the add if working within a teamspace.
Since:
2.0.3