4 * Copyright(c) 2006-2007, Ext JS, LLC.
6 * Originally Released Under LGPL - original licence link has changed is not relivant.
9 * <script type="text/javascript">
13 * @class Roo.MessageBox
14 * Utility class for generating different styles of message boxes. The alias Roo.Msg can also be used.
18 Roo.Msg.alert('Status', 'Changes saved successfully.');
20 // Prompt for user data:
21 Roo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
23 // process text value...
27 // Show a dialog using config options:
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,
38 Roo.MessageBox = function(){
39 var dlg, opt, mask, waitTimer;
40 var bodyEl, msgEl, textboxEl, textareaEl, progressEl, pp;
41 var buttons, activeTextEl, bwidth;
44 var handleButton = function(button){
46 Roo.callback(opt.fn, opt.scope||window, [button, activeTextEl.dom.value], 1);
50 var handleHide = function(){
52 dlg.el.removeClass(opt.cls);
55 Roo.TaskMgr.stop(waitTimer);
61 var updateButtons = function(b){
65 buttons["cancel"].hide();
66 buttons["yes"].hide();
68 dlg.footer.dom.style.display = 'none';
71 dlg.footer.dom.style.display = '';
72 for(var k in buttons){
73 if(typeof buttons[k] != "function"){
76 buttons[k].setText(typeof b[k] == "string" ? b[k] : Roo.MessageBox.buttonText[k]);
77 width += buttons[k].el.getWidth()+15;
87 var handleEsc = function(d, k, e){
88 if(opt && opt.closable !== false){
98 * Returns a reference to the underlying {@link Roo.BasicDialog} element
99 * @return {Roo.BasicDialog} The BasicDialog element
101 getDialog : function(){
103 dlg = new Roo.BasicDialog("x-msg-box", {
108 constraintoviewport:false,
113 width:400, height:100,
114 buttonAlign:"center",
115 closeClick : function(){
116 if(opt && opt.buttons && opt.buttons.no && !opt.buttons.cancel){
119 handleButton("cancel");
123 dlg.on("hide", handleHide);
125 dlg.addKeyListener(27, handleEsc);
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({
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"> </div></div></div>'
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){
143 }else if(opt.buttons.yes){
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;
154 pp = Roo.get(pf.firstChild);
155 pp.setHeight(pf.offsetHeight);
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 '&#160;')
166 * @return {Roo.MessageBox} This message box
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
172 msgEl.innerHTML = text || ' ';
174 var cw = Math.max(msgEl.offsetWidth, msgEl.parentNode.scrollWidth);
175 //Roo.log("guesed size: " + JSON.stringify([cw,msgEl.offsetWidth, msgEl.parentNode.scrollWidth]));
177 Math.min(opt.width || cw , this.maxWidth),
178 Math.max(opt.minWidth || this.minWidth, bwidth)
181 activeTextEl.setWidth(w);
184 dlg.fixedcenter = false;
186 // to big, make it scroll. = But as usual stupid IE does not support
189 if ( bodyEl.getHeight() > (Roo.lib.Dom.getViewHeight() - 100)) {
190 bodyEl.setHeight ( Roo.lib.Dom.getViewHeight() - 100 );
191 bodyEl.dom.style.overflowY = 'auto' + ( Roo.isIE ? '' : ' !important');
193 bodyEl.dom.style.height = '';
194 bodyEl.dom.style.overflowY = '';
197 bodyEl.dom.style.get = 'auto' + ( Roo.isIE ? '' : ' !important');
199 bodyEl.dom.style.overflowX = '';
202 dlg.setContentSize(w, bodyEl.getHeight());
204 dlg.fixedcenter = true;
210 * Updates a progress-style message box's text and progress bar. Only relevant on message boxes
211 * initiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.
212 * @param {Number} value Any number between 0 and 1 (e.g., .5)
213 * @param {String} text (optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)
214 * @return {Roo.MessageBox} This message box
216 updateProgress : function(value, text){
218 this.updateText(text);
220 if (pp) { // weird bug on my firefox - for some reason this is not defined
221 pp.setWidth(Math.floor(value*progressEl.dom.firstChild.offsetWidth));
227 * Returns true if the message box is currently displayed
228 * @return {Boolean} True if the message box is visible, else false
230 isVisible : function(){
231 return dlg && dlg.isVisible();
235 * Hides the message box if it is displayed
238 if(this.isVisible()){
244 * Displays a new message box, or reinitializes an existing message box, based on the config options
245 * passed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.
246 * The following config object properties are supported:
248 Property Type Description
249 ---------- --------------- ------------------------------------------------------------------------------------
250 animEl String/Element An id or Element from which the message box should animate as it opens and
251 closes (defaults to undefined)
252 buttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',
253 cancel:'Bar'}), or false to not show any buttons (defaults to false)
254 closable Boolean False to hide the top-right close button (defaults to true). Note that
255 progress and wait dialogs will ignore this property and always hide the
256 close button as they can only be closed programmatically.
257 cls String A custom CSS class to apply to the message box element
258 defaultTextHeight Number The default height in pixels of the message box's multiline textarea if
259 displayed (defaults to 75)
260 fn Function A callback function to execute after closing the dialog. The arguments to the
261 function will be btn (the name of the button that was clicked, if applicable,
262 e.g. "ok"), and text (the value of the active text field, if applicable).
263 Progress and wait dialogs will ignore this option since they do not respond to
264 user actions and can only be closed programmatically, so any required function
265 should be called by the same code after it closes the dialog.
266 icon String A CSS class that provides a background image to be used as an icon for
267 the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')
268 maxWidth Number The maximum width in pixels of the message box (defaults to 600)
269 minWidth Number The minimum width in pixels of the message box (defaults to 100)
270 modal Boolean False to allow user interaction with the page while the message box is
271 displayed (defaults to true)
272 msg String A string that will replace the existing message box body text (defaults
273 to the XHTML-compliant non-breaking space character ' ')
274 multiline Boolean True to prompt the user to enter multi-line text (defaults to false)
275 progress Boolean True to display a progress bar (defaults to false)
276 progressText String The text to display inside the progress bar if progress = true (defaults to '')
277 prompt Boolean True to prompt the user to enter single-line text (defaults to false)
278 proxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)
279 title String The title text
280 value String The string value to set into the active textbox element if displayed
281 wait Boolean True to display a progress bar (defaults to false)
282 width Number The width of the dialog in pixels
289 msg: 'Please enter your address:',
291 buttons: Roo.MessageBox.OKCANCEL,
294 animEl: 'addAddressBtn'
297 * @param {Object} config Configuration options
298 * @return {Roo.MessageBox} This message box
300 show : function(options)
303 // this causes nightmares if you show one dialog after another
304 // especially on callbacks..
306 if(this.isVisible()){
309 Roo.log("[Roo.Messagebox] Show called while message displayed:" );
310 Roo.log("Old Dialog Message:" + msgEl.innerHTML );
311 Roo.log("New Dialog Message:" + options.msg )
312 //this.alert("ERROR", "Multiple dialogs where displayed at the same time");
313 //throw "Roo.MessageBox ERROR : Multiple dialogs where displayed at the same time";
316 var d = this.getDialog();
318 d.setTitle(opt.title || " ");
319 d.close.setDisplayed(opt.closable !== false);
320 activeTextEl = textboxEl;
321 opt.prompt = opt.prompt || (opt.multiline ? true : false);
326 textareaEl.setHeight(typeof opt.multiline == "number" ?
327 opt.multiline : this.defaultTextHeight);
328 activeTextEl = textareaEl;
337 progressEl.setDisplayed(opt.progress === true);
338 this.updateProgress(0);
339 activeTextEl.dom.value = opt.value || "";
341 dlg.setDefaultButton(activeTextEl);
343 var bs = opt.buttons;
347 }else if(bs && bs.yes){
350 dlg.setDefaultButton(db);
352 bwidth = updateButtons(opt.buttons);
353 this.updateText(opt.msg);
355 d.el.addClass(opt.cls);
357 d.proxyDrag = opt.proxyDrag === true;
358 d.modal = opt.modal !== false;
359 d.mask = opt.modal !== false ? mask : false;
361 // force it to the end of the z-index stack so it gets a cursor in FF
362 document.body.appendChild(dlg.el.dom);
363 d.animateTarget = null;
364 d.show(options.animEl);
370 * Displays a message box with a progress bar. This message box has no buttons and is not closeable by
371 * the user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}
372 * and closing the message box when the process is complete.
373 * @param {String} title The title bar text
374 * @param {String} msg The message box body text
375 * @return {Roo.MessageBox} This message box
377 progress : function(title, msg){
384 minWidth: this.minProgressWidth,
391 * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).
392 * If a callback function is passed it will be called after the user clicks the button, and the
393 * id of the button that was clicked will be passed as the only parameter to the callback
394 * (could also be the top-right close button).
395 * @param {String} title The title bar text
396 * @param {String} msg The message box body text
397 * @param {Function} fn (optional) The callback function invoked after the message box is closed
398 * @param {Object} scope (optional) The scope of the callback function
399 * @return {Roo.MessageBox} This message box
401 alert : function(title, msg, fn, scope){
414 * Displays a message box with an infinitely auto-updating progress bar. This can be used to block user
415 * interaction while waiting for a long-running process to complete that does not have defined intervals.
416 * You are responsible for closing the message box when the process is complete.
417 * @param {String} msg The message box body text
418 * @param {String} title (optional) The title bar text
419 * @return {Roo.MessageBox} This message box
421 wait : function(msg, title){
432 waitTimer = Roo.TaskMgr.start({
434 Roo.MessageBox.updateProgress(((((i+20)%20)+1)*5)*.01);
442 * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).
443 * If a callback function is passed it will be called after the user clicks either button, and the id of the
444 * button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).
445 * @param {String} title The title bar text
446 * @param {String} msg The message box body text
447 * @param {Function} fn (optional) The callback function invoked after the message box is closed
448 * @param {Object} scope (optional) The scope of the callback function
449 * @return {Roo.MessageBox} This message box
451 confirm : function(title, msg, fn, scope){
464 * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to
465 * JavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function
466 * is passed it will be called after the user clicks either button, and the id of the button that was clicked
467 * (could also be the top-right close button) and the text that was entered will be passed as the two
468 * parameters to the callback.
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 * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight
474 * property, or the height in pixels to create the textbox (defaults to false / single-line)
475 * @return {Roo.MessageBox} This message box
477 prompt : function(title, msg, fn, scope, multiline){
481 buttons: this.OKCANCEL,
486 multiline: multiline,
493 * Button config that displays a single OK button
498 * Button config that displays Yes and No buttons
501 YESNO : {yes:true, no:true},
503 * Button config that displays OK and Cancel buttons
506 OKCANCEL : {ok:true, cancel:true},
508 * Button config that displays Yes, No and Cancel buttons
511 YESNOCANCEL : {yes:true, no:true, cancel:true},
514 * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
517 defaultTextHeight : 75,
519 * The maximum width in pixels of the message box (defaults to 600)
524 * The minimum width in pixels of the message box (defaults to 100)
529 * The minimum width in pixels of the message box if it is a progress-style dialog. This is useful
530 * for setting a different minimum width than text-only dialogs may need (defaults to 250)
533 minProgressWidth : 250,
535 * An object containing the default button text strings that can be overriden for localized language support.
536 * Supported properties are: ok, cancel, yes and no.
537 * Customize the default text like so: Roo.MessageBox.buttonText.yes = "S?";
550 * Shorthand for {@link Roo.MessageBox}
552 Roo.Msg = Roo.MessageBox;