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