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