Class ecm.widget.dialog.BatchStatusFileListDialog
Extends
ecm.widget.dialog.BaseDialog.
Provides a dialog box that is used to display a status message during batch processing of multiple
requests to the server. This dialog also lists all the files being uploaded.
Defined in: <ecm\widget\dialog\BatchStatusFileListDialog.js>.
Constructor Summary
| Constructor Attributes | Constructor Name and Description |
|---|---|
Field Summary
| Field Attributes | Field Name and Description |
|---|---|
|
A boolean value.
|
|
- Fields borrowed from class ecm.widget.dialog.BaseDialog:
- expandable, lockFullscreen
Method Summary
| Method Attributes | Method Name and Description |
|---|---|
|
addFilesToStore(id, files)
Adds input files to the grid
|
|
|
destroy()
|
|
|
onCancel()
Event handler that overrides the default dialog
onCancel event. |
|
|
onClose(e)
|
|
|
onHide()
Event handler that is called when the batch status dialog is hidden.
|
|
|
onQuit()
Event handler that is called when the batch status dialog is canceled.
|
|
|
onShow()
Event handler that is called when the batch status dialog is shown.
|
|
|
Creates the batch status dialog.
|
|
|
refresh()
|
|
|
removeFile(file)
|
|
|
show()
|
|
|
showProgressBar(show)
Shows or hides the progress bar.
|
|
|
startup()
|
|
|
updateFile(file, forceRefresh)
|
|
|
updateLabelInProgressBar(message)
Updates label for progress bar.
|
|
|
Updates the status message.
|
|
|
updateValueInProgressBar(percentage)
Updates value for progress bar.
|
|
- 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
Field Detail
cancellable
A boolean value. If
true, a Cancel button is displayed so that the user can
cancel the batch operation at any time. It is the responsibility of the batch operation to monitor the
onCancel event and process the cancel request.
fitContentArea
From ecm.widget.dialog.BaseDialog. This is set to
false so that the batch status
dialog automatically resizes to display the full status message (no scrollbars).
Method Detail
addFilesToStore(id, files)
Adds input files to the grid
- Parameters:
- {string} id
- The parent dialog id
- {FileList} files
- File list
destroy()
onCancel()
Event handler that overrides the default dialog
onCancel event.
onClose(e)
- Parameters:
- e
onHide()
Event handler that is called when the batch status dialog is hidden.
onQuit()
Event handler that is called when the batch status dialog is canceled.
onShow()
Event handler that is called when the batch status dialog is shown.
postCreate()
Creates the batch status dialog.
refresh()
removeFile(file)
- Parameters:
- file
show()
showProgressBar(show)
Shows or hides the progress bar.
- Parameters:
- show
- If true, the progress bar will be shown. If false, the progress bar is hidden.
startup()
updateFile(file, forceRefresh)
- Parameters:
- file
- forceRefresh
updateLabelInProgressBar(message)
Updates label for progress bar.
- Parameters:
- message
updateStatusMessage()
Updates the status message.
updateValueInProgressBar(percentage)
Updates value for progress bar.
- Parameters:
- percentage
updateVisibilityIndex(min)
- Parameters:
- min