4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <title>The source code</title>
6 <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
7 <script type="text/javascript" src="../prettify/prettify.js"></script>
8 <style type="text/css">
9 .highlight { display: block; background-color: #ddd; }
11 <script type="text/javascript">
12 function highlight() {
13 document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
17 <body onload="prettyPrint(); highlight();">
18 <pre class="prettyprint lang-js"><span id='Ext-window-MessageBox'>/**
19 </span> * @class Ext.window.MessageBox
20 * @extends Ext.window.Window
22 Utility class for generating different styles of message boxes. The singleton instance, `Ext.Msg` can also be used.
23 Note that a MessageBox is asynchronous. Unlike a regular JavaScript `alert` (which will halt
24 browser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code
25 that should only run *after* some user feedback from the MessageBox, you must use a callback function
26 (see the `function` parameter for {@link #show} for more details).
28 {@img Ext.window.MessageBox/messagebox1.png alert MessageBox}
29 {@img Ext.window.MessageBox/messagebox2.png prompt MessageBox}
30 {@img Ext.window.MessageBox/messagebox3.png show MessageBox}
34 Ext.Msg.alert('Status', 'Changes saved successfully.');
36 // Prompt for user data and process the result using a callback:
37 Ext.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
39 // process text value and close...
43 // Show a dialog using config options:
45 title:'Save Changes?',
46 msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?',
47 buttons: Ext.Msg.YESNOCANCEL,
49 animateTarget: 'elId',
50 icon: Ext.window.MessageBox.QUESTION
57 Ext.define('Ext.window.MessageBox', {
58 extend: 'Ext.window.Window',
61 'Ext.toolbar.Toolbar',
62 'Ext.form.field.Text',
63 'Ext.form.field.TextArea',
65 'Ext.layout.container.Anchor',
66 'Ext.layout.container.HBox',
70 alternateClassName: 'Ext.MessageBox',
72 alias: 'widget.messagebox',
74 <span id='Ext-window-MessageBox-property-OK'> /**
75 </span> * Button config that displays a single OK button
79 <span id='Ext-window-MessageBox-property-YES'> /**
80 </span> * Button config that displays a single Yes button
84 <span id='Ext-window-MessageBox-property-NO'> /**
85 </span> * Button config that displays a single No button
89 <span id='Ext-window-MessageBox-property-CANCEL'> /**
90 </span> * Button config that displays a single Cancel button
94 <span id='Ext-window-MessageBox-property-OKCANCEL'> /**
95 </span> * Button config that displays OK and Cancel buttons
99 <span id='Ext-window-MessageBox-property-YESNO'> /**
100 </span> * Button config that displays Yes and No buttons
104 <span id='Ext-window-MessageBox-property-YESNOCANCEL'> /**
105 </span> * Button config that displays Yes, No and Cancel buttons
109 <span id='Ext-window-MessageBox-property-INFO'> /**
110 </span> * The CSS class that provides the INFO icon image
113 INFO : 'ext-mb-info',
114 <span id='Ext-window-MessageBox-property-WARNING'> /**
115 </span> * The CSS class that provides the WARNING icon image
118 WARNING : 'ext-mb-warning',
119 <span id='Ext-window-MessageBox-property-QUESTION'> /**
120 </span> * The CSS class that provides the QUESTION icon image
123 QUESTION : 'ext-mb-question',
124 <span id='Ext-window-MessageBox-property-ERROR'> /**
125 </span> * The CSS class that provides the ERROR icon image
128 ERROR : 'ext-mb-error',
130 // hide it by offsets. Windows are hidden on render by default.
144 cls: Ext.baseCSSPrefix + 'message-box',
150 <span id='Ext-window-MessageBox-property-defaultTextHeight'> /**
151 </span> * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
154 defaultTextHeight : 75,
155 <span id='Ext-window-MessageBox-property-minProgressWidth'> /**
156 </span> * The minimum width in pixels of the message box if it is a progress-style dialog. This is useful
157 * for setting a different minimum width than text-only dialogs may need (defaults to 250).
160 minProgressWidth : 250,
161 <span id='Ext-window-MessageBox-property-minPromptWidth'> /**
162 </span> * The minimum width in pixels of the message box if it is a prompt dialog. This is useful
163 * for setting a different minimum width than text-only dialogs may need (defaults to 250).
167 <span id='Ext-window-MessageBox-property-buttonText'> /**
168 </span> * An object containing the default button text strings that can be overriden for localized language support.
169 * Supported properties are: ok, cancel, yes and no. Generally you should include a locale-specific
170 * resource file for handling language support across the framework.
171 * Customize the default text like so: Ext.window.MessageBox.buttonText.yes = "oui"; //french
182 'ok', 'yes', 'no', 'cancel'
194 makeButton: function(btnIdx) {
195 var btnId = this.buttonIds[btnIdx];
196 return Ext.create('Ext.button.Button', {
197 handler: this.btnCallback,
200 text: this.buttonText[btnId],
205 btnCallback: function(btn) {
210 if (me.cfg.prompt || me.cfg.multiline) {
211 if (me.cfg.multiline) {
214 field = me.textField;
216 value = field.getValue();
220 // Important not to have focus remain in the hidden Window; Interferes with DnD.
223 me.userCallback(btn.itemId, value, me.cfg);
229 me.progressBar.reset();
230 me.removeCls(me.cfg.cls);
234 initComponent: function() {
238 me.title = '&#160;';
240 me.topContainer = Ext.create('Ext.container.Container', {
247 me.iconComponent = Ext.create('Ext.Component', {
250 height: me.iconHeight,
255 me.promptContainer = Ext.create('Ext.container.Container', {
260 me.msg = Ext.create('Ext.Component', {
261 autoEl: { tag: 'span' },
264 me.textField = Ext.create('Ext.form.field.Text', {
266 enableKeyEvents: true,
268 keydown: me.onPromptKey,
272 me.textArea = Ext.create('Ext.form.field.TextArea', {
280 me.progressBar = Ext.create('Ext.ProgressBar', {
282 style: 'margin-left:10px'
285 me.items = [me.topContainer, me.progressBar];
287 // Create the buttons based upon passed bitwise config
289 for (i = 0; i < 4; i++) {
290 button = me.makeButton(i);
291 me.msgButtons[button.itemId] = button;
292 me.msgButtons.push(button);
294 me.bottomTb = Ext.create('Ext.toolbar.Toolbar', {
307 me.dockedItems = [me.bottomTb];
312 onPromptKey: function(textField, e) {
316 if (e.keyCode === Ext.EventObject.RETURN || e.keyCode === 10) {
317 if (me.msgButtons.ok.isVisible()) {
319 me.msgButtons.ok.handler.call(me, me.msgButtons.ok);
320 } else if (me.msgButtons.yes.isVisible()) {
321 me.msgButtons.yes.handler.call(me, me.msgButtons.yes);
331 reconfigure: function(cfg) {
333 buttons = cfg.buttons || 0,
335 initialWidth = me.maxWidth,
341 initialWidth = cfg.width;
344 // Default to allowing the Window to take focus.
345 delete me.defaultFocus;
347 // clear any old animateTarget
348 me.animateTarget = cfg.animateTarget || undefined;
351 me.modal = cfg.modal !== false;
355 me.setTitle(cfg.title||'&#160;');
359 me.width = initialWidth;
360 me.render(Ext.getBody());
363 me.setSize(initialWidth, me.maxHeight);
365 me.setPosition(-10000, -10000);
367 // Hide or show the close tool
368 me.closable = cfg.closable && !cfg.wait;
369 if (cfg.closable === false) {
370 me.tools.close.hide();
372 me.tools.close.show();
375 // Hide or show the header
376 if (!cfg.title && !me.closable) {
382 // Default to dynamic drag: drag the window, not a ghost
383 me.liveDrag = !cfg.proxyDrag;
385 // wrap the user callback
386 me.userCallback = Ext.Function.bind(cfg.callback ||cfg.fn || Ext.emptyFn, cfg.scope || Ext.global);
388 // Hide or show the icon Component
389 me.setIcon(cfg.icon);
391 // Hide or show the message area
393 me.msg.update(cfg.msg);
399 // Hide or show the input field
400 if (cfg.prompt || cfg.multiline) {
401 me.multiline = cfg.multiline;
403 me.textArea.setValue(cfg.value);
404 me.textArea.setHeight(cfg.defaultTextHeight || me.defaultTextHeight);
407 me.defaultFocus = me.textArea;
409 me.textField.setValue(cfg.value);
412 me.defaultFocus = me.textField;
419 // Hide or show the progress bar
420 if (cfg.progress || cfg.wait) {
421 me.progressBar.show();
422 me.updateProgress(0, cfg.progressText);
423 if(cfg.wait === true){
424 me.progressBar.wait(cfg.waitConfig);
427 me.progressBar.hide();
430 // Hide or show buttons depending on flag value sent.
431 for (i = 0; i < 4; i++) {
432 if (buttons & Math.pow(2, i)) {
434 // Default to focus on the first visible button if focus not already set
435 if (!me.defaultFocus) {
436 me.defaultFocus = me.msgButtons[i];
438 me.msgButtons[i].show();
441 me.msgButtons[i].hide();
445 // Hide toolbar if no buttons to show
454 <span id='Ext-window-MessageBox-method-show'> /**
455 </span> * Displays a new message box, or reinitializes an existing message box, based on the config options
456 * passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,
457 * although those calls are basic shortcuts and do not support all of the config options allowed here.
458 * @param {Object} config The following config options are supported: <ul>
459 * <li><b>animateTarget</b> : String/Element<div class="sub-desc">An id or Element from which the message box should animate as it
460 * opens and closes (defaults to undefined)</div></li>
461 * <li><b>buttons</b> : Number<div class="sub-desc">A bitwise button specifier consisting of the sum of any of the following constants:<ul>
462 * <li>Ext.window.MessageBox.OK</li>
463 * <li>Ext.window.MessageBox.YES</li>
464 * <li>Ext.window.MessageBox.NO</li>
465 * <li>Ext.window.MessageBox.CANCEL</li>
466 * </ul>Or false to not show any buttons (defaults to false)</div></li>
467 * <li><b>closable</b> : Boolean<div class="sub-desc">False to hide the top-right close button (defaults to true). Note that
468 * progress and wait dialogs will ignore this property and always hide the close button as they can only
469 * be closed programmatically.</div></li>
470 * <li><b>cls</b> : String<div class="sub-desc">A custom CSS class to apply to the message box's container element</div></li>
471 * <li><b>defaultTextHeight</b> : Number<div class="sub-desc">The default height in pixels of the message box's multiline textarea
472 * if displayed (defaults to 75)</div></li>
473 * <li><b>fn</b> : Function<div class="sub-desc">A callback function which is called when the dialog is dismissed either
474 * by clicking on the configured buttons, or on the dialog close button, or by pressing
475 * the return button to enter input.
476 * <p>Progress and wait dialogs will ignore this option since they do not respond to user
477 * actions and can only be closed programmatically, so any required function should be called
478 * by the same code after it closes the dialog. Parameters passed:<ul>
479 * <li><b>buttonId</b> : String<div class="sub-desc">The ID of the button pressed, one of:<div class="sub-desc"><ul>
480 * <li><tt>ok</tt></li>
481 * <li><tt>yes</tt></li>
482 * <li><tt>no</tt></li>
483 * <li><tt>cancel</tt></li>
484 * </ul></div></div></li>
485 * <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.window.MessageBox">prompt</a></tt>
486 * or <tt><a href="#show-option-multiline" ext:member="show-option-multiline" ext:cls="Ext.window.MessageBox">multiline</a></tt> is true</div></li>
487 * <li><b>opt</b> : Object<div class="sub-desc">The config object passed to show.</div></li>
488 * </ul></p></div></li>
489 * <li><b>scope</b> : Object<div class="sub-desc">The scope (<code>this</code> reference) in which the function will be executed.</div></li>
490 * <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
491 * dialog (e.g. Ext.window.MessageBox.WARNING or 'custom-class') (defaults to '')</div></li>
492 * <li><b>iconCls</b> : String<div class="sub-desc">The standard {@link Ext.window.Window#iconCls} to
493 * add an optional header icon (defaults to '')</div></li>
494 * <li><b>maxWidth</b> : Number<div class="sub-desc">The maximum width in pixels of the message box (defaults to 600)</div></li>
495 * <li><b>minWidth</b> : Number<div class="sub-desc">The minimum width in pixels of the message box (defaults to 100)</div></li>
496 * <li><b>modal</b> : Boolean<div class="sub-desc">False to allow user interaction with the page while the message box is
497 * displayed (defaults to true)</div></li>
498 * <li><b>msg</b> : String<div class="sub-desc">A string that will replace the existing message box body text (defaults to the
499 * XHTML-compliant non-breaking space character '&amp;#160;')</div></li>
500 * <li><a id="show-option-multiline"></a><b>multiline</b> : Boolean<div class="sub-desc">
501 * True to prompt the user to enter multi-line text (defaults to false)</div></li>
502 * <li><b>progress</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
503 * <li><b>progressText</b> : String<div class="sub-desc">The text to display inside the progress bar if progress = true (defaults to '')</div></li>
504 * <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>
505 * <li><b>proxyDrag</b> : Boolean<div class="sub-desc">True to display a lightweight proxy while dragging (defaults to false)</div></li>
506 * <li><b>title</b> : String<div class="sub-desc">The title text</div></li>
507 * <li><b>value</b> : String<div class="sub-desc">The string value to set into the active textbox element if displayed</div></li>
508 * <li><b>wait</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
509 * <li><b>waitConfig</b> : Object<div class="sub-desc">A {@link Ext.ProgressBar#waitConfig} object (applies only if wait = true)</div></li>
510 * <li><b>width</b> : Number<div class="sub-desc">The width of the dialog in pixels</div></li>
513 * <pre><code>
516 msg: 'Please enter your address:',
518 buttons: Ext.window.MessageBox.OKCANCEL,
521 animateTarget: 'addAddressBtn',
522 icon: Ext.window.MessageBox.INFO
524 </code></pre>
525 * @return {Ext.window.MessageBox} this
527 show: function(cfg) {
532 if (cfg.animateTarget) {
533 me.doAutoSize(false);
542 afterShow: function(){
543 if (this.animateTarget) {
546 this.callParent(arguments);
549 doAutoSize: function(center) {
551 icon = me.iconComponent,
552 iconHeight = me.iconHeight;
554 if (!Ext.isDefined(me.frameWidth)) {
555 me.frameWidth = me.el.getWidth() - me.body.getWidth();
558 // reset to the original dimensions
559 icon.setHeight(iconHeight);
561 // Allow per-invocation override of minWidth
562 me.minWidth = me.cfg.minWidth || Ext.getClass(this).prototype.minWidth;
564 // Set best possible size based upon allowing the text to wrap in the maximized Window, and
565 // then constraining it to within the max with. Then adding up constituent element heights.
566 me.topContainer.doLayout();
567 if (Ext.isIE6 || Ext.isIEQuirks) {
568 // In IE quirks, the initial full width of the prompt fields will prevent the container element
569 // from collapsing once sized down, so temporarily force them to a small width. They'll get
570 // layed out to their final width later when setting the final window size.
571 me.textField.setCalculatedSize(9);
572 me.textArea.setCalculatedSize(9);
574 var width = me.cfg.width || me.msg.getWidth() + icon.getWidth() + 25, /* topContainer's layout padding */
575 height = (me.header.rendered ? me.header.getHeight() : 0) +
576 Math.max(me.promptContainer.getHeight(), icon.getHeight()) +
577 me.progressBar.getHeight() +
578 (me.bottomTb.rendered ? me.bottomTb.getHeight() : 0) + 20 ;/* topContainer's layout padding */
580 // Update to the size of the content, this way the text won't wrap under the icon.
581 icon.setHeight(Math.max(iconHeight, me.msg.getHeight()));
582 me.setSize(width + me.frameWidth, height + me.frameWidth);
589 updateText: function(text) {
590 this.msg.update(text);
591 return this.doAutoSize(true);
594 <span id='Ext-window-MessageBox-method-setIcon'> /**
595 </span> * Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default
596 * styling, and the class passed in is expected to supply the background image url. Pass in empty string ('')
597 * to clear any existing icon. This method must be called before the MessageBox is shown.
598 * The following built-in icon classes are supported, but you can also pass in a custom class name:
600 Ext.window.MessageBox.INFO
601 Ext.window.MessageBox.WARNING
602 Ext.window.MessageBox.QUESTION
603 Ext.window.MessageBox.ERROR
605 * @param {String} icon A CSS classname specifying the icon's background image url, or empty string to clear the icon
606 * @return {Ext.window.MessageBox} this
608 setIcon : function(icon) {
610 me.iconComponent.removeCls(me.iconCls);
612 me.iconComponent.show();
613 me.iconComponent.addCls(Ext.baseCSSPrefix + 'dlg-icon');
614 me.iconComponent.addCls(me.iconCls = icon);
616 me.iconComponent.removeCls(Ext.baseCSSPrefix + 'dlg-icon');
617 me.iconComponent.hide();
622 <span id='Ext-window-MessageBox-method-updateProgress'> /**
623 </span> * Updates a progress-style message box's text and progress bar. Only relevant on message boxes
624 * initiated via {@link Ext.window.MessageBox#progress} or {@link Ext.window.MessageBox#wait},
625 * or by calling {@link Ext.window.MessageBox#show} with progress: true.
626 * @param {Number} value Any number between 0 and 1 (e.g., .5, defaults to 0)
627 * @param {String} progressText The progress text to display inside the progress bar (defaults to '')
628 * @param {String} msg The message box's body text is replaced with the specified string (defaults to undefined
629 * so that any existing body text will not get overwritten by default unless a new value is passed in)
630 * @return {Ext.window.MessageBox} this
632 updateProgress : function(value, progressText, msg){
633 this.progressBar.updateProgress(value, progressText);
635 this.updateText(msg);
641 if (this.closable !== false) {
642 this.callParent(arguments);
646 <span id='Ext-window-MessageBox-method-confirm'> /**
647 </span> * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).
648 * If a callback function is passed it will be called after the user clicks either button,
649 * and the id of the button that was clicked will be passed as the only parameter to the callback
650 * (could also be the top-right close button).
651 * @param {String} title The title bar text
652 * @param {String} msg The message box body text
653 * @param {Function} fn (optional) The callback function invoked after the message box is closed
654 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.
655 * @return {Ext.window.MessageBox} this
657 confirm: function(cfg, msg, fn, scope) {
658 if (Ext.isString(cfg)) {
661 icon: 'ext-mb-question',
668 return this.show(cfg);
671 <span id='Ext-window-MessageBox-method-prompt'> /**
672 </span> * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).
673 * The prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user
674 * clicks either button, and the id of the button that was clicked (could also be the top-right
675 * close button) and the text that was entered will be passed as the two parameters to the callback.
676 * @param {String} title The title bar text
677 * @param {String} msg The message box body text
678 * @param {Function} fn (optional) The callback function invoked after the message box is closed
679 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.
680 * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight
681 * property, or the height in pixels to create the textbox (defaults to false / single-line)
682 * @param {String} value (optional) Default value of the text input element (defaults to '')
683 * @return {Ext.window.MessageBox} this
685 prompt : function(cfg, msg, fn, scope, multiline, value){
686 if (Ext.isString(cfg)) {
690 minWidth: this.minPromptWidth,
692 buttons: this.OKCANCEL,
695 multiline: multiline,
699 return this.show(cfg);
702 <span id='Ext-window-MessageBox-method-wait'> /**
703 </span> * Displays a message box with an infinitely auto-updating progress bar. This can be used to block user
704 * interaction while waiting for a long-running process to complete that does not have defined intervals.
705 * You are responsible for closing the message box when the process is complete.
706 * @param {String} msg The message box body text
707 * @param {String} title (optional) The title bar text
708 * @param {Object} config (optional) A {@link Ext.ProgressBar#waitConfig} object
709 * @return {Ext.window.MessageBox} this
711 wait : function(cfg, title, config){
712 if (Ext.isString(cfg)) {
719 minWidth: this.minProgressWidth,
723 return this.show(cfg);
726 <span id='Ext-window-MessageBox-method-alert'> /**
727 </span> * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).
728 * If a callback function is passed it will be called after the user clicks the button, and the
729 * id of the button that was clicked will be passed as the only parameter to the callback
730 * (could also be the top-right close button).
731 * @param {String} title The title bar text
732 * @param {String} msg The message box body text
733 * @param {Function} fn (optional) The callback function invoked after the message box is closed
734 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.
735 * @return {Ext.window.MessageBox} this
737 alert: function(cfg, msg, fn, scope) {
738 if (Ext.isString(cfg)) {
745 minWidth: this.minWidth
748 return this.show(cfg);
751 <span id='Ext-window-MessageBox-method-progress'> /**
752 </span> * Displays a message box with a progress bar. This message box has no buttons and is not closeable by
753 * the user. You are responsible for updating the progress bar as needed via {@link Ext.window.MessageBox#updateProgress}
754 * and closing the message box when the process is complete.
755 * @param {String} title The title bar text
756 * @param {String} msg The message box body text
757 * @param {String} progressText (optional) The text to display inside the progress bar (defaults to '')
758 * @return {Ext.window.MessageBox} this
760 progress : function(cfg, msg, progressText){
761 if (Ext.isString(cfg)) {
765 progressText: progressText
768 return this.show(cfg);
771 Ext.MessageBox = Ext.Msg = new this();