Class ecm.widget.dialog.ErrorDialog
Extends
ecm.widget.dialog.BaseDialog.
Provides a dialog box that is used to display an error message that was generated by a service request.
This dialog can be connected to the onMessageAdded
event of ecm.model.desktop
to listen to response messages and automatically display error dialogs for errors returned from requests
to the server.
Defined in: <ecm\widget\dialog\ErrorDialog.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Determines if the model dialog is indicated as an alert dialog in the WAI accessibility attributes.
|
|
The product identifier.
|
|
- Fields borrowed from class ecm.widget.dialog.BaseDialog:
- fitContentArea, lockFullscreen
Method Summary
Method Attributes | Method Name and Description |
---|---|
Overrides
ecm.widget.dialog.BaseDialog.buildRendering to create the dialog rendering. |
|
hide()
Hides the dialog.
|
|
messageAddedHandler(message)
A handler for when a message has been added to the desktop.
|
|
show()
|
|
showMessage(message)
Displays the provided message in this dialog.
|
|
startup()
|
- Methods borrowed from class ecm.widget.dialog.BaseDialog:
- addButton, appendSecondaryMessage, clearMessage, clearSecondaryMessage, destroy, isMaximized, onDragOver, resize, setIntroText, setIntroTextRef, setMaximized, setMessage, setReferenceLink, setResizable, setSize, setSizeToViewportRatio, setTitle, setWidth, showActionBar
Field Detail
alert
Determines if the model dialog is indicated as an alert dialog in the WAI accessibility attributes.
messageProductId
The product identifier. By default this is CIWEB (the IBM Content Navigator product id).
messageQueryUrl
- Deprecated:
- this field is unused
Method Detail
buildRendering()
Overrides
ecm.widget.dialog.BaseDialog.buildRendering
to create the dialog rendering.
constructor()
hide()
Hides the dialog.
messageAddedHandler(message)
A handler for when a message has been added to the desktop. This is normally connected to
ecm.model.Desktop.onMessageAdded
.
- Parameters:
- message
postCreate()
postMixInProperties()
show()
showMessage(message)
Displays the provided message in this dialog.
- Parameters:
- message
- An instance of
ecm.model.Message
containing the error message to display.