w2utils.message

Slides down a dialog that does not lock entire page.

message(where, [options])

where	object, where to display
options	object, optional, additional parametes

Return a promise that is resolved when message is displayed.

This method is used internally to show message in w2grid and w2form. It will lock the content of specified div and will slide down a message. First argument where is a object of the following structure

xxxxxxxxxx
 
{
    box   : null,  // html element where it will display message
    path  : null,  // path to a w2ui object that is locked
    title : null,  // css selector for a title (if any)
    body  : null   // css selector for a body
 }
​

For example, in w2grid it is called in the following way

xxxxxxxxxx
 
w2utils.message.call(this, {
    box   : this.box,
    path  : 'w2ui.' + this.name,
    title : '.w2ui-grid-header:visible',
    body  : '.w2ui-grid-box'
}, options);
​

The second argument options is the same as for w2popup.message() method and can have following options

xxxxxxxxxx
 
options: {
    html        : '',    // html of the message
    body        : '',    // similar to body in w2popup, can be used instead of options.html
    buttons     : '',    // similar to buttons in w2popup, can be used instead of options.html
    width       : 10,    // width in px (if negative, then it is 100% of popup in message.width)
    height      : 10,    // height in px (if negative, then it is 100% of popup in message.height)
    hideOnClick : false, // if true, hide message if user clicks on it
    onOpen      : null,  // function to execute when message opens
    onClose     : null   // function to execute when message closes
}
​

w2utils.message

User Comments