Class ecm.widget.dialog.CheckInDialog
Extends
ecm.widget.dialog.AddContentItemDialog.
Provides a dialog box that is used to check documents in to a repository.
Defined in: <ecm\widget\dialog\CheckInDialog.js>.
Constructor Summary
| Constructor Attributes | Constructor Name and Description |
|---|---|
- Fields borrowed from class ecm.widget.dialog.AddContentItemDialog:
- destroyWhenFinished, parentFolder, repository, singleDocumentSelect
- Fields borrowed from class ecm.widget.dialog.BaseDialog:
- fitContentArea, lockFullscreen
Method Summary
| Method Attributes | Method Name and Description |
|---|---|
|
destroy()
Cleans up the widget.
|
|
|
The Check In button event handler.
|
|
|
show(repository, item, callback, teamspace, entryTemplate, repositoryDocumentMode)
Displays the Check In dialog for checking in a content item.
|
|
|
showCheckin(repository, item, callback, teamspace, repositoryDocumentMode)
This is the recommended method to call for displaying the Check In dialog.
|
- Methods borrowed from class ecm.widget.dialog.AddContentItemDialog:
- addFolderInMemory, applyEntryTemplate, getRedactionPartFileName, hasRedactionContent, isValid, onAdd, onAddFinished, onCancel, setDefaultContentClass, setFiles, setRedactionContent, showUsingTemplateItem
- Methods borrowed from class ecm.widget.dialog.BaseDialog:
- addButton, appendSecondaryMessage, buildRendering, clearMessage, clearSecondaryMessage, hide, isMaximized, onDragOver, resize, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, showActionBar
Method Detail
destroy()
Cleans up the widget.
onCheckin()
The Check In button event handler.
postCreate()
show(repository, item, callback, teamspace, entryTemplate, repositoryDocumentMode)
Displays the Check In dialog for checking in a content item. Usually the method
showCheckin
should be called instead so that if there is an associated entry template that is enabled for check in, it is
retrieved and applied.
- Parameters:
- repository
- The ecm.model.Repository for the checkin.
- item
- The ecm.model.ContentItem that will be checked in.
- callback
- A function that is called after the content item is checked in.
- teamspace
- The ecm.model.Teamspace for the add if working within a teamspace.
- entryTemplate
- A ecm.model.EntryTemplate object that should be applied during checkin. This object is
usually passed in from
showCheckin. - repositoryDocumentMode
- Since:
- 2.0.3.6 A boolean value indicating if the dialog should render in repository document content type mode.
showCheckin(repository, item, callback, teamspace, repositoryDocumentMode)
This is the recommended method to call for displaying the Check In dialog. If the content item was created
using an entry template, this method retrieves the entry template and if it is enabled for checkin, applies
it to the checkin dialog.
- Parameters:
- repository
- The ecm.model.Repository for the checkin.
- item
- The ecm.model.ContentItem that will be checked in.
- callback
- A function that is called after the content item is checked in.
- teamspace
- The ecm.model.Teamspace for the add if working within a teamspace.
- repositoryDocumentMode
- A boolean value indicating if the dialog should render in repository document content type mode.