source: trunk/web/addons/job_monarch/lib/extjs/source/widgets/MessageBox.js @ 619

Last change on this file since 619 was 619, checked in by ramonb, 15 years ago

lib/:

  • added new AJAX dependancies: ExtJS, pChart, Lightbox2
File size: 27.4 KB
Line 
1/*
2 * Ext JS Library 2.2.1
3 * Copyright(c) 2006-2009, Ext JS, LLC.
4 * licensing@extjs.com
5 *
6 * http://extjs.com/license
7 */
8
9/**
10 * @class Ext.MessageBox
11 * <p>Utility class for generating different styles of message boxes.  The alias Ext.Msg can also be used.<p/>
12 * <p>Note that the MessageBox is asynchronous.  Unlike a regular JavaScript <code>alert</code> (which will halt
13 * browser execution), showing a MessageBox will not cause the code to stop.  For this reason, if you have code
14 * that should only run <em>after</em> some user feedback from the MessageBox, you must use a callback function
15 * (see the <code>function</code> parameter for {@link #show} for more details).</p>
16 * <p>Example usage:</p>
17 *<pre><code>
18// Basic alert:
19Ext.Msg.alert('Status', 'Changes saved successfully.');
20
21// Prompt for user data and process the result using a callback:
22Ext.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
23    if (btn == 'ok'){
24        // process text value and close...
25    }
26});
27
28// Show a dialog using config options:
29Ext.Msg.show({
30   title:'Save Changes?',
31   msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?',
32   buttons: Ext.Msg.YESNOCANCEL,
33   fn: processResult,
34   animEl: 'elId',
35   icon: Ext.MessageBox.QUESTION
36});
37</code></pre>
38 * @singleton
39 */
40Ext.MessageBox = function(){
41    var dlg, opt, mask, waitTimer;
42    var bodyEl, msgEl, textboxEl, textareaEl, progressBar, pp, iconEl, spacerEl;
43    var buttons, activeTextEl, bwidth, iconCls = '';
44
45    // private
46    var handleButton = function(button){
47        if(dlg.isVisible()){
48            dlg.hide();
49            Ext.callback(opt.fn, opt.scope||window, [button, activeTextEl.dom.value, opt], 1);
50        }
51    };
52
53    // private
54    var handleHide = function(){
55        if(opt && opt.cls){
56            dlg.el.removeClass(opt.cls);
57        }
58        progressBar.reset();
59    };
60
61    // private
62    var handleEsc = function(d, k, e){
63        if(opt && opt.closable !== false){
64            dlg.hide();
65        }
66        if(e){
67            e.stopEvent();
68        }
69    };
70
71    // private
72    var updateButtons = function(b){
73        var width = 0;
74        if(!b){
75            buttons["ok"].hide();
76            buttons["cancel"].hide();
77            buttons["yes"].hide();
78            buttons["no"].hide();
79            return width;
80        }
81        dlg.footer.dom.style.display = '';
82        for(var k in buttons){
83            if(typeof buttons[k] != "function"){
84                if(b[k]){
85                    buttons[k].show();
86                    buttons[k].setText(typeof b[k] == "string" ? b[k] : Ext.MessageBox.buttonText[k]);
87                    width += buttons[k].el.getWidth()+15;
88                }else{
89                    buttons[k].hide();
90                }
91            }
92        }
93        return width;
94    };
95
96    return {
97        /**
98         * Returns a reference to the underlying {@link Ext.Window} element
99         * @return {Ext.Window} The window
100         */
101        getDialog : function(titleText){
102           if(!dlg){
103                dlg = new Ext.Window({
104                    autoCreate : true,
105                    title:titleText,
106                    resizable:false,
107                    constrain:true,
108                    constrainHeader:true,
109                    minimizable : false,
110                    maximizable : false,
111                    stateful: false,
112                    modal: true,
113                    shim:true,
114                    buttonAlign:"center",
115                    width:400,
116                    height:100,
117                    minHeight: 80,
118                    plain:true,
119                    footer:true,
120                    closable:true,
121                    close : function(){
122                        if(opt && opt.buttons && opt.buttons.no && !opt.buttons.cancel){
123                            handleButton("no");
124                        }else{
125                            handleButton("cancel");
126                        }
127                    }
128                });
129                buttons = {};
130                var bt = this.buttonText;
131                //TODO: refactor this block into a buttons config to pass into the Window constructor
132                buttons["ok"] = dlg.addButton(bt["ok"], handleButton.createCallback("ok"));
133                buttons["yes"] = dlg.addButton(bt["yes"], handleButton.createCallback("yes"));
134                buttons["no"] = dlg.addButton(bt["no"], handleButton.createCallback("no"));
135                buttons["cancel"] = dlg.addButton(bt["cancel"], handleButton.createCallback("cancel"));
136                buttons["ok"].hideMode = buttons["yes"].hideMode = buttons["no"].hideMode = buttons["cancel"].hideMode = 'offsets';
137                dlg.render(document.body);
138                dlg.getEl().addClass('x-window-dlg');
139                mask = dlg.mask;
140                bodyEl = dlg.body.createChild({
141                    html:'<div class="ext-mb-icon"></div><div class="ext-mb-content"><span class="ext-mb-text"></span><br /><div class="ext-mb-fix-cursor"><input type="text" class="ext-mb-input" /><textarea class="ext-mb-textarea"></textarea></div></div>'
142                });
143                iconEl = Ext.get(bodyEl.dom.firstChild);
144                var contentEl = bodyEl.dom.childNodes[1];
145                msgEl = Ext.get(contentEl.firstChild);
146                textboxEl = Ext.get(contentEl.childNodes[2].firstChild);
147                textboxEl.enableDisplayMode();
148                textboxEl.addKeyListener([10,13], function(){
149                    if(dlg.isVisible() && opt && opt.buttons){
150                        if(opt.buttons.ok){
151                            handleButton("ok");
152                        }else if(opt.buttons.yes){
153                            handleButton("yes");
154                        }
155                    }
156                });
157                textareaEl = Ext.get(contentEl.childNodes[2].childNodes[1]);
158                textareaEl.enableDisplayMode();
159                progressBar = new Ext.ProgressBar({
160                    renderTo:bodyEl
161                });
162               bodyEl.createChild({cls:'x-clear'});
163            }
164            return dlg;
165        },
166
167        /**
168         * Updates the message box body text
169         * @param {String} text (optional) Replaces the message box element's innerHTML with the specified string (defaults to
170         * the XHTML-compliant non-breaking space character '&amp;#160;')
171         * @return {Ext.MessageBox} this
172         */
173        updateText : function(text){
174            if(!dlg.isVisible() && !opt.width){
175                dlg.setSize(this.maxWidth, 100); // resize first so content is never clipped from previous shows
176            }
177            msgEl.update(text || '&#160;');
178
179            var iw = iconCls != '' ? (iconEl.getWidth() + iconEl.getMargins('lr')) : 0;
180            var mw = msgEl.getWidth() + msgEl.getMargins('lr');
181            var fw = dlg.getFrameWidth('lr');
182            var bw = dlg.body.getFrameWidth('lr');
183            if (Ext.isIE && iw > 0){
184                //3 pixels get subtracted in the icon CSS for an IE margin issue,
185                //so we have to add it back here for the overall width to be consistent
186                iw += 3;
187            }
188            var w = Math.max(Math.min(opt.width || iw+mw+fw+bw, this.maxWidth),
189                        Math.max(opt.minWidth || this.minWidth, bwidth || 0));
190
191            if(opt.prompt === true){
192                activeTextEl.setWidth(w-iw-fw-bw);
193            }
194            if(opt.progress === true || opt.wait === true){
195                progressBar.setSize(w-iw-fw-bw);
196            }
197            if(Ext.isIE && w == bwidth){
198                w += 4; //Add offset when the content width is smaller than the buttons.   
199            }
200            dlg.setSize(w, 'auto').center();
201            return this;
202        },
203
204        /**
205         * Updates a progress-style message box's text and progress bar. Only relevant on message boxes
206         * initiated via {@link Ext.MessageBox#progress} or {@link Ext.MessageBox#wait},
207         * or by calling {@link Ext.MessageBox#show} with progress: true.
208         * @param {Number} value Any number between 0 and 1 (e.g., .5, defaults to 0)
209         * @param {String} progressText The progress text to display inside the progress bar (defaults to '')
210         * @param {String} msg The message box's body text is replaced with the specified string (defaults to undefined
211         * so that any existing body text will not get overwritten by default unless a new value is passed in)
212         * @return {Ext.MessageBox} this
213         */
214        updateProgress : function(value, progressText, msg){
215            progressBar.updateProgress(value, progressText);
216            if(msg){
217                this.updateText(msg);
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         * @return {Ext.MessageBox} this
233         */
234        hide : function(){
235            var proxy = dlg.activeGhost;
236            if(this.isVisible() || proxy) {
237                dlg.hide();
238                handleHide();
239                if (proxy) {
240                    proxy.hide();
241                } 
242            }
243            return this;
244        },
245
246        /**
247         * Displays a new message box, or reinitializes an existing message box, based on the config options
248         * passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,
249         * although those calls are basic shortcuts and do not support all of the config options allowed here.
250         * @param {Object} config The following config options are supported: <ul>
251         * <li><b>animEl</b> : String/Element<div class="sub-desc">An id or Element from which the message box should animate as it
252         * opens and closes (defaults to undefined)</div></li>
253         * <li><b>buttons</b> : Object/Boolean<div class="sub-desc">A button config object (e.g., Ext.MessageBox.OKCANCEL or {ok:'Foo',
254         * cancel:'Bar'}), or false to not show any buttons (defaults to false)</div></li>
255         * <li><b>closable</b> : Boolean<div class="sub-desc">False to hide the top-right close button (defaults to true). Note that
256         * progress and wait dialogs will ignore this property and always hide the close button as they can only
257         * be closed programmatically.</div></li>
258         * <li><b>cls</b> : String<div class="sub-desc">A custom CSS class to apply to the message box's container element</div></li>
259         * <li><b>defaultTextHeight</b> : Number<div class="sub-desc">The default height in pixels of the message box's multiline textarea
260         * if displayed (defaults to 75)</div></li>
261         * <li><b>fn</b> : Function<div class="sub-desc">A callback function which is called when the dialog is dismissed either
262         * by clicking on the configured buttons, or on the dialog close button, or by pressing
263         * the return button to enter input.
264         * <p>Progress and wait dialogs will ignore this option since they do not respond to user
265         * actions and can only be closed programmatically, so any required function should be called
266         * by the same code after it closes the dialog. Parameters passed:<ul>
267         * <li><b>buttonId</b> : String<div class="sub-desc">The ID of the button pressed, one of:<div class="sub-desc"><ul>
268         * <li><tt>ok</tt></li>
269         * <li><tt>yes</tt></li>
270         * <li><tt>no</tt></li>
271         * <li><tt>cancel</tt></li>
272         * </ul></div></div></li>
273         * <li><b>text</b> : String<div class="sub-desc">Value of the input field if either <tt><a href="#show-option-prompt" ext:member="show-option-prompt" ext:cls="Ext.MessageBox">prompt</a></tt>
274         * or <tt><a href="#show-option-multiline" ext:member="show-option-multiline" ext:cls="Ext.MessageBox">multiline</a></tt> is true</div></li>
275         * <li><b>opt</b> : Object<div class="sub-desc">The config object passed to show.</div></li>
276         * </ul></p></div></li>
277         * <li><b>scope</b> : Object<div class="sub-desc">The scope of the callback function</div></li>
278         * <li><b>icon</b> : String<div class="sub-desc">A CSS class that provides a background image to be used as the body icon for the
279         * dialog (e.g. Ext.MessageBox.WARNING or 'custom-class') (defaults to '')</div></li>
280         * <li><b>iconCls</b> : String<div class="sub-desc">The standard {@link Ext.Window#iconCls} to
281         * add an optional header icon (defaults to '')</div></li>
282         * <li><b>maxWidth</b> : Number<div class="sub-desc">The maximum width in pixels of the message box (defaults to 600)</div></li>
283         * <li><b>minWidth</b> : Number<div class="sub-desc">The minimum width in pixels of the message box (defaults to 100)</div></li>
284         * <li><b>modal</b> : Boolean<div class="sub-desc">False to allow user interaction with the page while the message box is
285         * displayed (defaults to true)</div></li>
286         * <li><b>msg</b> : String<div class="sub-desc">A string that will replace the existing message box body text (defaults to the
287         * XHTML-compliant non-breaking space character '&amp;#160;')</div></li>
288         * <li><a id="show-option-multiline"></a><b>multiline</b> : Boolean<div class="sub-desc">
289         * True to prompt the user to enter multi-line text (defaults to false)</div></li>
290         * <li><b>progress</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
291         * <li><b>progressText</b> : String<div class="sub-desc">The text to display inside the progress bar if progress = true (defaults to '')</div></li>
292         * <li><a id="show-option-prompt"></a><b>prompt</b> : Boolean<div class="sub-desc">True to prompt the user to enter single-line text (defaults to false)</div></li>
293         * <li><b>proxyDrag</b> : Boolean<div class="sub-desc">True to display a lightweight proxy while dragging (defaults to false)</div></li>
294         * <li><b>title</b> : String<div class="sub-desc">The title text</div></li>
295         * <li><b>value</b> : String<div class="sub-desc">The string value to set into the active textbox element if displayed</div></li>
296         * <li><b>wait</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
297         * <li><b>waitConfig</b> : Object<div class="sub-desc">A {@link Ext.ProgressBar#waitConfig} object (applies only if wait = true)</div></li>
298         * <li><b>width</b> : Number<div class="sub-desc">The width of the dialog in pixels</div></li>
299         * </ul>
300         * Example usage:
301         * <pre><code>
302Ext.Msg.show({
303   title: 'Address',
304   msg: 'Please enter your address:',
305   width: 300,
306   buttons: Ext.MessageBox.OKCANCEL,
307   multiline: true,
308   fn: saveAddress,
309   animEl: 'addAddressBtn',
310   icon: Ext.MessageBox.INFO
311});
312</code></pre>
313         * @return {Ext.MessageBox} this
314         */
315        show : function(options){
316            if(this.isVisible()){
317                this.hide();
318            }
319            opt = options;
320            var d = this.getDialog(opt.title || "&#160;");
321
322            d.setTitle(opt.title || "&#160;");
323            var allowClose = (opt.closable !== false && opt.progress !== true && opt.wait !== true);
324            d.tools.close.setDisplayed(allowClose);
325            activeTextEl = textboxEl;
326            opt.prompt = opt.prompt || (opt.multiline ? true : false);
327            if(opt.prompt){
328                if(opt.multiline){
329                    textboxEl.hide();
330                    textareaEl.show();
331                    textareaEl.setHeight(typeof opt.multiline == "number" ?
332                        opt.multiline : this.defaultTextHeight);
333                    activeTextEl = textareaEl;
334                }else{
335                    textboxEl.show();
336                    textareaEl.hide();
337                }
338            }else{
339                textboxEl.hide();
340                textareaEl.hide();
341            }
342            activeTextEl.dom.value = opt.value || "";
343            if(opt.prompt){
344                d.focusEl = activeTextEl;
345            }else{
346                var bs = opt.buttons;
347                var db = null;
348                if(bs && bs.ok){
349                    db = buttons["ok"];
350                }else if(bs && bs.yes){
351                    db = buttons["yes"];
352                }
353                if (db){
354                    d.focusEl = db;
355                }
356            }
357            if(opt.iconCls){
358              d.setIconClass(opt.iconCls);
359            }
360            this.setIcon(opt.icon);
361            bwidth = updateButtons(opt.buttons);
362            progressBar.setVisible(opt.progress === true || opt.wait === true);
363            this.updateProgress(0, opt.progressText);
364            this.updateText(opt.msg);
365            if(opt.cls){
366                d.el.addClass(opt.cls);
367            }
368            d.proxyDrag = opt.proxyDrag === true;
369            d.modal = opt.modal !== false;
370            d.mask = opt.modal !== false ? mask : false;
371            if(!d.isVisible()){
372                // force it to the end of the z-index stack so it gets a cursor in FF
373                document.body.appendChild(dlg.el.dom);
374                d.setAnimateTarget(opt.animEl);
375                d.show(opt.animEl);
376            }
377
378            //workaround for window internally enabling keymap in afterShow
379            d.on('show', function(){
380                if(allowClose === true){
381                    d.keyMap.enable();
382                }else{
383                    d.keyMap.disable();
384                }
385            }, this, {single:true});
386
387            if(opt.wait === true){
388                progressBar.wait(opt.waitConfig);
389            }
390            return this;
391        },
392
393        /**
394         * Adds the specified icon to the dialog.  By default, the class 'ext-mb-icon' is applied for default
395         * styling, and the class passed in is expected to supply the background image url. Pass in empty string ('')
396         * to clear any existing icon.  The following built-in icon classes are supported, but you can also pass
397         * in a custom class name:
398         * <pre>
399Ext.MessageBox.INFO
400Ext.MessageBox.WARNING
401Ext.MessageBox.QUESTION
402Ext.MessageBox.ERROR
403         *</pre>
404         * @param {String} icon A CSS classname specifying the icon's background image url, or empty string to clear the icon
405         * @return {Ext.MessageBox} this
406         */
407        setIcon : function(icon){
408            if(icon && icon != ''){
409                iconEl.removeClass('x-hidden');
410                iconEl.replaceClass(iconCls, icon);
411                iconCls = icon;
412            }else{
413                iconEl.replaceClass(iconCls, 'x-hidden');
414                iconCls = '';
415            }
416            return this;
417        },
418
419        /**
420         * Displays a message box with a progress bar.  This message box has no buttons and is not closeable by
421         * the user.  You are responsible for updating the progress bar as needed via {@link Ext.MessageBox#updateProgress}
422         * and closing the message box when the process is complete.
423         * @param {String} title The title bar text
424         * @param {String} msg The message box body text
425         * @param {String} progressText (optional) The text to display inside the progress bar (defaults to '')
426         * @return {Ext.MessageBox} this
427         */
428        progress : function(title, msg, progressText){
429            this.show({
430                title : title,
431                msg : msg,
432                buttons: false,
433                progress:true,
434                closable:false,
435                minWidth: this.minProgressWidth,
436                progressText: progressText
437            });
438            return this;
439        },
440
441        /**
442         * Displays a message box with an infinitely auto-updating progress bar.  This can be used to block user
443         * interaction while waiting for a long-running process to complete that does not have defined intervals.
444         * You are responsible for closing the message box when the process is complete.
445         * @param {String} msg The message box body text
446         * @param {String} title (optional) The title bar text
447         * @param {Object} config (optional) A {@link Ext.ProgressBar#waitConfig} object
448         * @return {Ext.MessageBox} this
449         */
450        wait : function(msg, title, config){
451            this.show({
452                title : title,
453                msg : msg,
454                buttons: false,
455                closable:false,
456                wait:true,
457                modal:true,
458                minWidth: this.minProgressWidth,
459                waitConfig: config
460            });
461            return this;
462        },
463
464        /**
465         * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).
466         * If a callback function is passed it will be called after the user clicks the button, and the
467         * id of the button that was clicked will be passed as the only parameter to the callback
468         * (could also be the top-right close button).
469         * @param {String} title The title bar text
470         * @param {String} msg The message box body text
471         * @param {Function} fn (optional) The callback function invoked after the message box is closed
472         * @param {Object} scope (optional) The scope of the callback function
473         * @return {Ext.MessageBox} this
474         */
475        alert : function(title, msg, fn, scope){
476            this.show({
477                title : title,
478                msg : msg,
479                buttons: this.OK,
480                fn: fn,
481                scope : scope
482            });
483            return this;
484        },
485
486        /**
487         * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).
488         * If a callback function is passed it will be called after the user clicks either button,
489         * and the id of the button that was clicked will be passed as the only parameter to the callback
490         * (could also be the top-right close button).
491         * @param {String} title The title bar text
492         * @param {String} msg The message box body text
493         * @param {Function} fn (optional) The callback function invoked after the message box is closed
494         * @param {Object} scope (optional) The scope of the callback function
495         * @return {Ext.MessageBox} this
496         */
497        confirm : function(title, msg, fn, scope){
498            this.show({
499                title : title,
500                msg : msg,
501                buttons: this.YESNO,
502                fn: fn,
503                scope : scope,
504                icon: this.QUESTION
505            });
506            return this;
507        },
508
509        /**
510         * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).
511         * The prompt can be a single-line or multi-line textbox.  If a callback function is passed it will be called after the user
512         * clicks either button, and the id of the button that was clicked (could also be the top-right
513         * close button) and the text that was entered will be passed as the two parameters to the callback.
514         * @param {String} title The title bar text
515         * @param {String} msg The message box body text
516         * @param {Function} fn (optional) The callback function invoked after the message box is closed
517         * @param {Object} scope (optional) The scope of the callback function
518         * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight
519         * property, or the height in pixels to create the textbox (defaults to false / single-line)
520         * @param {String} value (optional) Default value of the text input element (defaults to '')
521         * @return {Ext.MessageBox} this
522         */
523        prompt : function(title, msg, fn, scope, multiline, value){
524            this.show({
525                title : title,
526                msg : msg,
527                buttons: this.OKCANCEL,
528                fn: fn,
529                minWidth:250,
530                scope : scope,
531                prompt:true,
532                multiline: multiline,
533                value: value
534            });
535            return this;
536        },
537
538        /**
539         * Button config that displays a single OK button
540         * @type Object
541         */
542        OK : {ok:true},
543        /**
544         * Button config that displays a single Cancel button
545         * @type Object
546         */
547        CANCEL : {cancel:true},
548        /**
549         * Button config that displays OK and Cancel buttons
550         * @type Object
551         */
552        OKCANCEL : {ok:true, cancel:true},
553        /**
554         * Button config that displays Yes and No buttons
555         * @type Object
556         */
557        YESNO : {yes:true, no:true},
558        /**
559         * Button config that displays Yes, No and Cancel buttons
560         * @type Object
561         */
562        YESNOCANCEL : {yes:true, no:true, cancel:true},
563        /**
564         * The CSS class that provides the INFO icon image
565         * @type String
566         */
567        INFO : 'ext-mb-info',
568        /**
569         * The CSS class that provides the WARNING icon image
570         * @type String
571         */
572        WARNING : 'ext-mb-warning',
573        /**
574         * The CSS class that provides the QUESTION icon image
575         * @type String
576         */
577        QUESTION : 'ext-mb-question',
578        /**
579         * The CSS class that provides the ERROR icon image
580         * @type String
581         */
582        ERROR : 'ext-mb-error',
583
584        /**
585         * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
586         * @type Number
587         */
588        defaultTextHeight : 75,
589        /**
590         * The maximum width in pixels of the message box (defaults to 600)
591         * @type Number
592         */
593        maxWidth : 600,
594        /**
595         * The minimum width in pixels of the message box (defaults to 100)
596         * @type Number
597         */
598        minWidth : 100,
599        /**
600         * The minimum width in pixels of the message box if it is a progress-style dialog.  This is useful
601         * for setting a different minimum width than text-only dialogs may need (defaults to 250)
602         * @type Number
603         */
604        minProgressWidth : 250,
605        /**
606         * An object containing the default button text strings that can be overriden for localized language support.
607         * Supported properties are: ok, cancel, yes and no.  Generally you should include a locale-specific
608         * resource file for handling language support across the framework.
609         * Customize the default text like so: Ext.MessageBox.buttonText.yes = "oui"; //french
610         * @type Object
611         */
612        buttonText : {
613            ok : "OK",
614            cancel : "Cancel",
615            yes : "Yes",
616            no : "No"
617        }
618    };
619}();
620
621/**
622 * Shorthand for {@link Ext.MessageBox}
623 */
624Ext.Msg = Ext.MessageBox;
Note: See TracBrowser for help on using the repository browser.