git.roojs.org Git - roojs1/blob - Roo/MessageBox.js

   1 /*
   2  * Based on:
   3  * Ext JS Library 1.1.1
   4  * Copyright(c) 2006-2007, Ext JS, LLC.
   5  *
   6  * Originally Released Under LGPL - original licence link has changed is not relivant.
   7  *
   8  * Fork - LGPL
   9  * <script type="text/javascript">
  10  */
  11
  12 /**
  13  * @class Roo.MessageBox
  14  * Utility class for generating different styles of message boxes.  The alias Roo.Msg can also be used.
  15  * Example usage:
  16  *<pre><code>
  17 // Basic alert:
  18 Roo.Msg.alert('Status', 'Changes saved successfully.');
  19
  20 // Prompt for user data:
  21 Roo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
  22     if (btn == 'ok'){
  23         // process text value...
  24     }
  25 });
  26
  27 // Show a dialog using config options:
  28 Roo.Msg.show({
  29    title:'Save Changes?',
  30    msg: 'Your are closing a tab that has unsaved changes. Would you like to save your changes?',
  31    buttons: Roo.Msg.YESNOCANCEL,
  32    fn: processResult,
  33    animEl: 'elId'
  34 });
  35 </code></pre>
  36  * @singleton
  37  */
  38 Roo.MessageBox = function(){
  39     var dlg, opt, mask, waitTimer;
  40     var bodyEl, msgEl, textboxEl, textareaEl, progressEl, pp;
  41     var buttons, activeTextEl, bwidth;
  42
  43     // private
  44     var handleButton = function(button){
  45         dlg.hide();
  46         Roo.callback(opt.fn, opt.scope||window, [button, activeTextEl.dom.value], 1);
  47     };
  48
  49     // private
  50     var handleHide = function(){
  51         if(opt && opt.cls){
  52             dlg.el.removeClass(opt.cls);
  53         }
  54         if(waitTimer){
  55             Roo.TaskMgr.stop(waitTimer);
  56             waitTimer = null;
  57         }
  58     };
  59
  60     // private
  61     var updateButtons = function(b){
  62         var width = 0;
  63         if(!b){
  64             buttons["ok"].hide();
  65             buttons["cancel"].hide();
  66             buttons["yes"].hide();
  67             buttons["no"].hide();
  68             dlg.footer.dom.style.display = 'none';
  69             return width;
  70         }
  71         dlg.footer.dom.style.display = '';
  72         for(var k in buttons){
  73             if(typeof buttons[k] != "function"){
  74                 if(b[k]){
  75                     buttons[k].show();
  76                     buttons[k].setText(typeof b[k] == "string" ? b[k] : Roo.MessageBox.buttonText[k]);
  77                     width += buttons[k].el.getWidth()+15;
  78                 }else{
  79                     buttons[k].hide();
  80                 }
  81             }
  82         }
  83         return width;
  84     };
  85
  86     // private
  87     var handleEsc = function(d, k, e){
  88         if(opt && opt.closable !== false){
  89             dlg.hide();
  90         }
  91         if(e){
  92             e.stopEvent();
  93         }
  94     };
  95
  96     return {
  97         /**
  98          * Returns a reference to the underlying {@link Roo.BasicDialog} element
  99          * @return {Roo.BasicDialog} The BasicDialog element
 100          */
 101         getDialog : function(){
 102            if(!dlg){
 103                 dlg = new Roo.BasicDialog("x-msg-box", {
 104                     autoCreate : true,
 105                     shadow: true,
 106                     draggable: true,
 107                     resizable:false,
 108                     constraintoviewport:false,
 109                     fixedcenter:true,
 110                     collapsible : false,
 111                     shim:true,
 112                     modal: true,
 113                     width:400, height:100,
 114                     buttonAlign:"center",
 115                     closeClick : function(){
 116                         if(opt && opt.buttons && opt.buttons.no && !opt.buttons.cancel){
 117                             handleButton("no");
 118                         }else{
 119                             handleButton("cancel");
 120                         }
 121                     }
 122                 });
 123                 dlg.on("hide", handleHide);
 124                 mask = dlg.mask;
 125                 dlg.addKeyListener(27, handleEsc);
 126                 buttons = {};
 127                 var bt = this.buttonText;
 128                 buttons["ok"] = dlg.addButton(bt["ok"], handleButton.createCallback("ok"));
 129                 buttons["yes"] = dlg.addButton(bt["yes"], handleButton.createCallback("yes"));
 130                 buttons["no"] = dlg.addButton(bt["no"], handleButton.createCallback("no"));
 131                 buttons["cancel"] = dlg.addButton(bt["cancel"], handleButton.createCallback("cancel"));
 132                 bodyEl = dlg.body.createChild({
 133
 134                     html:'<span class="roo-mb-text"></span><br /><input type="text" class="roo-mb-input" /><textarea class="roo-mb-textarea"></textarea><div class="roo-mb-progress-wrap"><div class="roo-mb-progress"><div class="roo-mb-progress-bar">&#160;</div></div></div>'
 135                 });
 136                 msgEl = bodyEl.dom.firstChild;
 137                 textboxEl = Roo.get(bodyEl.dom.childNodes[2]);
 138                 textboxEl.enableDisplayMode();
 139                 textboxEl.addKeyListener([10,13], function(){
 140                     if(dlg.isVisible() && opt && opt.buttons){
 141                         if(opt.buttons.ok){
 142                             handleButton("ok");
 143                         }else if(opt.buttons.yes){
 144                             handleButton("yes");
 145                         }
 146                     }
 147                 });
 148                 textareaEl = Roo.get(bodyEl.dom.childNodes[3]);
 149                 textareaEl.enableDisplayMode();
 150                 progressEl = Roo.get(bodyEl.dom.childNodes[4]);
 151                 progressEl.enableDisplayMode();
 152                 var pf = progressEl.dom.firstChild;
 153                 if (pf) {
 154                     pp = Roo.get(pf.firstChild);
 155                     pp.setHeight(pf.offsetHeight);
 156                 }
 157
 158             }
 159             return dlg;
 160         },
 161
 162         /**
 163          * Updates the message box body text
 164          * @param {String} text (optional) Replaces the message box element's innerHTML with the specified string (defaults to
 165          * the XHTML-compliant non-breaking space character '&amp;#160;')
 166          * @return {Roo.MessageBox} This message box
 167          */
 168         updateText : function(text){
 169             if(!dlg.isVisible() && !opt.width){
 170                 dlg.resizeTo(this.maxWidth, 100); // resize first so content is never clipped from previous shows
 171             }
 172             msgEl.innerHTML = text || '&#160;';
 173             var w = Math.max(Math.min(opt.width || msgEl.offsetWidth, this.maxWidth),
 174                         Math.max(opt.minWidth || this.minWidth, bwidth));
 175             if(opt.prompt){
 176                 activeTextEl.setWidth(w);
 177             }
 178             if(dlg.isVisible()){
 179                 dlg.fixedcenter = false;
 180             }
 181             if ( bodyEl.getHeight() > (Roo.lib.Dom.getViewHeight() - 100)) {
 182                 bodyEl.setHeight ( Roo.lib.Dom.getViewHeight() - 100 );
 183                 bodyEl.el.dom.style.overflow = '';
 184             } else {
 185                 bodyEl.el.dom.style.height = '';
 186                 bodyEl.el.dom.style.overflow = '';
 187             }
 188
 189             dlg.setContentSize(w, bodyEl.getHeight());
 190             if(dlg.isVisible()){
 191                 dlg.fixedcenter = true;
 192             }
 193             return this;
 194         },
 195
 196         /**
 197          * Updates a progress-style message box's text and progress bar.  Only relevant on message boxes
 198          * initiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.
 199          * @param {Number} value Any number between 0 and 1 (e.g., .5)
 200          * @param {String} text (optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)
 201          * @return {Roo.MessageBox} This message box
 202          */
 203         updateProgress : function(value, text){
 204             if(text){
 205                 this.updateText(text);
 206             }
 207             if (pp) { // weird bug on my firefox - for some reason this is not defined
 208                 pp.setWidth(Math.floor(value*progressEl.dom.firstChild.offsetWidth));
 209             }
 210             return this;
 211         },
 212
 213         /**
 214          * Returns true if the message box is currently displayed
 215          * @return {Boolean} True if the message box is visible, else false
 216          */
 217         isVisible : function(){
 218             return dlg && dlg.isVisible();
 219         },
 220
 221         /**
 222          * Hides the message box if it is displayed
 223          */
 224         hide : function(){
 225             if(this.isVisible()){
 226                 dlg.hide();
 227             }
 228         },
 229
 230         /**
 231          * Displays a new message box, or reinitializes an existing message box, based on the config options
 232          * passed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.
 233          * The following config object properties are supported:
 234          * <pre>
 235 Property    Type             Description
 236 ----------  ---------------  ------------------------------------------------------------------------------------
 237 animEl            String/Element   An id or Element from which the message box should animate as it opens and
 238                                    closes (defaults to undefined)
 239 buttons           Object/Boolean   A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',
 240                                    cancel:'Bar'}), or false to not show any buttons (defaults to false)
 241 closable          Boolean          False to hide the top-right close button (defaults to true).  Note that
 242                                    progress and wait dialogs will ignore this property and always hide the
 243                                    close button as they can only be closed programmatically.
 244 cls               String           A custom CSS class to apply to the message box element
 245 defaultTextHeight Number           The default height in pixels of the message box's multiline textarea if
 246                                    displayed (defaults to 75)
 247 fn                Function         A callback function to execute after closing the dialog.  The arguments to the
 248                                    function will be btn (the name of the button that was clicked, if applicable,
 249                                    e.g. "ok"), and text (the value of the active text field, if applicable).
 250                                    Progress and wait dialogs will ignore this option since they do not respond to
 251                                    user actions and can only be closed programmatically, so any required function
 252                                    should be called by the same code after it closes the dialog.
 253 icon              String           A CSS class that provides a background image to be used as an icon for
 254                                    the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')
 255 maxWidth          Number           The maximum width in pixels of the message box (defaults to 600)
 256 minWidth          Number           The minimum width in pixels of the message box (defaults to 100)
 257 modal             Boolean          False to allow user interaction with the page while the message box is
 258                                    displayed (defaults to true)
 259 msg               String           A string that will replace the existing message box body text (defaults
 260                                    to the XHTML-compliant non-breaking space character '&#160;')
 261 multiline         Boolean          True to prompt the user to enter multi-line text (defaults to false)
 262 progress          Boolean          True to display a progress bar (defaults to false)
 263 progressText      String           The text to display inside the progress bar if progress = true (defaults to '')
 264 prompt            Boolean          True to prompt the user to enter single-line text (defaults to false)
 265 proxyDrag         Boolean          True to display a lightweight proxy while dragging (defaults to false)
 266 title             String           The title text
 267 value             String           The string value to set into the active textbox element if displayed
 268 wait              Boolean          True to display a progress bar (defaults to false)
 269 width             Number           The width of the dialog in pixels
 270 </pre>
 271          *
 272          * Example usage:
 273          * <pre><code>
 274 Roo.Msg.show({
 275    title: 'Address',
 276    msg: 'Please enter your address:',
 277    width: 300,
 278    buttons: Roo.MessageBox.OKCANCEL,
 279    multiline: true,
 280    fn: saveAddress,
 281    animEl: 'addAddressBtn'
 282 });
 283 </code></pre>
 284          * @param {Object} config Configuration options
 285          * @return {Roo.MessageBox} This message box
 286          */
 287         show : function(options)
 288         {
 289
 290             // this causes nightmares if you show one dialog after another
 291             // especially on callbacks..
 292
 293             if(this.isVisible()){
 294
 295                 this.hide();
 296                 Roo.log("Old Dialog Message:" +  msgEl.innerHTML )
 297                 //this.alert("ERROR", "Multiple dialogs where displayed at the same time");
 298                 //throw "Roo.MessageBox ERROR : Multiple dialogs where displayed at the same time";
 299
 300             }
 301             var d = this.getDialog();
 302             opt = options;
 303             d.setTitle(opt.title || "&#160;");
 304             d.close.setDisplayed(opt.closable !== false);
 305             activeTextEl = textboxEl;
 306             opt.prompt = opt.prompt || (opt.multiline ? true : false);
 307             if(opt.prompt){
 308                 if(opt.multiline){
 309                     textboxEl.hide();
 310                     textareaEl.show();
 311                     textareaEl.setHeight(typeof opt.multiline == "number" ?
 312                         opt.multiline : this.defaultTextHeight);
 313                     activeTextEl = textareaEl;
 314                 }else{
 315                     textboxEl.show();
 316                     textareaEl.hide();
 317                 }
 318             }else{
 319                 textboxEl.hide();
 320                 textareaEl.hide();
 321             }
 322             progressEl.setDisplayed(opt.progress === true);
 323             this.updateProgress(0);
 324             activeTextEl.dom.value = opt.value || "";
 325             if(opt.prompt){
 326                 dlg.setDefaultButton(activeTextEl);
 327             }else{
 328                 var bs = opt.buttons;
 329                 var db = null;
 330                 if(bs && bs.ok){
 331                     db = buttons["ok"];
 332                 }else if(bs && bs.yes){
 333                     db = buttons["yes"];
 334                 }
 335                 dlg.setDefaultButton(db);
 336             }
 337             bwidth = updateButtons(opt.buttons);
 338             this.updateText(opt.msg);
 339             if(opt.cls){
 340                 d.el.addClass(opt.cls);
 341             }
 342             d.proxyDrag = opt.proxyDrag === true;
 343             d.modal = opt.modal !== false;
 344             d.mask = opt.modal !== false ? mask : false;
 345             if(!d.isVisible()){
 346                 // force it to the end of the z-index stack so it gets a cursor in FF
 347                 document.body.appendChild(dlg.el.dom);
 348                 d.animateTarget = null;
 349                 d.show(options.animEl);
 350             }
 351             return this;
 352         },
 353
 354         /**
 355          * Displays a message box with a progress bar.  This message box has no buttons and is not closeable by
 356          * the user.  You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}
 357          * and closing the message box when the process is complete.
 358          * @param {String} title The title bar text
 359          * @param {String} msg The message box body text
 360          * @return {Roo.MessageBox} This message box
 361          */
 362         progress : function(title, msg){
 363             this.show({
 364                 title : title,
 365                 msg : msg,
 366                 buttons: false,
 367                 progress:true,
 368                 closable:false,
 369                 minWidth: this.minProgressWidth,
 370                 modal : true
 371             });
 372             return this;
 373         },
 374
 375         /**
 376          * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).
 377          * If a callback function is passed it will be called after the user clicks the button, and the
 378          * id of the button that was clicked will be passed as the only parameter to the callback
 379          * (could also be the top-right close button).
 380          * @param {String} title The title bar text
 381          * @param {String} msg The message box body text
 382          * @param {Function} fn (optional) The callback function invoked after the message box is closed
 383          * @param {Object} scope (optional) The scope of the callback function
 384          * @return {Roo.MessageBox} This message box
 385          */
 386         alert : function(title, msg, fn, scope){
 387             this.show({
 388                 title : title,
 389                 msg : msg,
 390                 buttons: this.OK,
 391                 fn: fn,
 392                 scope : scope,
 393                 modal : true
 394             });
 395             return this;
 396         },
 397
 398         /**
 399          * Displays a message box with an infinitely auto-updating progress bar.  This can be used to block user
 400          * interaction while waiting for a long-running process to complete that does not have defined intervals.
 401          * You are responsible for closing the message box when the process is complete.
 402          * @param {String} msg The message box body text
 403          * @param {String} title (optional) The title bar text
 404          * @return {Roo.MessageBox} This message box
 405          */
 406         wait : function(msg, title){
 407             this.show({
 408                 title : title,
 409                 msg : msg,
 410                 buttons: false,
 411                 closable:false,
 412                 progress:true,
 413                 modal:true,
 414                 width:300,
 415                 wait:true
 416             });
 417             waitTimer = Roo.TaskMgr.start({
 418                 run: function(i){
 419                     Roo.MessageBox.updateProgress(((((i+20)%20)+1)*5)*.01);
 420                 },
 421                 interval: 1000
 422             });
 423             return this;
 424         },
 425
 426         /**
 427          * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).
 428          * If a callback function is passed it will be called after the user clicks either button, and the id of the
 429          * button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).
 430          * @param {String} title The title bar text
 431          * @param {String} msg The message box body text
 432          * @param {Function} fn (optional) The callback function invoked after the message box is closed
 433          * @param {Object} scope (optional) The scope of the callback function
 434          * @return {Roo.MessageBox} This message box
 435          */
 436         confirm : function(title, msg, fn, scope){
 437             this.show({
 438                 title : title,
 439                 msg : msg,
 440                 buttons: this.YESNO,
 441                 fn: fn,
 442                 scope : scope,
 443                 modal : true
 444             });
 445             return this;
 446         },
 447
 448         /**
 449          * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to
 450          * JavaScript's Window.prompt).  The prompt can be a single-line or multi-line textbox.  If a callback function
 451          * is passed it will be called after the user clicks either button, and the id of the button that was clicked
 452          * (could also be the top-right close button) and the text that was entered will be passed as the two
 453          * parameters to the callback.
 454          * @param {String} title The title bar text
 455          * @param {String} msg The message box body text
 456          * @param {Function} fn (optional) The callback function invoked after the message box is closed
 457          * @param {Object} scope (optional) The scope of the callback function
 458          * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight
 459          * property, or the height in pixels to create the textbox (defaults to false / single-line)
 460          * @return {Roo.MessageBox} This message box
 461          */
 462         prompt : function(title, msg, fn, scope, multiline){
 463             this.show({
 464                 title : title,
 465                 msg : msg,
 466                 buttons: this.OKCANCEL,
 467                 fn: fn,
 468                 minWidth:250,
 469                 scope : scope,
 470                 prompt:true,
 471                 multiline: multiline,
 472                 modal : true
 473             });
 474             return this;
 475         },
 476
 477         /**
 478          * Button config that displays a single OK button
 479          * @type Object
 480          */
 481         OK : {ok:true},
 482         /**
 483          * Button config that displays Yes and No buttons
 484          * @type Object
 485          */
 486         YESNO : {yes:true, no:true},
 487         /**
 488          * Button config that displays OK and Cancel buttons
 489          * @type Object
 490          */
 491         OKCANCEL : {ok:true, cancel:true},
 492         /**
 493          * Button config that displays Yes, No and Cancel buttons
 494          * @type Object
 495          */
 496         YESNOCANCEL : {yes:true, no:true, cancel:true},
 497
 498         /**
 499          * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
 500          * @type Number
 501          */
 502         defaultTextHeight : 75,
 503         /**
 504          * The maximum width in pixels of the message box (defaults to 600)
 505          * @type Number
 506          */
 507         maxWidth : 600,
 508         /**
 509          * The minimum width in pixels of the message box (defaults to 100)
 510          * @type Number
 511          */
 512         minWidth : 100,
 513         /**
 514          * The minimum width in pixels of the message box if it is a progress-style dialog.  This is useful
 515          * for setting a different minimum width than text-only dialogs may need (defaults to 250)
 516          * @type Number
 517          */
 518         minProgressWidth : 250,
 519         /**
 520          * An object containing the default button text strings that can be overriden for localized language support.
 521          * Supported properties are: ok, cancel, yes and no.
 522          * Customize the default text like so: Roo.MessageBox.buttonText.yes = "S?";
 523          * @type Object
 524          */
 525         buttonText : {
 526             ok : "OK",
 527             cancel : "Cancel",
 528             yes : "Yes",
 529             no : "No"
 530         }
 531     };
 532 }();
 533
 534 /**
 535  * Shorthand for {@link Roo.MessageBox}
 536  */
 537 Roo.Msg = Roo.MessageBox;