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
 
ecm.widget.dialog.CheckInDialog()
Fields borrowed from class ecm.widget.dialog.AddContentItemDialog:
allowBrowseParentFolder, destroyWhenFinished, parentFolder, repository, showEntryTemplateName, singleDocumentSelect
Fields borrowed from class ecm.widget.dialog.BaseDialog:
expandable, fitContentArea, lockFullscreen

Method Summary

Method Attributes Method Name and Description
 
destroy()
Cleans up the widget.
 
getDaejaContent()
Get the Daeja content
 
onCheckin()
The Check In button event handler.
 
onCheckinFailed(response)
This event is fired when the checkin operation has failed.
 
onPrint()
 
onViewoneBuild()
 
postCreate()
 
setDaejaContent(daejaContent, daejaPartFileName)
Set the Daeja content and file name
 
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, getDaejaPartFileName, getExternalContentFilename, getRedactionPartFileName, hasDaejaContent, hasRedactionContent, isValid, onAdd, onAddFailed, onAddFinished, onCancel, setDaejaPartFileName, setDefaultContentClass, setFiles, setRedactionContent, setShowWarnings, showUsingTemplateItem
Methods borrowed from class ecm.widget.dialog.BaseDialog:
addButton, appendSecondaryMessage, buildRendering, clearMessage, clearSecondaryMessage, hide, isMaximized, onDragOver, resize, setExpandable, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, showActionBar

Constructor Detail

ecm.widget.dialog.CheckInDialog()

Method Detail

destroy()

Cleans up the widget.

getDaejaContent()

Get the Daeja content
Defined in: <ecm\widget\virtualViewer\PrintViewoneItemDialog.js>.
Since:
3.0.10

onCheckin()

The Check In button event handler.

onCheckinFailed(response)

This event is fired when the checkin operation has failed.
Parameters:
response

onPrint()


Defined in: <ecm\widget\virtualViewer\PrintViewoneItemDialog.js>.

onViewoneBuild()


Defined in: <ecm\widget\virtualViewer\PrintViewoneItemDialog.js>.

postCreate()


Defined in: <ecm\widget\virtualViewer\PrintViewoneItemDialog.js>.

setDaejaContent(daejaContent, daejaPartFileName)

Set the Daeja content and file name
Defined in: <ecm\widget\virtualViewer\PrintViewoneItemDialog.js>.
Parameters:
daejaContent
daejaPartFileName
Since:
3.0.10

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.