3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
8 * @class Ext.MessageBox
9 * <p>Utility class for generating different styles of message boxes. The alias Ext.Msg can also be used.<p/>
10 * <p>Note that the MessageBox is asynchronous. Unlike a regular JavaScript <code>alert</code> (which will halt
11 * browser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code
12 * that should only run <em>after</em> some user feedback from the MessageBox, you must use a callback function
13 * (see the <code>function</code> parameter for {@link #show} for more details).</p>
14 * <p>Example usage:</p>
17 Ext.Msg.alert('Status', 'Changes saved successfully.');
19 // Prompt for user data and process the result using a callback:
20 Ext.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
22 // process text value and close...
26 // Show a dialog using config options:
28 title:'Save Changes?',
29 msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?',
30 buttons: Ext.Msg.YESNOCANCEL,
33 icon: Ext.MessageBox.QUESTION
38 Ext.MessageBox = function(){
39 var dlg, opt, mask, waitTimer;
40 var bodyEl, msgEl, textboxEl, textareaEl, progressBar, pp, iconEl, spacerEl;
41 var buttons, activeTextEl, bwidth, iconCls = '';
44 var handleButton = function(button){
48 Ext.callback(opt.fn, opt.scope||window, [button, activeTextEl.dom.value, opt], 1);
53 var handleHide = function(){
55 dlg.el.removeClass(opt.cls);
61 var handleEsc = function(d, k, e){
62 if(opt && opt.closable !== false){
72 var updateButtons = function(b){
76 buttons["cancel"].hide();
77 buttons["yes"].hide();
81 dlg.footer.dom.style.display = '';
82 for(var k in buttons){
83 if(typeof buttons[k] != "function"){
86 buttons[k].setText(typeof b[k] == "string" ? b[k] : Ext.MessageBox.buttonText[k]);
87 width += buttons[k].el.getWidth()+15;
98 * Returns a reference to the underlying {@link Ext.Window} element
99 * @return {Ext.Window} The window
101 getDialog : function(titleText){
103 dlg = new Ext.Window({
108 constrainHeader:true,
114 buttonAlign:"center",
122 if(opt && opt.buttons && opt.buttons.no && !opt.buttons.cancel){
125 handleButton("cancel");
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');
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>'
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){
152 }else if(opt.buttons.yes){
157 textareaEl = Ext.get(contentEl.childNodes[2].childNodes[1]);
158 textareaEl.enableDisplayMode();
159 progressBar = new Ext.ProgressBar({
162 bodyEl.createChild({cls:'x-clear'});
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 '&#160;')
171 * @return {Ext.MessageBox} this
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
177 msgEl.update(text || ' ');
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
188 var w = Math.max(Math.min(opt.width || iw+mw+fw+bw, this.maxWidth),
189 Math.max(opt.minWidth || this.minWidth, bwidth || 0));
191 if(opt.prompt === true){
192 activeTextEl.setWidth(w-iw-fw-bw);
194 if(opt.progress === true || opt.wait === true){
195 progressBar.setSize(w-iw-fw-bw);
197 if(Ext.isIE && w == bwidth){
198 w += 4; //Add offset when the content width is smaller than the buttons.
200 dlg.setSize(w, 'auto').center();
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
214 updateProgress : function(value, progressText, msg){
215 progressBar.updateProgress(value, progressText);
217 this.updateText(msg);
223 * Returns true if the message box is currently displayed
224 * @return {Boolean} True if the message box is visible, else false
226 isVisible : function(){
227 return dlg && dlg.isVisible();
231 * Hides the message box if it is displayed
232 * @return {Ext.MessageBox} this
235 var proxy = dlg ? dlg.activeGhost : null;
236 if(this.isVisible() || proxy){
240 // unghost is a private function, but i saw no better solution
241 // to fix the locking problem when dragging while it closes
242 dlg.unghost(false, false);
249 * Displays a new message box, or reinitializes an existing message box, based on the config options
250 * passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,
251 * although those calls are basic shortcuts and do not support all of the config options allowed here.
252 * @param {Object} config The following config options are supported: <ul>
253 * <li><b>animEl</b> : String/Element<div class="sub-desc">An id or Element from which the message box should animate as it
254 * opens and closes (defaults to undefined)</div></li>
255 * <li><b>buttons</b> : Object/Boolean<div class="sub-desc">A button config object (e.g., Ext.MessageBox.OKCANCEL or {ok:'Foo',
256 * cancel:'Bar'}), or false to not show any buttons (defaults to false)</div></li>
257 * <li><b>closable</b> : Boolean<div class="sub-desc">False to hide the top-right close button (defaults to true). Note that
258 * progress and wait dialogs will ignore this property and always hide the close button as they can only
259 * be closed programmatically.</div></li>
260 * <li><b>cls</b> : String<div class="sub-desc">A custom CSS class to apply to the message box's container element</div></li>
261 * <li><b>defaultTextHeight</b> : Number<div class="sub-desc">The default height in pixels of the message box's multiline textarea
262 * if displayed (defaults to 75)</div></li>
263 * <li><b>fn</b> : Function<div class="sub-desc">A callback function which is called when the dialog is dismissed either
264 * by clicking on the configured buttons, or on the dialog close button, or by pressing
265 * the return button to enter input.
266 * <p>Progress and wait dialogs will ignore this option since they do not respond to user
267 * actions and can only be closed programmatically, so any required function should be called
268 * by the same code after it closes the dialog. Parameters passed:<ul>
269 * <li><b>buttonId</b> : String<div class="sub-desc">The ID of the button pressed, one of:<div class="sub-desc"><ul>
270 * <li><tt>ok</tt></li>
271 * <li><tt>yes</tt></li>
272 * <li><tt>no</tt></li>
273 * <li><tt>cancel</tt></li>
274 * </ul></div></div></li>
275 * <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>
276 * or <tt><a href="#show-option-multiline" ext:member="show-option-multiline" ext:cls="Ext.MessageBox">multiline</a></tt> is true</div></li>
277 * <li><b>opt</b> : Object<div class="sub-desc">The config object passed to show.</div></li>
278 * </ul></p></div></li>
279 * <li><b>scope</b> : Object<div class="sub-desc">The scope of the callback function</div></li>
280 * <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
281 * dialog (e.g. Ext.MessageBox.WARNING or 'custom-class') (defaults to '')</div></li>
282 * <li><b>iconCls</b> : String<div class="sub-desc">The standard {@link Ext.Window#iconCls} to
283 * add an optional header icon (defaults to '')</div></li>
284 * <li><b>maxWidth</b> : Number<div class="sub-desc">The maximum width in pixels of the message box (defaults to 600)</div></li>
285 * <li><b>minWidth</b> : Number<div class="sub-desc">The minimum width in pixels of the message box (defaults to 100)</div></li>
286 * <li><b>modal</b> : Boolean<div class="sub-desc">False to allow user interaction with the page while the message box is
287 * displayed (defaults to true)</div></li>
288 * <li><b>msg</b> : String<div class="sub-desc">A string that will replace the existing message box body text (defaults to the
289 * XHTML-compliant non-breaking space character '&#160;')</div></li>
290 * <li><a id="show-option-multiline"></a><b>multiline</b> : Boolean<div class="sub-desc">
291 * True to prompt the user to enter multi-line text (defaults to false)</div></li>
292 * <li><b>progress</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
293 * <li><b>progressText</b> : String<div class="sub-desc">The text to display inside the progress bar if progress = true (defaults to '')</div></li>
294 * <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>
295 * <li><b>proxyDrag</b> : Boolean<div class="sub-desc">True to display a lightweight proxy while dragging (defaults to false)</div></li>
296 * <li><b>title</b> : String<div class="sub-desc">The title text</div></li>
297 * <li><b>value</b> : String<div class="sub-desc">The string value to set into the active textbox element if displayed</div></li>
298 * <li><b>wait</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
299 * <li><b>waitConfig</b> : Object<div class="sub-desc">A {@link Ext.ProgressBar#waitConfig} object (applies only if wait = true)</div></li>
300 * <li><b>width</b> : Number<div class="sub-desc">The width of the dialog in pixels</div></li>
306 msg: 'Please enter your address:',
308 buttons: Ext.MessageBox.OKCANCEL,
311 animEl: 'addAddressBtn',
312 icon: Ext.MessageBox.INFO
315 * @return {Ext.MessageBox} this
317 show : function(options){
318 if(this.isVisible()){
322 var d = this.getDialog(opt.title || " ");
324 d.setTitle(opt.title || " ");
325 var allowClose = (opt.closable !== false && opt.progress !== true && opt.wait !== true);
326 d.tools.close.setDisplayed(allowClose);
327 activeTextEl = textboxEl;
328 opt.prompt = opt.prompt || (opt.multiline ? true : false);
333 textareaEl.setHeight(typeof opt.multiline == "number" ?
334 opt.multiline : this.defaultTextHeight);
335 activeTextEl = textareaEl;
344 activeTextEl.dom.value = opt.value || "";
346 d.focusEl = activeTextEl;
348 var bs = opt.buttons;
352 }else if(bs && bs.yes){
360 d.setIconClass(opt.iconCls);
362 this.setIcon(opt.icon);
364 d.el.addClass(opt.cls);
366 d.proxyDrag = opt.proxyDrag === true;
367 d.modal = opt.modal !== false;
368 d.mask = opt.modal !== false ? mask : false;
370 d.on('show', function(){
371 //workaround for window internally enabling keymap in afterShow
372 d.keyMap.setDisabled(allowClose !== true);
374 this.setIcon(opt.icon);
375 bwidth = updateButtons(opt.buttons);
376 progressBar.setVisible(opt.progress === true || opt.wait === true);
377 this.updateProgress(0, opt.progressText);
378 this.updateText(opt.msg);
379 if(opt.wait === true){
380 progressBar.wait(opt.waitConfig);
383 }, this, {single:true});
385 // force it to the end of the z-index stack so it gets a cursor in FF
386 document.body.appendChild(dlg.el.dom);
387 d.setAnimateTarget(opt.animEl);
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:
400 Ext.MessageBox.WARNING
401 Ext.MessageBox.QUESTION
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
407 setIcon : function(icon){
408 if(icon && icon != ''){
409 iconEl.removeClass('x-hidden');
410 iconEl.replaceClass(iconCls, icon);
411 bodyEl.addClass('x-dlg-icon');
414 iconEl.replaceClass(iconCls, 'x-hidden');
415 bodyEl.removeClass('x-dlg-icon');
422 * Displays a message box with a progress bar. This message box has no buttons and is not closeable by
423 * the user. You are responsible for updating the progress bar as needed via {@link Ext.MessageBox#updateProgress}
424 * and closing the message box when the process is complete.
425 * @param {String} title The title bar text
426 * @param {String} msg The message box body text
427 * @param {String} progressText (optional) The text to display inside the progress bar (defaults to '')
428 * @return {Ext.MessageBox} this
430 progress : function(title, msg, progressText){
437 minWidth: this.minProgressWidth,
438 progressText: progressText
444 * Displays a message box with an infinitely auto-updating progress bar. This can be used to block user
445 * interaction while waiting for a long-running process to complete that does not have defined intervals.
446 * You are responsible for closing the message box when the process is complete.
447 * @param {String} msg The message box body text
448 * @param {String} title (optional) The title bar text
449 * @param {Object} config (optional) A {@link Ext.ProgressBar#waitConfig} object
450 * @return {Ext.MessageBox} this
452 wait : function(msg, title, config){
460 minWidth: this.minProgressWidth,
467 * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).
468 * If a callback function is passed it will be called after the user clicks the button, and the
469 * id of the button that was clicked will be passed as the only parameter to the callback
470 * (could also be the top-right close button).
471 * @param {String} title The title bar text
472 * @param {String} msg The message box body text
473 * @param {Function} fn (optional) The callback function invoked after the message box is closed
474 * @param {Object} scope (optional) The scope of the callback function
475 * @return {Ext.MessageBox} this
477 alert : function(title, msg, fn, scope){
489 * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).
490 * If a callback function is passed it will be called after the user clicks either button,
491 * and the id of the button that was clicked will be passed as the only parameter to the callback
492 * (could also be the top-right close button).
493 * @param {String} title The title bar text
494 * @param {String} msg The message box body text
495 * @param {Function} fn (optional) The callback function invoked after the message box is closed
496 * @param {Object} scope (optional) The scope of the callback function
497 * @return {Ext.MessageBox} this
499 confirm : function(title, msg, fn, scope){
512 * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).
513 * The prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user
514 * clicks either button, and the id of the button that was clicked (could also be the top-right
515 * close button) and the text that was entered will be passed as the two parameters to the callback.
516 * @param {String} title The title bar text
517 * @param {String} msg The message box body text
518 * @param {Function} fn (optional) The callback function invoked after the message box is closed
519 * @param {Object} scope (optional) The scope of the callback function
520 * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight
521 * property, or the height in pixels to create the textbox (defaults to false / single-line)
522 * @param {String} value (optional) Default value of the text input element (defaults to '')
523 * @return {Ext.MessageBox} this
525 prompt : function(title, msg, fn, scope, multiline, value){
529 buttons: this.OKCANCEL,
534 multiline: multiline,
541 * Button config that displays a single OK button
546 * Button config that displays a single Cancel button
549 CANCEL : {cancel:true},
551 * Button config that displays OK and Cancel buttons
554 OKCANCEL : {ok:true, cancel:true},
556 * Button config that displays Yes and No buttons
559 YESNO : {yes:true, no:true},
561 * Button config that displays Yes, No and Cancel buttons
564 YESNOCANCEL : {yes:true, no:true, cancel:true},
566 * The CSS class that provides the INFO icon image
569 INFO : 'ext-mb-info',
571 * The CSS class that provides the WARNING icon image
574 WARNING : 'ext-mb-warning',
576 * The CSS class that provides the QUESTION icon image
579 QUESTION : 'ext-mb-question',
581 * The CSS class that provides the ERROR icon image
584 ERROR : 'ext-mb-error',
587 * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
590 defaultTextHeight : 75,
592 * The maximum width in pixels of the message box (defaults to 600)
597 * The minimum width in pixels of the message box (defaults to 110)
602 * The minimum width in pixels of the message box if it is a progress-style dialog. This is useful
603 * for setting a different minimum width than text-only dialogs may need (defaults to 250)
606 minProgressWidth : 250,
608 * An object containing the default button text strings that can be overriden for localized language support.
609 * Supported properties are: ok, cancel, yes and no. Generally you should include a locale-specific
610 * resource file for handling language support across the framework.
611 * Customize the default text like so: Ext.MessageBox.buttonText.yes = "oui"; //french
624 * Shorthand for {@link Ext.MessageBox}
626 Ext.Msg = Ext.MessageBox;