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
 174             var cw =  Math.max(msgEl.offsetWidth, msgEl.parentNode.scrollWidth);
 175             //Roo.log("guesed size: " + JSON.stringify([cw,msgEl.offsetWidth, msgEl.parentNode.scrollWidth]));
 176             var w = Math.max(
 177                     Math.min(opt.width || cw , this.maxWidth),
 178                     Math.max(opt.minWidth || this.minWidth, bwidth)
 179             );
 180             if(opt.prompt){
 181                 activeTextEl.setWidth(w);
 182             }
 183             if(dlg.isVisible()){
 184                 dlg.fixedcenter = false;
 185             }
 186             // to big, make it scroll. = But as usual stupid IE does not support
 187             // !important..
 188
 189             if ( bodyEl.getHeight() > (Roo.lib.Dom.getViewHeight() - 100)) {
 190                 bodyEl.setHeight ( Roo.lib.Dom.getViewHeight() - 100 );
 191                 bodyEl.dom.style.overflowY = 'auto' + ( Roo.isIE ? '' : ' !important');
 192             } else {
 193                 bodyEl.dom.style.height = '';
 194                 bodyEl.dom.style.overflowY = '';
 195             }
 196             if (cw > w) {
 197                 bodyEl.dom.style.get = 'auto' + ( Roo.isIE ? '' : ' !important');
 198             } else {
 199                 bodyEl.dom.style.overflowX = '';
 200             }
 201
 202             dlg.setContentSize(w, bodyEl.getHeight());
 203             if(dlg.isVisible()){
 204                 dlg.fixedcenter = true;
 205             }
 206             return this;
 207         },
 208
 209         /**
 210          * Updates a progress-style message box's text and progress bar.  Only relevant on message boxes
 211          * initiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.
 212          * @param {Number} value Any number between 0 and 1 (e.g., .5)
 213          * @param {String} text (optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)
 214          * @return {Roo.MessageBox} This message box
 215          */
 216         updateProgress : function(value, text){
 217             if(text){
 218                 this.updateText(text);
 219             }
 220             if (pp) { // weird bug on my firefox - for some reason this is not defined
 221                 pp.setWidth(Math.floor(value*progressEl.dom.firstChild.offsetWidth));
 222             }
 223             return this;
 224         },
 225
 226         /**
 227          * Returns true if the message box is currently displayed
 228          * @return {Boolean} True if the message box is visible, else false
 229          */
 230         isVisible : function(){
 231             return dlg && dlg.isVisible();
 232         },
 233
 234         /**
 235          * Hides the message box if it is displayed
 236          */
 237         hide : function(){
 238             if(this.isVisible()){
 239                 dlg.hide();
 240             }
 241         },
 242
 243         /**
 244          * Displays a new message box, or reinitializes an existing message box, based on the config options
 245          * passed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.
 246          * The following config object properties are supported:
 247          * <pre>
 248 Property    Type             Description
 249 ----------  ---------------  ------------------------------------------------------------------------------------
 250 animEl            String/Element   An id or Element from which the message box should animate as it opens and
 251                                    closes (defaults to undefined)
 252 buttons           Object/Boolean   A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',
 253                                    cancel:'Bar'}), or false to not show any buttons (defaults to false)
 254 closable          Boolean          False to hide the top-right close button (defaults to true).  Note that
 255                                    progress and wait dialogs will ignore this property and always hide the
 256                                    close button as they can only be closed programmatically.
 257 cls               String           A custom CSS class to apply to the message box element
 258 defaultTextHeight Number           The default height in pixels of the message box's multiline textarea if
 259                                    displayed (defaults to 75)
 260 fn                Function         A callback function to execute after closing the dialog.  The arguments to the
 261                                    function will be btn (the name of the button that was clicked, if applicable,
 262                                    e.g. "ok"), and text (the value of the active text field, if applicable).
 263                                    Progress and wait dialogs will ignore this option since they do not respond to
 264                                    user actions and can only be closed programmatically, so any required function
 265                                    should be called by the same code after it closes the dialog.
 266 icon              String           A CSS class that provides a background image to be used as an icon for
 267                                    the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')
 268 maxWidth          Number           The maximum width in pixels of the message box (defaults to 600)
 269 minWidth          Number           The minimum width in pixels of the message box (defaults to 100)
 270 modal             Boolean          False to allow user interaction with the page while the message box is
 271                                    displayed (defaults to true)
 272 msg               String           A string that will replace the existing message box body text (defaults
 273                                    to the XHTML-compliant non-breaking space character '&#160;')
 274 multiline         Boolean          True to prompt the user to enter multi-line text (defaults to false)
 275 progress          Boolean          True to display a progress bar (defaults to false)
 276 progressText      String           The text to display inside the progress bar if progress = true (defaults to '')
 277 prompt            Boolean          True to prompt the user to enter single-line text (defaults to false)
 278 proxyDrag         Boolean          True to display a lightweight proxy while dragging (defaults to false)
 279 title             String           The title text
 280 value             String           The string value to set into the active textbox element if displayed
 281 wait              Boolean          True to display a progress bar (defaults to false)
 282 width             Number           The width of the dialog in pixels
 283 </pre>
 284          *
 285          * Example usage:
 286          * <pre><code>
 287 Roo.Msg.show({
 288    title: 'Address',
 289    msg: 'Please enter your address:',
 290    width: 300,
 291    buttons: Roo.MessageBox.OKCANCEL,
 292    multiline: true,
 293    fn: saveAddress,
 294    animEl: 'addAddressBtn'
 295 });
 296 </code></pre>
 297          * @param {Object} config Configuration options
 298          * @return {Roo.MessageBox} This message box
 299          */
 300         show : function(options)
 301         {
 302
 303             // this causes nightmares if you show one dialog after another
 304             // especially on callbacks..
 305
 306             if(this.isVisible()){
 307
 308                 this.hide();
 309                 Roo.log("[Roo.Messagebox] Show called while message displayed:" );
 310                 Roo.log("Old Dialog Message:" +  msgEl.innerHTML );
 311                 Roo.log("New Dialog Message:" +  options.msg )
 312                 //this.alert("ERROR", "Multiple dialogs where displayed at the same time");
 313                 //throw "Roo.MessageBox ERROR : Multiple dialogs where displayed at the same time";
 314
 315             }
 316             var d = this.getDialog();
 317             opt = options;
 318             d.setTitle(opt.title || "&#160;");
 319             d.close.setDisplayed(opt.closable !== false);
 320             activeTextEl = textboxEl;
 321             opt.prompt = opt.prompt || (opt.multiline ? true : false);
 322             if(opt.prompt){
 323                 if(opt.multiline){
 324                     textboxEl.hide();
 325                     textareaEl.show();
 326                     textareaEl.setHeight(typeof opt.multiline == "number" ?
 327                         opt.multiline : this.defaultTextHeight);
 328                     activeTextEl = textareaEl;
 329                 }else{
 330                     textboxEl.show();
 331                     textareaEl.hide();
 332                 }
 333             }else{
 334                 textboxEl.hide();
 335                 textareaEl.hide();
 336             }
 337             progressEl.setDisplayed(opt.progress === true);
 338             this.updateProgress(0);
 339             activeTextEl.dom.value = opt.value || "";
 340             if(opt.prompt){
 341                 dlg.setDefaultButton(activeTextEl);
 342             }else{
 343                 var bs = opt.buttons;
 344                 var db = null;
 345                 if(bs && bs.ok){
 346                     db = buttons["ok"];
 347                 }else if(bs && bs.yes){
 348                     db = buttons["yes"];
 349                 }
 350                 dlg.setDefaultButton(db);
 351             }
 352             bwidth = updateButtons(opt.buttons);
 353             this.updateText(opt.msg);
 354             if(opt.cls){
 355                 d.el.addClass(opt.cls);
 356             }
 357             d.proxyDrag = opt.proxyDrag === true;
 358             d.modal = opt.modal !== false;
 359             d.mask = opt.modal !== false ? mask : false;
 360             if(!d.isVisible()){
 361                 // force it to the end of the z-index stack so it gets a cursor in FF
 362                 document.body.appendChild(dlg.el.dom);
 363                 d.animateTarget = null;
 364                 d.show(options.animEl);
 365             }
 366             return this;
 367         },
 368
 369         /**
 370          * Displays a message box with a progress bar.  This message box has no buttons and is not closeable by
 371          * the user.  You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}
 372          * and closing the message box when the process is complete.
 373          * @param {String} title The title bar text
 374          * @param {String} msg The message box body text
 375          * @return {Roo.MessageBox} This message box
 376          */
 377         progress : function(title, msg){
 378             this.show({
 379                 title : title,
 380                 msg : msg,
 381                 buttons: false,
 382                 progress:true,
 383                 closable:false,
 384                 minWidth: this.minProgressWidth,
 385                 modal : true
 386             });
 387             return this;
 388         },
 389
 390         /**
 391          * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).
 392          * If a callback function is passed it will be called after the user clicks the button, and the
 393          * id of the button that was clicked will be passed as the only parameter to the callback
 394          * (could also be the top-right close button).
 395          * @param {String} title The title bar text
 396          * @param {String} msg The message box body text
 397          * @param {Function} fn (optional) The callback function invoked after the message box is closed
 398          * @param {Object} scope (optional) The scope of the callback function
 399          * @return {Roo.MessageBox} This message box
 400          */
 401         alert : function(title, msg, fn, scope){
 402             this.show({
 403                 title : title,
 404                 msg : msg,
 405                 buttons: this.OK,
 406                 fn: fn,
 407                 scope : scope,
 408                 modal : true
 409             });
 410             return this;
 411         },
 412
 413         /**
 414          * Displays a message box with an infinitely auto-updating progress bar.  This can be used to block user
 415          * interaction while waiting for a long-running process to complete that does not have defined intervals.
 416          * You are responsible for closing the message box when the process is complete.
 417          * @param {String} msg The message box body text
 418          * @param {String} title (optional) The title bar text
 419          * @return {Roo.MessageBox} This message box
 420          */
 421         wait : function(msg, title){
 422             this.show({
 423                 title : title,
 424                 msg : msg,
 425                 buttons: false,
 426                 closable:false,
 427                 progress:true,
 428                 modal:true,
 429                 width:300,
 430                 wait:true
 431             });
 432             waitTimer = Roo.TaskMgr.start({
 433                 run: function(i){
 434                     Roo.MessageBox.updateProgress(((((i+20)%20)+1)*5)*.01);
 435                 },
 436                 interval: 1000
 437             });
 438             return this;
 439         },
 440
 441         /**
 442          * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).
 443          * If a callback function is passed it will be called after the user clicks either button, and the id of the
 444          * button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).
 445          * @param {String} title The title bar text
 446          * @param {String} msg The message box body text
 447          * @param {Function} fn (optional) The callback function invoked after the message box is closed
 448          * @param {Object} scope (optional) The scope of the callback function
 449          * @return {Roo.MessageBox} This message box
 450          */
 451         confirm : function(title, msg, fn, scope){
 452             this.show({
 453                 title : title,
 454                 msg : msg,
 455                 buttons: this.YESNO,
 456                 fn: fn,
 457                 scope : scope,
 458                 modal : true
 459             });
 460             return this;
 461         },
 462
 463         /**
 464          * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to
 465          * JavaScript's Window.prompt).  The prompt can be a single-line or multi-line textbox.  If a callback function
 466          * is passed it will be called after the user clicks either button, and the id of the button that was clicked
 467          * (could also be the top-right close button) and the text that was entered will be passed as the two
 468          * parameters to the callback.
 469          * @param {String} title The title bar text
 470          * @param {String} msg The message box body text
 471          * @param {Function} fn (optional) The callback function invoked after the message box is closed
 472          * @param {Object} scope (optional) The scope of the callback function
 473          * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight
 474          * property, or the height in pixels to create the textbox (defaults to false / single-line)
 475          * @return {Roo.MessageBox} This message box
 476          */
 477         prompt : function(title, msg, fn, scope, multiline){
 478             this.show({
 479                 title : title,
 480                 msg : msg,
 481                 buttons: this.OKCANCEL,
 482                 fn: fn,
 483                 minWidth:250,
 484                 scope : scope,
 485                 prompt:true,
 486                 multiline: multiline,
 487                 modal : true
 488             });
 489             return this;
 490         },
 491
 492         /**
 493          * Button config that displays a single OK button
 494          * @type Object
 495          */
 496         OK : {ok:true},
 497         /**
 498          * Button config that displays Yes and No buttons
 499          * @type Object
 500          */
 501         YESNO : {yes:true, no:true},
 502         /**
 503          * Button config that displays OK and Cancel buttons
 504          * @type Object
 505          */
 506         OKCANCEL : {ok:true, cancel:true},
 507         /**
 508          * Button config that displays Yes, No and Cancel buttons
 509          * @type Object
 510          */
 511         YESNOCANCEL : {yes:true, no:true, cancel:true},
 512
 513         /**
 514          * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
 515          * @type Number
 516          */
 517         defaultTextHeight : 75,
 518         /**
 519          * The maximum width in pixels of the message box (defaults to 600)
 520          * @type Number
 521          */
 522         maxWidth : 600,
 523         /**
 524          * The minimum width in pixels of the message box (defaults to 100)
 525          * @type Number
 526          */
 527         minWidth : 100,
 528         /**
 529          * The minimum width in pixels of the message box if it is a progress-style dialog.  This is useful
 530          * for setting a different minimum width than text-only dialogs may need (defaults to 250)
 531          * @type Number
 532          */
 533         minProgressWidth : 250,
 534         /**
 535          * An object containing the default button text strings that can be overriden for localized language support.
 536          * Supported properties are: ok, cancel, yes and no.
 537          * Customize the default text like so: Roo.MessageBox.buttonText.yes = "S?";
 538          * @type Object
 539          */
 540         buttonText : {
 541             ok : "OK",
 542             cancel : "Cancel",
 543             yes : "Yes",
 544             no : "No"
 545         }
 546     };
 547 }();
 548
 549 /**
 550  * Shorthand for {@link Roo.MessageBox}
 551  */
 552 Roo.Msg = Roo.MessageBox;