4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <title>The source code</title>
6 <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
7 <script type="text/javascript" src="../resources/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> * Utility class for generating different styles of message boxes. The singleton instance, Ext.MessageBox
20 * alias `Ext.Msg` can also be used.
22 * Note that a MessageBox is asynchronous. Unlike a regular JavaScript `alert` (which will halt
23 * browser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code
24 * that should only run *after* some user feedback from the MessageBox, you must use a callback function
25 * (see the `function` parameter for {@link #show} for more details).
30 * Ext.Msg.alert('Status', 'Changes saved successfully.');
32 * Prompt for user data and process the result using a callback
35 * Ext.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
37 * // process text value and close...
41 * 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,
48 * icon: Ext.Msg.QUESTION
51 Ext.define('Ext.window.MessageBox', {
52 extend: 'Ext.window.Window',
55 'Ext.toolbar.Toolbar',
56 'Ext.form.field.Text',
57 'Ext.form.field.TextArea',
59 'Ext.layout.container.Anchor',
60 'Ext.layout.container.HBox',
64 alias: 'widget.messagebox',
66 <span id='Ext-window-MessageBox-property-OK'> /**
67 </span> * Button config that displays a single OK button
71 <span id='Ext-window-MessageBox-property-YES'> /**
72 </span> * Button config that displays a single Yes button
76 <span id='Ext-window-MessageBox-property-NO'> /**
77 </span> * Button config that displays a single No button
81 <span id='Ext-window-MessageBox-property-CANCEL'> /**
82 </span> * Button config that displays a single Cancel button
86 <span id='Ext-window-MessageBox-property-OKCANCEL'> /**
87 </span> * Button config that displays OK and Cancel buttons
91 <span id='Ext-window-MessageBox-property-YESNO'> /**
92 </span> * Button config that displays Yes and No buttons
96 <span id='Ext-window-MessageBox-property-YESNOCANCEL'> /**
97 </span> * Button config that displays Yes, No and Cancel buttons
101 <span id='Ext-window-MessageBox-property-INFO'> /**
102 </span> * The CSS class that provides the INFO icon image
105 INFO : 'ext-mb-info',
106 <span id='Ext-window-MessageBox-property-WARNING'> /**
107 </span> * The CSS class that provides the WARNING icon image
110 WARNING : 'ext-mb-warning',
111 <span id='Ext-window-MessageBox-property-QUESTION'> /**
112 </span> * The CSS class that provides the QUESTION icon image
115 QUESTION : 'ext-mb-question',
116 <span id='Ext-window-MessageBox-property-ERROR'> /**
117 </span> * The CSS class that provides the ERROR icon image
120 ERROR : 'ext-mb-error',
122 // hide it by offsets. Windows are hidden on render by default.
136 cls: Ext.baseCSSPrefix + 'message-box',
142 <span id='Ext-window-MessageBox-property-defaultTextHeight'> /**
143 </span> * The default height in pixels of the message box's multiline textarea if displayed.
146 defaultTextHeight : 75,
147 <span id='Ext-window-MessageBox-property-minProgressWidth'> /**
148 </span> * The minimum width in pixels of the message box if it is a progress-style dialog. This is useful
149 * for setting a different minimum width than text-only dialogs may need.
152 minProgressWidth : 250,
153 <span id='Ext-window-MessageBox-property-minPromptWidth'> /**
154 </span> * The minimum width in pixels of the message box if it is a prompt dialog. This is useful
155 * for setting a different minimum width than text-only dialogs may need.
159 <span id='Ext-window-MessageBox-property-buttonText'> /**
160 </span> * An object containing the default button text strings that can be overriden for localized language support.
161 * Supported properties are: ok, cancel, yes and no. Generally you should include a locale-specific
162 * resource file for handling language support across the framework.
163 * Customize the default text like so: Ext.window.MessageBox.buttonText.yes = "oui"; //french
174 'ok', 'yes', 'no', 'cancel'
186 makeButton: function(btnIdx) {
187 var btnId = this.buttonIds[btnIdx];
188 return Ext.create('Ext.button.Button', {
189 handler: this.btnCallback,
192 text: this.buttonText[btnId],
197 btnCallback: function(btn) {
202 if (me.cfg.prompt || me.cfg.multiline) {
203 if (me.cfg.multiline) {
206 field = me.textField;
208 value = field.getValue();
212 // Important not to have focus remain in the hidden Window; Interferes with DnD.
215 me.userCallback(btn.itemId, value, me.cfg);
221 me.progressBar.reset();
222 me.removeCls(me.cfg.cls);
226 initComponent: function() {
230 me.title = '&#160;';
232 me.topContainer = Ext.create('Ext.container.Container', {
239 me.iconComponent = Ext.create('Ext.Component', {
242 height: me.iconHeight,
247 me.promptContainer = Ext.create('Ext.container.Container', {
252 me.msg = Ext.create('Ext.Component', {
253 autoEl: { tag: 'span' },
256 me.textField = Ext.create('Ext.form.field.Text', {
258 enableKeyEvents: true,
260 keydown: me.onPromptKey,
264 me.textArea = Ext.create('Ext.form.field.TextArea', {
272 me.progressBar = Ext.create('Ext.ProgressBar', {
274 style: 'margin-left:10px'
277 me.items = [me.topContainer, me.progressBar];
279 // Create the buttons based upon passed bitwise config
281 for (i = 0; i < 4; i++) {
282 button = me.makeButton(i);
283 me.msgButtons[button.itemId] = button;
284 me.msgButtons.push(button);
286 me.bottomTb = Ext.create('Ext.toolbar.Toolbar', {
299 me.dockedItems = [me.bottomTb];
304 onPromptKey: function(textField, e) {
308 if (e.keyCode === Ext.EventObject.RETURN || e.keyCode === 10) {
309 if (me.msgButtons.ok.isVisible()) {
311 me.msgButtons.ok.handler.call(me, me.msgButtons.ok);
312 } else if (me.msgButtons.yes.isVisible()) {
313 me.msgButtons.yes.handler.call(me, me.msgButtons.yes);
323 reconfigure: function(cfg) {
325 buttons = cfg.buttons || 0,
327 initialWidth = me.maxWidth,
333 initialWidth = cfg.width;
336 // Default to allowing the Window to take focus.
337 delete me.defaultFocus;
339 // clear any old animateTarget
340 me.animateTarget = cfg.animateTarget || undefined;
343 me.modal = cfg.modal !== false;
347 me.setTitle(cfg.title||'&#160;');
351 me.width = initialWidth;
352 me.render(Ext.getBody());
354 me.setSize(initialWidth, me.maxHeight);
356 me.setPosition(-10000, -10000);
358 // Hide or show the close tool
359 me.closable = cfg.closable && !cfg.wait;
360 me.header.child('[type=close]').setVisible(cfg.closable !== false);
362 // Hide or show the header
363 if (!cfg.title && !me.closable) {
369 // Default to dynamic drag: drag the window, not a ghost
370 me.liveDrag = !cfg.proxyDrag;
372 // wrap the user callback
373 me.userCallback = Ext.Function.bind(cfg.callback ||cfg.fn || Ext.emptyFn, cfg.scope || Ext.global);
375 // Hide or show the icon Component
376 me.setIcon(cfg.icon);
378 // Hide or show the message area
380 me.msg.update(cfg.msg);
386 // Hide or show the input field
387 if (cfg.prompt || cfg.multiline) {
388 me.multiline = cfg.multiline;
390 me.textArea.setValue(cfg.value);
391 me.textArea.setHeight(cfg.defaultTextHeight || me.defaultTextHeight);
394 me.defaultFocus = me.textArea;
396 me.textField.setValue(cfg.value);
399 me.defaultFocus = me.textField;
406 // Hide or show the progress bar
407 if (cfg.progress || cfg.wait) {
408 me.progressBar.show();
409 me.updateProgress(0, cfg.progressText);
410 if(cfg.wait === true){
411 me.progressBar.wait(cfg.waitConfig);
414 me.progressBar.hide();
417 // Hide or show buttons depending on flag value sent.
418 for (i = 0; i < 4; i++) {
419 if (buttons & Math.pow(2, i)) {
421 // Default to focus on the first visible button if focus not already set
422 if (!me.defaultFocus) {
423 me.defaultFocus = me.msgButtons[i];
425 me.msgButtons[i].show();
428 me.msgButtons[i].hide();
432 // Hide toolbar if no buttons to show
440 <span id='Ext-window-MessageBox-method-show'> /**
441 </span> * Displays a new message box, or reinitializes an existing message box, based on the config options
442 * passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,
443 * although those calls are basic shortcuts and do not support all of the config options allowed here.
444 * @param {Object} config The following config options are supported: <ul>
445 * <li><b>animateTarget</b> : String/Element<div class="sub-desc">An id or Element from which the message box should animate as it
446 * opens and closes (defaults to undefined)</div></li>
447 * <li><b>buttons</b> : Number<div class="sub-desc">A bitwise button specifier consisting of the sum of any of the following constants:<ul>
448 * <li>Ext.window.MessageBox.OK</li>
449 * <li>Ext.window.MessageBox.YES</li>
450 * <li>Ext.window.MessageBox.NO</li>
451 * <li>Ext.window.MessageBox.CANCEL</li>
452 * </ul>Or false to not show any buttons (defaults to false)</div></li>
453 * <li><b>closable</b> : Boolean<div class="sub-desc">False to hide the top-right close button (defaults to true). Note that
454 * progress and wait dialogs will ignore this property and always hide the close button as they can only
455 * be closed programmatically.</div></li>
456 * <li><b>cls</b> : String<div class="sub-desc">A custom CSS class to apply to the message box's container element</div></li>
457 * <li><b>defaultTextHeight</b> : Number<div class="sub-desc">The default height in pixels of the message box's multiline textarea
458 * if displayed (defaults to 75)</div></li>
459 * <li><b>fn</b> : Function<div class="sub-desc">A callback function which is called when the dialog is dismissed either
460 * by clicking on the configured buttons, or on the dialog close button, or by pressing
461 * the return button to enter input.
462 * <p>Progress and wait dialogs will ignore this option since they do not respond to user
463 * actions and can only be closed programmatically, so any required function should be called
464 * by the same code after it closes the dialog. Parameters passed:<ul>
465 * <li><b>buttonId</b> : String<div class="sub-desc">The ID of the button pressed, one of:<div class="sub-desc"><ul>
466 * <li><tt>ok</tt></li>
467 * <li><tt>yes</tt></li>
468 * <li><tt>no</tt></li>
469 * <li><tt>cancel</tt></li>
470 * </ul></div></div></li>
471 * <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>
472 * or <tt><a href="#show-option-multiline" ext:member="show-option-multiline" ext:cls="Ext.window.MessageBox">multiline</a></tt> is true</div></li>
473 * <li><b>opt</b> : Object<div class="sub-desc">The config object passed to show.</div></li>
474 * </ul></p></div></li>
475 * <li><b>scope</b> : Object<div class="sub-desc">The scope (<code>this</code> reference) in which the function will be executed.</div></li>
476 * <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
477 * dialog (e.g. Ext.window.MessageBox.WARNING or 'custom-class') (defaults to '')</div></li>
478 * <li><b>iconCls</b> : String<div class="sub-desc">The standard {@link Ext.window.Window#iconCls} to
479 * add an optional header icon (defaults to '')</div></li>
480 * <li><b>maxWidth</b> : Number<div class="sub-desc">The maximum width in pixels of the message box (defaults to 600)</div></li>
481 * <li><b>minWidth</b> : Number<div class="sub-desc">The minimum width in pixels of the message box (defaults to 100)</div></li>
482 * <li><b>modal</b> : Boolean<div class="sub-desc">False to allow user interaction with the page while the message box is
483 * displayed (defaults to true)</div></li>
484 * <li><b>msg</b> : String<div class="sub-desc">A string that will replace the existing message box body text (defaults to the
485 * XHTML-compliant non-breaking space character '&amp;#160;')</div></li>
486 * <li><a id="show-option-multiline"></a><b>multiline</b> : Boolean<div class="sub-desc">
487 * True to prompt the user to enter multi-line text (defaults to false)</div></li>
488 * <li><b>progress</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
489 * <li><b>progressText</b> : String<div class="sub-desc">The text to display inside the progress bar if progress = true (defaults to '')</div></li>
490 * <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>
491 * <li><b>proxyDrag</b> : Boolean<div class="sub-desc">True to display a lightweight proxy while dragging (defaults to false)</div></li>
492 * <li><b>title</b> : String<div class="sub-desc">The title text</div></li>
493 * <li><b>value</b> : String<div class="sub-desc">The string value to set into the active textbox element if displayed</div></li>
494 * <li><b>wait</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
495 * <li><b>waitConfig</b> : Object<div class="sub-desc">A {@link Ext.ProgressBar#wait} config object (applies only if wait = true)</div></li>
496 * <li><b>width</b> : Number<div class="sub-desc">The width of the dialog in pixels</div></li>
499 * <pre><code>
502 msg: 'Please enter your address:',
504 buttons: Ext.Msg.OKCANCEL,
507 animateTarget: 'addAddressBtn',
508 icon: Ext.window.MessageBox.INFO
510 </code></pre>
511 * @return {Ext.window.MessageBox} this
513 show: function(cfg) {
518 if (cfg.animateTarget) {
528 afterShow: function(){
529 if (this.animateTarget) {
532 this.callParent(arguments);
535 doAutoSize: function(center) {
537 icon = me.iconComponent,
538 iconHeight = me.iconHeight;
540 if (!Ext.isDefined(me.frameWidth)) {
541 me.frameWidth = me.el.getWidth() - me.body.getWidth();
544 // reset to the original dimensions
545 icon.setHeight(iconHeight);
547 // Allow per-invocation override of minWidth
548 me.minWidth = me.cfg.minWidth || Ext.getClass(this).prototype.minWidth;
550 // Set best possible size based upon allowing the text to wrap in the maximized Window, and
551 // then constraining it to within the max with. Then adding up constituent element heights.
552 me.topContainer.doLayout();
553 if (Ext.isIE6 || Ext.isIEQuirks) {
554 // In IE quirks, the initial full width of the prompt fields will prevent the container element
555 // from collapsing once sized down, so temporarily force them to a small width. They'll get
556 // layed out to their final width later when setting the final window size.
557 me.textField.setCalculatedSize(9);
558 me.textArea.setCalculatedSize(9);
560 var width = me.cfg.width || me.msg.getWidth() + icon.getWidth() + 25, /* topContainer's layout padding */
561 height = (me.header.rendered ? me.header.getHeight() : 0) +
562 Math.max(me.promptContainer.getHeight(), icon.getHeight()) +
563 me.progressBar.getHeight() +
564 (me.bottomTb.rendered ? me.bottomTb.getHeight() : 0) + 20 ;/* topContainer's layout padding */
566 // Update to the size of the content, this way the text won't wrap under the icon.
567 icon.setHeight(Math.max(iconHeight, me.msg.getHeight()));
568 me.setSize(width + me.frameWidth, height + me.frameWidth);
575 updateText: function(text) {
576 this.msg.update(text);
577 return this.doAutoSize(true);
580 <span id='Ext-window-MessageBox-method-setIcon'> /**
581 </span> * Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default
582 * styling, and the class passed in is expected to supply the background image url. Pass in empty string ('')
583 * to clear any existing icon. This method must be called before the MessageBox is shown.
584 * The following built-in icon classes are supported, but you can also pass in a custom class name:
586 Ext.window.MessageBox.INFO
587 Ext.window.MessageBox.WARNING
588 Ext.window.MessageBox.QUESTION
589 Ext.window.MessageBox.ERROR
591 * @param {String} icon A CSS classname specifying the icon's background image url, or empty string to clear the icon
592 * @return {Ext.window.MessageBox} this
594 setIcon : function(icon) {
596 me.iconComponent.removeCls(me.iconCls);
598 me.iconComponent.show();
599 me.iconComponent.addCls(Ext.baseCSSPrefix + 'dlg-icon');
600 me.iconComponent.addCls(me.iconCls = icon);
602 me.iconComponent.removeCls(Ext.baseCSSPrefix + 'dlg-icon');
603 me.iconComponent.hide();
608 <span id='Ext-window-MessageBox-method-updateProgress'> /**
609 </span> * Updates a progress-style message box's text and progress bar. Only relevant on message boxes
610 * initiated via {@link Ext.window.MessageBox#progress} or {@link Ext.window.MessageBox#wait},
611 * or by calling {@link Ext.window.MessageBox#show} with progress: true.
612 * @param {Number} [value=0] Any number between 0 and 1 (e.g., .5)
613 * @param {String} [progressText=''] The progress text to display inside the progress bar.
614 * @param {String} [msg] The message box's body text is replaced with the specified string (defaults to undefined
615 * so that any existing body text will not get overwritten by default unless a new value is passed in)
616 * @return {Ext.window.MessageBox} this
618 updateProgress : function(value, progressText, msg){
619 this.progressBar.updateProgress(value, progressText);
621 this.updateText(msg);
627 if (this.closable !== false) {
628 this.callParent(arguments);
632 <span id='Ext-window-MessageBox-method-confirm'> /**
633 </span> * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).
634 * If a callback function is passed it will be called after the user clicks either button,
635 * and the id of the button that was clicked will be passed as the only parameter to the callback
636 * (could also be the top-right close button).
637 * @param {String} title The title bar text
638 * @param {String} msg The message box body text
639 * @param {Function} fn (optional) The callback function invoked after the message box is closed
640 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.
641 * @return {Ext.window.MessageBox} this
643 confirm: function(cfg, msg, fn, scope) {
644 if (Ext.isString(cfg)) {
647 icon: 'ext-mb-question',
654 return this.show(cfg);
657 <span id='Ext-window-MessageBox-method-prompt'> /**
658 </span> * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).
659 * The prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user
660 * clicks either button, and the id of the button that was clicked (could also be the top-right
661 * close button) and the text that was entered will be passed as the two parameters to the callback.
662 * @param {String} title The title bar text
663 * @param {String} msg The message box body text
664 * @param {Function} [fn] The callback function invoked after the message box is closed
665 * @param {Object} [scope] The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.
666 * @param {Boolean/Number} [multiline=false] True to create a multiline textbox using the defaultTextHeight
667 * property, or the height in pixels to create the textbox/
668 * @param {String} [value=''] Default value of the text input element
669 * @return {Ext.window.MessageBox} this
671 prompt : function(cfg, msg, fn, scope, multiline, value){
672 if (Ext.isString(cfg)) {
676 minWidth: this.minPromptWidth,
678 buttons: this.OKCANCEL,
681 multiline: multiline,
685 return this.show(cfg);
688 <span id='Ext-window-MessageBox-method-wait'> /**
689 </span> * Displays a message box with an infinitely auto-updating progress bar. This can be used to block user
690 * interaction while waiting for a long-running process to complete that does not have defined intervals.
691 * You are responsible for closing the message box when the process is complete.
692 * @param {String} msg The message box body text
693 * @param {String} title (optional) The title bar text
694 * @param {Object} config (optional) A {@link Ext.ProgressBar#wait} config object
695 * @return {Ext.window.MessageBox} this
697 wait : function(cfg, title, config){
698 if (Ext.isString(cfg)) {
705 minWidth: this.minProgressWidth,
709 return this.show(cfg);
712 <span id='Ext-window-MessageBox-method-alert'> /**
713 </span> * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).
714 * If a callback function is passed it will be called after the user clicks the button, and the
715 * id of the button that was clicked will be passed as the only parameter to the callback
716 * (could also be the top-right close button).
717 * @param {String} title The title bar text
718 * @param {String} msg The message box body text
719 * @param {Function} fn (optional) The callback function invoked after the message box is closed
720 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.
721 * @return {Ext.window.MessageBox} this
723 alert: function(cfg, msg, fn, scope) {
724 if (Ext.isString(cfg)) {
731 minWidth: this.minWidth
734 return this.show(cfg);
737 <span id='Ext-window-MessageBox-method-progress'> /**
738 </span> * Displays a message box with a progress bar. This message box has no buttons and is not closeable by
739 * the user. You are responsible for updating the progress bar as needed via {@link Ext.window.MessageBox#updateProgress}
740 * and closing the message box when the process is complete.
741 * @param {String} title The title bar text
742 * @param {String} msg The message box body text
743 * @param {String} [progressText=''] The text to display inside the progress bar
744 * @return {Ext.window.MessageBox} this
746 progress : function(cfg, msg, progressText){
747 if (Ext.isString(cfg)) {
752 progressText: progressText
755 return this.show(cfg);
758 <span id='Ext-MessageBox'> /**
759 </span> * @class Ext.MessageBox
760 * @alternateClassName Ext.Msg
761 * @extends Ext.window.MessageBox
763 * Singleton instance of {@link Ext.window.MessageBox}.
765 Ext.MessageBox = Ext.Msg = new this();