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

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