Zimlet JavaScript API Reference - DwtMessageDialog

Class DwtMessageDialog


Extends DwtDialog.

Creates a new message dialog. This class represents a reusable message dialog box. Messages can be informational, warning, or critical.

Defined in: DwtMessageDialog.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
DwtMessageDialog.CRITICAL_STYLE
Defines the "critical" style.
<static>  
DwtMessageDialog.INFO_STYLE
Defines the "info" style.
<static>  
DwtMessageDialog.PLAIN_STYLE
Defines a style with no icon.
<static>  
DwtMessageDialog.WARNING_STYLE
Defines the "warning" style.
Method Summary
Method Attributes Method Name and Description
 
Resets the message dialog.
 
Sets the message style (info/warning/critical) and content.
 
setMessage(msgStr, style, title)
Sets the message style (info/warning/critical) and content.
 
toString()
Methods borrowed from class DwtDialog:
associateEnterWithButton, getButton, getButtonEnabled, popup, registerCallback, resetButtonStates, setButtonEnabled, setButtonListener, setButtonVisible, setEnterListener, unregisterCallback
Methods borrowed from class DwtBaseDialog:
addEnterListener, addPopdownListener, addPopupListener, cleanup, isPoppedUp, popdown, removePopdownListener, removePopupListener, setContent, setTitle, setView
Methods borrowed from class DwtComposite:
addChild, cleanupSeparators, clear, dispose, getChild, getChildren, getNumChildren, getTabGroupMember, removeChild, removeChildren
Methods borrowed from class DwtControl:
addClassName, addControlListener, addDisposeListener, addListener, appendElement, blur, clearContent, clearHandler, condClassName, delClassName, focus, getBounds, getClassName, getContent, getCursor, getData, getDragBox, getDragSource, getDropTarget, getEnabled, getFocusElement, getH, getHtmlElement, getHTMLElId, getInsetBounds, getInsets, getLocation, getMargins, getOpacity, getOuterSize, getPosition, getScrollContainer, getScrollStyle, getSize, getTooltipBase, getToolTipContent, getVisibility, getVisible, getW, getX, getXW, getY, getYH, getZIndex, hasFocus, isAlertShown, isDisposed, isInitialized, isListenerRegistered, notifyListeners, preventContextMenu, preventSelection, removeAllListeners, removeControlListener, removeDisposeListener, removeListener, reparent, reparentHtmlElement, replaceElement, setBounds, setClassName, setCursor, setData, setDisplay, setDisplayState, setDragBox, setDragSource, setDropTarget, setEnabled, setEventPropagation, setFocusElement, setHandler, setHtmlElementId, setLocation, setOpacity, setPosition, setScrollStyle, setSize, setToolTipContent, setVisibility, setVisible, setZIndex, showAlert, zShow
Class Detail
DwtMessageDialog(params)

Author: Ross Dargahi.
Parameters:
{hash} params
a hash of parameters
{DwtComposite} params.parent
the parent widget (the shell)
{string} params.className
the CSS class
{array} params.buttons
the buttons to show. Defaults to DwtDialog.OK_BUTTON button
{array} params.extraButtons
a list of DwtDialog_ButtonDescriptor objects describing custom buttons to add to the dialog
{String} params.helpText
shows a left aligned help button with the text specified in this param.
Field Detail
<static> DwtMessageDialog.CRITICAL_STYLE
Defines the "critical" style.

<static> DwtMessageDialog.INFO_STYLE
Defines the "info" style.

<static> DwtMessageDialog.PLAIN_STYLE
Defines a style with no icon.

<static> DwtMessageDialog.WARNING_STYLE
Defines the "warning" style.
Method Detail
reset()
Resets the message dialog. This should be performed to "reuse" the dialog.

setHelpURL(url)
Sets the message style (info/warning/critical) and content.
Parameters:
{string} url
the url of the help

setMessage(msgStr, style, title)
Sets the message style (info/warning/critical) and content.
Parameters:
{string} msgStr
the message text
{constant} style
the style (see DwtMessageDialog.*_STYLE constants)
{string} title
the dialog box title

toString()

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:29 GMT-0400 (EDT)