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

   1 /*
   2  * - LGPL
   3  *
   4  * messagebox - can be used as a replace
   5  *
   6  */
   7 /**
   8  * @class Roo.MessageBox
   9  * Utility class for generating different styles of message boxes.  The alias Roo.Msg can also be used.
  10  * Example usage:
  11  *<pre><code>
  12 // Basic alert:
  13 Roo.Msg.alert('Status', 'Changes saved successfully.');
  14
  15 // Prompt for user data:
  16 Roo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
  17     if (btn == 'ok'){
  18         // process text value...
  19     }
  20 });
  21
  22 // Show a dialog using config options:
  23 Roo.Msg.show({
  24    title:'Save Changes?',
  25    msg: 'Your are closing a tab that has unsaved changes. Would you like to save your changes?',
  26    buttons: Roo.Msg.YESNOCANCEL,
  27    fn: processResult,
  28    animEl: 'elId'
  29 });
  30 </code></pre>
  31  * @singleton
  32  */
  33 Roo.bootstrap.MessageBox = function(){
  34     var dlg, opt, mask, waitTimer;
  35     var bodyEl, msgEl, textboxEl, textareaEl, progressEl, pp;
  36     var buttons, activeTextEl, bwidth;
  37
  38
  39     // private
  40     var handleButton = function(button){
  41         dlg.hide();
  42         Roo.callback(opt.fn, opt.scope||window, [button, activeTextEl.dom.value], 1);
  43     };
  44
  45     // private
  46     var handleHide = function(){
  47         if(opt && opt.cls){
  48             dlg.el.removeClass(opt.cls);
  49         }
  50         //if(waitTimer){
  51         //    Roo.TaskMgr.stop(waitTimer);
  52         //    waitTimer = null;
  53         //}
  54     };
  55
  56     // private
  57     var updateButtons = function(b){
  58         var width = 0;
  59         if(!b){
  60             buttons["ok"].hide();
  61             buttons["cancel"].hide();
  62             buttons["yes"].hide();
  63             buttons["no"].hide();
  64             //dlg.footer.dom.style.display = 'none';
  65             return width;
  66         }
  67         dlg.footerEl.dom.style.display = '';
  68         for(var k in buttons){
  69             if(typeof buttons[k] != "function"){
  70                 if(b[k]){
  71                     buttons[k].show();
  72                     buttons[k].setText(typeof b[k] == "string" ? b[k] : Roo.bootstrap.MessageBox.buttonText[k]);
  73                     width += buttons[k].el.getWidth()+15;
  74                 }else{
  75                     buttons[k].hide();
  76                 }
  77             }
  78         }
  79         return width;
  80     };
  81
  82     // private
  83     var handleEsc = function(d, k, e){
  84         if(opt && opt.closable !== false){
  85             dlg.hide();
  86         }
  87         if(e){
  88             e.stopEvent();
  89         }
  90     };
  91
  92     return {
  93         /**
  94          * Returns a reference to the underlying {@link Roo.BasicDialog} element
  95          * @return {Roo.BasicDialog} The BasicDialog element
  96          */
  97         getDialog : function(){
  98            if(!dlg){
  99                 dlg = new Roo.bootstrap.Modal( {
 100                     //draggable: true,
 101                     //resizable:false,
 102                     //constraintoviewport:false,
 103                     //fixedcenter:true,
 104                     //collapsible : false,
 105                     //shim:true,
 106                     //modal: true,
 107                   //  width:400,
 108                   //  height:100,
 109                     //buttonAlign:"center",
 110                     closeClick : function(){
 111                         if(opt && opt.buttons && opt.buttons.no && !opt.buttons.cancel){
 112                             handleButton("no");
 113                         }else{
 114                             handleButton("cancel");
 115                         }
 116                     }
 117                 });
 118                 dlg.render();
 119                 dlg.on("hide", handleHide);
 120                 mask = dlg.mask;
 121                 //dlg.addKeyListener(27, handleEsc);
 122                 buttons = {};
 123                 this.buttons = buttons;
 124                 var bt = this.buttonText;
 125                 buttons["ok"] = dlg.addButton(bt["ok"], handleButton.createCallback("ok"));
 126                 buttons["yes"] = dlg.addButton(bt["yes"], handleButton.createCallback("yes"));
 127                 buttons["no"] = dlg.addButton(bt["no"], handleButton.createCallback("no"));
 128                 buttons["cancel"] = dlg.addButton(bt["cancel"], handleButton.createCallback("cancel"));
 129                 //Roo.log(buttons);
 130                 bodyEl = dlg.bodyEl.createChild({
 131
 132                     html:'<span class="roo-mb-text"></span><br /><input type="text" class="roo-mb-input" />' +
 133                         '<textarea class="roo-mb-textarea"></textarea>' +
 134                         '<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
 153                 // This is supposed to be the progessElement.. but I think it's controlling the height of everything..
 154                 //var pf = progressEl.dom.firstChild;
 155                 //if (pf) {
 156                     //pp = Roo.get(pf.firstChild);
 157                     //pp.setHeight(pf.offsetHeight);
 158                 //}
 159
 160             }
 161             return dlg;
 162         },
 163
 164         /**
 165          * Updates the message box body text
 166          * @param {String} text (optional) Replaces the message box element's innerHTML with the specified string (defaults to
 167          * the XHTML-compliant non-breaking space character '&amp;#160;')
 168          * @return {Roo.MessageBox} This message box
 169          */
 170         updateText : function(text)
 171         {
 172             if(!dlg.isVisible() && !opt.width){
 173                 dlg.setWidth(this.maxWidth);
 174                 // dlg.resizeTo(this.maxWidth, 100); // forcing the height breaks long alerts()
 175             }
 176             msgEl.innerHTML = text || '&#160;';
 177
 178             var cw =  Math.max(msgEl.offsetWidth, msgEl.parentNode.scrollWidth);
 179             //Roo.log("guesed size: " + JSON.stringify([cw,msgEl.offsetWidth, msgEl.parentNode.scrollWidth]));
 180             var w = Math.max(
 181                     Math.min(opt.width || cw , this.maxWidth),
 182                     Math.max(opt.minWidth || this.minWidth, bwidth)
 183             );
 184             if(opt.prompt){
 185                 activeTextEl.setWidth(w);
 186             }
 187             if(dlg.isVisible()){
 188                 dlg.fixedcenter = false;
 189             }
 190             // to big, make it scroll. = But as usual stupid IE does not support
 191             // !important..
 192
 193             if ( bodyEl.getHeight() > (Roo.lib.Dom.getViewHeight() - 100)) {
 194                 bodyEl.setHeight ( Roo.lib.Dom.getViewHeight() - 100 );
 195                 bodyEl.dom.style.overflowY = 'auto' + ( Roo.isIE ? '' : ' !important');
 196             } else {
 197                 bodyEl.dom.style.height = '';
 198                 bodyEl.dom.style.overflowY = '';
 199             }
 200             if (cw > w) {
 201                 bodyEl.dom.style.get = 'auto' + ( Roo.isIE ? '' : ' !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("[Roo.Messagebox] Show called while message displayed:" );
 314                 Roo.log("Old Dialog Message:" +  msgEl.innerHTML );
 315                 Roo.log("New Dialog Message:" +  options.msg )
 316                 //this.alert("ERROR", "Multiple dialogs where displayed at the same time");
 317                 //throw "Roo.MessageBox ERROR : Multiple dialogs where displayed at the same time";
 318
 319             }
 320             var d = this.getDialog();
 321             opt = options;
 322             d.setTitle(opt.title || "&#160;");
 323             d.closeEl.setDisplayed(opt.closable !== false);
 324             activeTextEl = textboxEl;
 325             opt.prompt = opt.prompt || (opt.multiline ? true : false);
 326             if(opt.prompt){
 327                 if(opt.multiline){
 328                     textboxEl.hide();
 329                     textareaEl.show();
 330                     textareaEl.setHeight(typeof opt.multiline == "number" ?
 331                         opt.multiline : this.defaultTextHeight);
 332                     activeTextEl = textareaEl;
 333                 }else{
 334                     textboxEl.show();
 335                     textareaEl.hide();
 336                 }
 337             }else{
 338                 textboxEl.hide();
 339                 textareaEl.hide();
 340             }
 341             progressEl.setDisplayed(opt.progress === true);
 342             this.updateProgress(0);
 343             activeTextEl.dom.value = opt.value || "";
 344             if(opt.prompt){
 345                 dlg.setDefaultButton(activeTextEl);
 346             }else{
 347                 var bs = opt.buttons;
 348                 var db = null;
 349                 if(bs && bs.ok){
 350                     db = buttons["ok"];
 351                 }else if(bs && bs.yes){
 352                     db = buttons["yes"];
 353                 }
 354                 dlg.setDefaultButton(db);
 355             }
 356             bwidth = updateButtons(opt.buttons);
 357             this.updateText(opt.msg);
 358             if(opt.cls){
 359                 d.el.addClass(opt.cls);
 360             }
 361             d.proxyDrag = opt.proxyDrag === true;
 362             d.modal = opt.modal !== false;
 363             d.mask = opt.modal !== false ? mask : false;
 364             if(!d.isVisible()){
 365                 // force it to the end of the z-index stack so it gets a cursor in FF
 366                 document.body.appendChild(dlg.el.dom);
 367                 d.animateTarget = null;
 368                 d.show(options.animEl);
 369             }
 370             return this;
 371         },
 372
 373         /**
 374          * Displays a message box with a progress bar.  This message box has no buttons and is not closeable by
 375          * the user.  You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}
 376          * and closing the message box when the process is complete.
 377          * @param {String} title The title bar text
 378          * @param {String} msg The message box body text
 379          * @return {Roo.MessageBox} This message box
 380          */
 381         progress : function(title, msg){
 382             this.show({
 383                 title : title,
 384                 msg : msg,
 385                 buttons: false,
 386                 progress:true,
 387                 closable:false,
 388                 minWidth: this.minProgressWidth,
 389                 modal : true
 390             });
 391             return this;
 392         },
 393
 394         /**
 395          * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).
 396          * If a callback function is passed it will be called after the user clicks the button, and the
 397          * id of the button that was clicked will be passed as the only parameter to the callback
 398          * (could also be the top-right close button).
 399          * @param {String} title The title bar text
 400          * @param {String} msg The message box body text
 401          * @param {Function} fn (optional) The callback function invoked after the message box is closed
 402          * @param {Object} scope (optional) The scope of the callback function
 403          * @return {Roo.MessageBox} This message box
 404          */
 405         alert : function(title, msg, fn, scope){
 406             this.show({
 407                 title : title,
 408                 msg : msg,
 409                 buttons: this.OK,
 410                 fn: fn,
 411                 closeable : false,
 412                 scope : scope,
 413                 modal : true
 414             });
 415             return this;
 416         },
 417
 418         /**
 419          * Displays a message box with an infinitely auto-updating progress bar.  This can be used to block user
 420          * interaction while waiting for a long-running process to complete that does not have defined intervals.
 421          * You are responsible for closing the message box when the process is complete.
 422          * @param {String} msg The message box body text
 423          * @param {String} title (optional) The title bar text
 424          * @return {Roo.MessageBox} This message box
 425          */
 426         wait : function(msg, title){
 427             this.show({
 428                 title : title,
 429                 msg : msg,
 430                 buttons: false,
 431                 closable:false,
 432                 progress:true,
 433                 modal:true,
 434                 width:300,
 435                 wait:true
 436             });
 437             waitTimer = Roo.TaskMgr.start({
 438                 run: function(i){
 439                     Roo.MessageBox.updateProgress(((((i+20)%20)+1)*5)*.01);
 440                 },
 441                 interval: 1000
 442             });
 443             return this;
 444         },
 445
 446         /**
 447          * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).
 448          * If a callback function is passed it will be called after the user clicks either button, and the id of the
 449          * button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).
 450          * @param {String} title The title bar text
 451          * @param {String} msg The message box body text
 452          * @param {Function} fn (optional) The callback function invoked after the message box is closed
 453          * @param {Object} scope (optional) The scope of the callback function
 454          * @return {Roo.MessageBox} This message box
 455          */
 456         confirm : function(title, msg, fn, scope){
 457             this.show({
 458                 title : title,
 459                 msg : msg,
 460                 buttons: this.YESNO,
 461                 fn: fn,
 462                 scope : scope,
 463                 modal : true
 464             });
 465             return this;
 466         },
 467
 468         /**
 469          * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to
 470          * JavaScript's Window.prompt).  The prompt can be a single-line or multi-line textbox.  If a callback function
 471          * is passed it will be called after the user clicks either button, and the id of the button that was clicked
 472          * (could also be the top-right close button) and the text that was entered will be passed as the two
 473          * parameters to the callback.
 474          * @param {String} title The title bar text
 475          * @param {String} msg The message box body text
 476          * @param {Function} fn (optional) The callback function invoked after the message box is closed
 477          * @param {Object} scope (optional) The scope of the callback function
 478          * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight
 479          * property, or the height in pixels to create the textbox (defaults to false / single-line)
 480          * @return {Roo.MessageBox} This message box
 481          */
 482         prompt : function(title, msg, fn, scope, multiline){
 483             this.show({
 484                 title : title,
 485                 msg : msg,
 486                 buttons: this.OKCANCEL,
 487                 fn: fn,
 488                 minWidth:250,
 489                 scope : scope,
 490                 prompt:true,
 491                 multiline: multiline,
 492                 modal : true
 493             });
 494             return this;
 495         },
 496
 497         /**
 498          * Button config that displays a single OK button
 499          * @type Object
 500          */
 501         OK : {ok:true},
 502         /**
 503          * Button config that displays Yes and No buttons
 504          * @type Object
 505          */
 506         YESNO : {yes:true, no:true},
 507         /**
 508          * Button config that displays OK and Cancel buttons
 509          * @type Object
 510          */
 511         OKCANCEL : {ok:true, cancel:true},
 512         /**
 513          * Button config that displays Yes, No and Cancel buttons
 514          * @type Object
 515          */
 516         YESNOCANCEL : {yes:true, no:true, cancel:true},
 517
 518         /**
 519          * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
 520          * @type Number
 521          */
 522         defaultTextHeight : 75,
 523         /**
 524          * The maximum width in pixels of the message box (defaults to 600)
 525          * @type Number
 526          */
 527         maxWidth : 600,
 528         /**
 529          * The minimum width in pixels of the message box (defaults to 100)
 530          * @type Number
 531          */
 532         minWidth : 100,
 533         /**
 534          * The minimum width in pixels of the message box if it is a progress-style dialog.  This is useful
 535          * for setting a different minimum width than text-only dialogs may need (defaults to 250)
 536          * @type Number
 537          */
 538         minProgressWidth : 250,
 539         /**
 540          * An object containing the default button text strings that can be overriden for localized language support.
 541          * Supported properties are: ok, cancel, yes and no.
 542          * Customize the default text like so: Roo.MessageBox.buttonText.yes = "S?";
 543          * @type Object
 544          */
 545         buttonText : {
 546             ok : "OK",
 547             cancel : "Cancel",
 548             yes : "Yes",
 549             no : "No"
 550         }
 551     };
 552 }();
 553
 554 /**
 555  * Shorthand for {@link Roo.MessageBox}
 556  */
 557 Roo.MessageBox = Roo.MessageBox || Roo.bootstrap.MessageBox;
 558 Roo.Msg = Roo.Msg || Roo.MessageBox;