Class DHTMLSuite.modalMessage

Object
   |
   +--DHTMLSuite.modalMessage

class DHTMLSuite.modalMessage

Purpose of class: Display a modal DHTML message on the page. All other page controls will be disabled until the message is closed(demo).
Defined in dhtml-suite-for-applications.js

Author: Alf Magne Kalleland(www.dhtmlgoodies.com)
Version: 1.0

Field Detail

cssClassOfMessageBox

Object cssClassOfMessageBox

height

Object height

htmlOfModalMessage

Object htmlOfModalMessage

isModal

Object isModal

layoutCss

Object layoutCss

objectIndex

Object objectIndex

shadowDivVisible

Object shadowDivVisible

shadowOffset

Object shadowOffset

url

Object url

width

Object width

DHTMLSuite.modalMessage

DHTMLSuite.modalMessage(props)

Parameters:
Array - - Associative array of properties. These properties can also be set by calling invidiual set-methods. Possible keys in this array:
url - Url to file displayed in the message htmlOfModalMessage - Static HTML to display. domRef - Reference to dom element. This dom element will be cloned and displayed inside the message box. You will typically set display:none or visibility:hidden on this element width - Width of box height - Height of box cssClassOfMessageBox - Alternative css class for the message box shadowOffset - Size of drop shadow in pixels shadowDivVisible - Shadow visible (default = true) isModal - Is the dialog modal ? (default = true)

Author: Alf Magne Kalleland(www.dhtmlgoodies.com)
Version: 1.0

close

void close()

Close the modal dialog box

display

void display()

Display the modal dialog box

setCache

void setCache(cacheStatus)

Enable or disable cache for the ajax object

Parameters:
Boolean - cacheStatus = false = off, true = on

setCssClassMessageBox

void setCssClassMessageBox(newCssClass)

Assign the message box to a new css class.(in case you wants a different appearance on one of them)

Parameters:
String - newCssClass = Name of new css class (Pass false if you want to change back to default)

setDomReference

void setDomReference(domRef)

Specify reference to DOM element which will be displayed inside the modal message box.

Parameters:
Object - domRef = Dom reference

setHtmlContent

void setHtmlContent(newHtmlContent)

Setting static HTML content for the modal dialog box.

Parameters:
String - newHtmlContent = Static HTML content of box

setIsModal

void setIsModal(isModal)

Specify if the box should be modal, i.e. a transparent div behind the box covering page content.

setShadowDivVisible

void setShadowDivVisible(visible)

Display the modal dialog box

setShadowOffset

void setShadowOffset(newShadowOffset)

Specify the size of shadow

Parameters:
Int - newShadowOffset = Offset of shadow div(in pixels from message box - x and y)

setSize

void setSize(width,height)

Set the size of the modal dialog box

Parameters:
int - width = width of box
int - height = height of box

setSource

void setSource(urlOfSource)

Set source of the modal dialog box

setWaitImage

void setWaitImage(newImage)

Set a wait Image when Ajax is busy inserting content

Parameters:
String - newImage = New wait Image

setWaitMessage

void setWaitMessage(newMessage)

Set a wait message when Ajax is busy inserting content

Parameters:
String - newMessage = New wait message