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