Class ecm.widget.dialog.BatchStatusDialog

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.
Defined in: <ecm\widget\dialog\BatchStatusDialog.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.dialog.BatchStatusDialog()

Field Summary

Field Attributes	Field Name and Description
	cancellable A boolean value.
	fitContentArea From ecm.widget.dialog.BaseDialog.
	modeless A boolean value that controls whether the batch status window locks the background window.
	title The title string for the batch status dialog.
	withLoadingIcon A boolean value.
	withProgressBar A boolean value.

Fields borrowed from class ecm.widget.dialog.BaseDialog:: lockFullscreen

Method Summary

Method Attributes	Method Name and Description
	onCancel() Event handler that overrides the default dialog `onCancel` event.
	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.
	showLoadingIcon(show) Shows or hides the loading icon.
	showProgressBar(show) Shows or hides the progress bar.
	startup()
	updateLabelInProgressBar(message) Updates label for progress bar.
	updateStatusMessage(statusMessage) Updates the status message.
	updateValueInProgressBar(percentage) Updates value for progress bar.

Methods borrowed from class ecm.widget.dialog.BaseDialog:: addButton, appendSecondaryMessage, buildRendering, clearMessage, clearSecondaryMessage, destroy, hide, isMaximized, onDragOver, resize, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, show, showActionBar

Constructor Detail

ecm.widget.dialog.BatchStatusDialog()

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).

modeless

A boolean value that controls whether the batch status window locks the background window. If true, the background window is not locked and the user can interact with the background window.

title

The title string for the batch status dialog.

withLoadingIcon

A boolean value. If true, loading icon is displayed on batch status dialog.

withProgressBar

A boolean value. If true, progress bar is displayed on batch status dialog.

Method Detail

onCancel()

Event handler that overrides the default dialog onCancel event.

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.

showLoadingIcon(show)

Shows or hides the loading icon.

Parameters:
show: If true, the loading icon will be shown. If false, the loading icon is hidden.

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()

updateLabelInProgressBar(message)

Updates label for progress bar.

Parameters:
message

updateStatusMessage(statusMessage)

Updates the status message.

Parameters:
statusMessage

updateValueInProgressBar(percentage)

Updates value for progress bar.

Parameters:
percentage