Class ecm.widget.dialog.StatusDialog


Extends ecm.widget.dialog.BaseDialog.
Provides a dialog box that is used to display a status message during the processing of a request to the server.
Defined in: <ecm\widget\dialog\StatusDialog.js>.

Constructor Summary

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

Field Summary

Field Attributes Field Name and Description
 
delay 
The delay time in milliseconds before the status dialog will appear.
 
minDuration 
The minimum duration that the dialog will appear in milliseconds.
Fields borrowed from class ecm.widget.dialog.BaseDialog:
expandable, fitContentArea, lockFullscreen

Method Summary

Method Attributes Method Name and Description
 
destroy()
 
onCancel()
This is triggered when the dialog is canceled.
 
onHide()
This is triggered when the dialog is hidden.
 
postCreate()
 
requestCompletedHandler(request)
This method is used to handle the completion of the request.
 
requestStartedHandler(request)
This method is used to handle the start of a request.
 
startup()
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, show, showActionBar

Constructor Detail

ecm.widget.dialog.StatusDialog()

Field Detail

delay

The delay time in milliseconds before the status dialog will appear. By default this is 2000 milliseconds.

minDuration

The minimum duration that the dialog will appear in milliseconds. A minimum duration prevents the dialog from appearing and then disappearing so quickly that the user cannot have a chance to read it. The default time is 500 milliseconds.

Method Detail

destroy()

onCancel()

This is triggered when the dialog is canceled.

onHide()

This is triggered when the dialog is hidden.

postCreate()

requestCompletedHandler(request)

This method is used to handle the completion of the request. It is normally connected to ecm.model.Desktop.onRequestCompleted event.
Parameters:
request

requestStartedHandler(request)

This method is used to handle the start of a request. It is normally connected to ecm.model.Desktop.onRequestStarted event.
Parameters:
request

startup()