1 <!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-window.MessageBox'>/**
2 </span> * @class Ext.window.MessageBox
3 * @extends Ext.window.Window
5 Utility class for generating different styles of message boxes. The singleton instance, `Ext.Msg` can also be used.
6 Note that a MessageBox is asynchronous. Unlike a regular JavaScript `alert` (which will halt
7 browser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code
8 that should only run *after* some user feedback from the MessageBox, you must use a callback function
9 (see the `function` parameter for {@link #show} for more details).
11 {@img Ext.window.MessageBox/messagebox1.png alert MessageBox}
12 {@img Ext.window.MessageBox/messagebox2.png prompt MessageBox}
13 {@img Ext.window.MessageBox/messagebox3.png show MessageBox}
17 Ext.Msg.alert('Status', 'Changes saved successfully.');
19 // Prompt for user data and process the result using a callback:
20 Ext.Msg.prompt('Name', 'Please enter your name:', function(btn, text){
22 // process text value and close...
26 // Show a dialog using config options:
28 title:'Save Changes?',
29 msg: 'You are closing a tab that has unsaved changes. Would you like to save your changes?',
30 buttons: Ext.Msg.YESNOCANCEL,
32 animateTarget: 'elId',
33 icon: Ext.window.MessageBox.QUESTION
40 Ext.define('Ext.window.MessageBox', {
41 extend: 'Ext.window.Window',
44 'Ext.toolbar.Toolbar',
45 'Ext.form.field.Text',
46 'Ext.form.field.TextArea',
48 'Ext.layout.container.Anchor',
49 'Ext.layout.container.HBox',
53 alternateClassName: 'Ext.MessageBox',
55 alias: 'widget.messagebox',
57 <span id='Ext-window.MessageBox-property-OK'> /**
58 </span> * Button config that displays a single OK button
62 <span id='Ext-window.MessageBox-property-YES'> /**
63 </span> * Button config that displays a single Yes button
67 <span id='Ext-window.MessageBox-property-NO'> /**
68 </span> * Button config that displays a single No button
72 <span id='Ext-window.MessageBox-property-CANCEL'> /**
73 </span> * Button config that displays a single Cancel button
77 <span id='Ext-window.MessageBox-property-OKCANCEL'> /**
78 </span> * Button config that displays OK and Cancel buttons
82 <span id='Ext-window.MessageBox-property-YESNO'> /**
83 </span> * Button config that displays Yes and No buttons
87 <span id='Ext-window.MessageBox-property-YESNOCANCEL'> /**
88 </span> * Button config that displays Yes, No and Cancel buttons
92 <span id='Ext-window.MessageBox-property-INFO'> /**
93 </span> * The CSS class that provides the INFO icon image
97 <span id='Ext-window.MessageBox-property-WARNING'> /**
98 </span> * The CSS class that provides the WARNING icon image
101 WARNING : 'ext-mb-warning',
102 <span id='Ext-window.MessageBox-property-QUESTION'> /**
103 </span> * The CSS class that provides the QUESTION icon image
106 QUESTION : 'ext-mb-question',
107 <span id='Ext-window.MessageBox-property-ERROR'> /**
108 </span> * The CSS class that provides the ERROR icon image
111 ERROR : 'ext-mb-error',
113 // hide it by offsets. Windows are hidden on render by default.
127 cls: Ext.baseCSSPrefix + 'message-box',
133 <span id='Ext-window.MessageBox-property-defaultTextHeight'> /**
134 </span> * The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)
137 defaultTextHeight : 75,
138 <span id='Ext-window.MessageBox-property-minProgressWidth'> /**
139 </span> * The minimum width in pixels of the message box if it is a progress-style dialog. This is useful
140 * for setting a different minimum width than text-only dialogs may need (defaults to 250).
143 minProgressWidth : 250,
144 <span id='Ext-window.MessageBox-property-minPromptWidth'> /**
145 </span> * The minimum width in pixels of the message box if it is a prompt dialog. This is useful
146 * for setting a different minimum width than text-only dialogs may need (defaults to 250).
150 <span id='Ext-window.MessageBox-property-buttonText'> /**
151 </span> * An object containing the default button text strings that can be overriden for localized language support.
152 * Supported properties are: ok, cancel, yes and no. Generally you should include a locale-specific
153 * resource file for handling language support across the framework.
154 * Customize the default text like so: Ext.window.MessageBox.buttonText.yes = "oui"; //french
165 'ok', 'yes', 'no', 'cancel'
177 makeButton: function(btnIdx) {
178 var btnId = this.buttonIds[btnIdx];
179 return Ext.create('Ext.button.Button', {
180 handler: this.btnCallback,
183 text: this.buttonText[btnId],
188 btnCallback: function(btn) {
193 if (me.cfg.prompt || me.cfg.multiline) {
194 if (me.cfg.multiline) {
197 field = me.textField;
199 value = field.getValue();
203 // Important not to have focus remain in the hidden Window; Interferes with DnD.
206 me.userCallback(btn.itemId, value, me.cfg);
212 me.progressBar.reset();
213 me.removeCls(me.cfg.cls);
217 initComponent: function() {
221 me.title = '&#160;';
223 me.topContainer = Ext.create('Ext.container.Container', {
230 me.iconComponent = Ext.create('Ext.Component', {
233 height: me.iconHeight,
238 me.promptContainer = Ext.create('Ext.container.Container', {
243 me.msg = Ext.create('Ext.Component', {
244 autoEl: { tag: 'span' },
247 me.textField = Ext.create('Ext.form.field.Text', {
249 enableKeyEvents: true,
251 keydown: me.onPromptKey,
255 me.textArea = Ext.create('Ext.form.field.TextArea', {
263 me.progressBar = Ext.create('Ext.ProgressBar', {
265 style: 'margin-left:10px'
268 me.items = [me.topContainer, me.progressBar];
270 // Create the buttons based upon passed bitwise config
272 for (i = 0; i < 4; i++) {
273 button = me.makeButton(i);
274 me.msgButtons[button.itemId] = button;
275 me.msgButtons.push(button);
277 me.bottomTb = Ext.create('Ext.toolbar.Toolbar', {
290 me.dockedItems = [me.bottomTb];
295 onPromptKey: function(textField, e) {
299 if (e.keyCode === Ext.EventObject.RETURN || e.keyCode === 10) {
300 if (me.msgButtons.ok.isVisible()) {
302 me.msgButtons.ok.handler.call(me, me.msgButtons.ok);
303 } else if (me.msgButtons.yes.isVisible()) {
304 me.msgButtons.yes.handler.call(me, me.msgButtons.yes);
314 reconfigure: function(cfg) {
316 buttons = cfg.buttons || 0,
318 initialWidth = me.maxWidth,
324 initialWidth = cfg.width;
327 // Default to allowing the Window to take focus.
328 delete me.defaultFocus;
330 // clear any old animateTarget
331 me.animateTarget = cfg.animateTarget || undefined;
334 me.modal = cfg.modal !== false;
338 me.setTitle(cfg.title||'&#160;');
342 me.width = initialWidth;
343 me.render(Ext.getBody());
345 me.setSize(initialWidth, me.maxHeight);
347 me.setPosition(-10000, -10000);
349 // Hide or show the close tool
350 me.closable = cfg.closable && !cfg.wait;
351 if (cfg.closable === false) {
352 me.tools.close.hide();
354 me.tools.close.show();
357 // Hide or show the header
358 if (!cfg.title && !me.closable) {
364 // Default to dynamic drag: drag the window, not a ghost
365 me.liveDrag = !cfg.proxyDrag;
367 // wrap the user callback
368 me.userCallback = Ext.Function.bind(cfg.callback ||cfg.fn || Ext.emptyFn, cfg.scope || Ext.global);
370 // Hide or show the icon Component
371 me.setIcon(cfg.icon);
373 // Hide or show the message area
375 me.msg.update(cfg.msg);
381 // Hide or show the input field
382 if (cfg.prompt || cfg.multiline) {
383 me.multiline = cfg.multiline;
385 me.textArea.setValue(cfg.value);
386 me.textArea.setHeight(cfg.defaultTextHeight || me.defaultTextHeight);
389 me.defaultFocus = me.textArea;
391 me.textField.setValue(cfg.value);
394 me.defaultFocus = me.textField;
401 // Hide or show the progress bar
402 if (cfg.progress || cfg.wait) {
403 me.progressBar.show();
404 me.updateProgress(0, cfg.progressText);
405 if(cfg.wait === true){
406 me.progressBar.wait(cfg.waitConfig);
409 me.progressBar.hide();
412 // Hide or show buttons depending on flag value sent.
413 for (i = 0; i < 4; i++) {
414 if (buttons & Math.pow(2, i)) {
416 // Default to focus on the first visible button if focus not already set
417 if (!me.defaultFocus) {
418 me.defaultFocus = me.msgButtons[i];
420 me.msgButtons[i].show();
423 me.msgButtons[i].hide();
427 // Hide toolbar if no buttons to show
436 <span id='Ext-window.MessageBox-method-show'> /**
437 </span> * Displays a new message box, or reinitializes an existing message box, based on the config options
438 * passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,
439 * although those calls are basic shortcuts and do not support all of the config options allowed here.
440 * @param {Object} config The following config options are supported: <ul>
441 * <li><b>animateTarget</b> : String/Element<div class="sub-desc">An id or Element from which the message box should animate as it
442 * opens and closes (defaults to undefined)</div></li>
443 * <li><b>buttons</b> : Number<div class="sub-desc">A bitwise button specifier consisting of the sum of any of the following constants:<ul>
444 * <li>Ext.window.MessageBox.OK</li>
445 * <li>Ext.window.MessageBox.YES</li>
446 * <li>Ext.window.MessageBox.NO</li>
447 * <li>Ext.window.MessageBox.CANCEL</li>
448 * </ul>Or false to not show any buttons (defaults to false)</div></li>
449 * <li><b>closable</b> : Boolean<div class="sub-desc">False to hide the top-right close button (defaults to true). Note that
450 * progress and wait dialogs will ignore this property and always hide the close button as they can only
451 * be closed programmatically.</div></li>
452 * <li><b>cls</b> : String<div class="sub-desc">A custom CSS class to apply to the message box's container element</div></li>
453 * <li><b>defaultTextHeight</b> : Number<div class="sub-desc">The default height in pixels of the message box's multiline textarea
454 * if displayed (defaults to 75)</div></li>
455 * <li><b>fn</b> : Function<div class="sub-desc">A callback function which is called when the dialog is dismissed either
456 * by clicking on the configured buttons, or on the dialog close button, or by pressing
457 * the return button to enter input.
458 * <p>Progress and wait dialogs will ignore this option since they do not respond to user
459 * actions and can only be closed programmatically, so any required function should be called
460 * by the same code after it closes the dialog. Parameters passed:<ul>
461 * <li><b>buttonId</b> : String<div class="sub-desc">The ID of the button pressed, one of:<div class="sub-desc"><ul>
462 * <li><tt>ok</tt></li>
463 * <li><tt>yes</tt></li>
464 * <li><tt>no</tt></li>
465 * <li><tt>cancel</tt></li>
466 * </ul></div></div></li>
467 * <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>
468 * or <tt><a href="#show-option-multiline" ext:member="show-option-multiline" ext:cls="Ext.window.MessageBox">multiline</a></tt> is true</div></li>
469 * <li><b>opt</b> : Object<div class="sub-desc">The config object passed to show.</div></li>
470 * </ul></p></div></li>
471 * <li><b>scope</b> : Object<div class="sub-desc">The scope (<code>this</code> reference) in which the function will be executed.</div></li>
472 * <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
473 * dialog (e.g. Ext.window.MessageBox.WARNING or 'custom-class') (defaults to '')</div></li>
474 * <li><b>iconCls</b> : String<div class="sub-desc">The standard {@link Ext.window.Window#iconCls} to
475 * add an optional header icon (defaults to '')</div></li>
476 * <li><b>maxWidth</b> : Number<div class="sub-desc">The maximum width in pixels of the message box (defaults to 600)</div></li>
477 * <li><b>minWidth</b> : Number<div class="sub-desc">The minimum width in pixels of the message box (defaults to 100)</div></li>
478 * <li><b>modal</b> : Boolean<div class="sub-desc">False to allow user interaction with the page while the message box is
479 * displayed (defaults to true)</div></li>
480 * <li><b>msg</b> : String<div class="sub-desc">A string that will replace the existing message box body text (defaults to the
481 * XHTML-compliant non-breaking space character '&amp;#160;')</div></li>
482 * <li><a id="show-option-multiline"></a><b>multiline</b> : Boolean<div class="sub-desc">
483 * True to prompt the user to enter multi-line text (defaults to false)</div></li>
484 * <li><b>progress</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
485 * <li><b>progressText</b> : String<div class="sub-desc">The text to display inside the progress bar if progress = true (defaults to '')</div></li>
486 * <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>
487 * <li><b>proxyDrag</b> : Boolean<div class="sub-desc">True to display a lightweight proxy while dragging (defaults to false)</div></li>
488 * <li><b>title</b> : String<div class="sub-desc">The title text</div></li>
489 * <li><b>value</b> : String<div class="sub-desc">The string value to set into the active textbox element if displayed</div></li>
490 * <li><b>wait</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
491 * <li><b>waitConfig</b> : Object<div class="sub-desc">A {@link Ext.ProgressBar#waitConfig} object (applies only if wait = true)</div></li>
492 * <li><b>width</b> : Number<div class="sub-desc">The width of the dialog in pixels</div></li>
495 * <pre><code>
498 msg: 'Please enter your address:',
500 buttons: Ext.window.MessageBox.OKCANCEL,
503 animateTarget: 'addAddressBtn',
504 icon: Ext.window.MessageBox.INFO
506 </code></pre>
507 * @return {Ext.window.MessageBox} this
509 show: function(cfg) {
514 if (cfg.animateTarget) {
515 me.doAutoSize(false);
524 afterShow: function(){
525 if (this.animateTarget) {
528 this.callParent(arguments);
531 doAutoSize: function(center) {
533 icon = me.iconComponent,
534 iconHeight = me.iconHeight;
536 if (!Ext.isDefined(me.frameWidth)) {
537 me.frameWidth = me.el.getWidth() - me.body.getWidth();
540 // reset to the original dimensions
541 icon.setHeight(iconHeight);
543 // Allow per-invocation override of minWidth
544 me.minWidth = me.cfg.minWidth || Ext.getClass(this).prototype.minWidth;
546 // Set best possible size based upon allowing the text to wrap in the maximized Window, and
547 // then constraining it to within the max with. Then adding up constituent element heights.
548 me.topContainer.doLayout();
549 if (Ext.isIE6 || Ext.isIEQuirks) {
550 // In IE quirks, the initial full width of the prompt fields will prevent the container element
551 // from collapsing once sized down, so temporarily force them to a small width. They'll get
552 // layed out to their final width later when setting the final window size.
553 me.textField.setCalculatedSize(9);
554 me.textArea.setCalculatedSize(9);
556 var width = me.cfg.width || me.msg.getWidth() + icon.getWidth() + 25, /* topContainer's layout padding */
557 height = (me.header.rendered ? me.header.getHeight() : 0) +
558 Math.max(me.promptContainer.getHeight(), icon.getHeight()) +
559 me.progressBar.getHeight() +
560 (me.bottomTb.rendered ? me.bottomTb.getHeight() : 0) + 20 ;/* topContainer's layout padding */
562 // Update to the size of the content, this way the text won't wrap under the icon.
563 icon.setHeight(Math.max(iconHeight, me.msg.getHeight()));
564 me.setSize(width + me.frameWidth, height + me.frameWidth);
571 updateText: function(text) {
572 this.msg.update(text);
573 return this.doAutoSize(true);
576 <span id='Ext-window.MessageBox-method-setIcon'> /**
577 </span> * Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default
578 * styling, and the class passed in is expected to supply the background image url. Pass in empty string ('')
579 * to clear any existing icon. This method must be called before the MessageBox is shown.
580 * The following built-in icon classes are supported, but you can also pass in a custom class name:
582 Ext.window.MessageBox.INFO
583 Ext.window.MessageBox.WARNING
584 Ext.window.MessageBox.QUESTION
585 Ext.window.MessageBox.ERROR
587 * @param {String} icon A CSS classname specifying the icon's background image url, or empty string to clear the icon
588 * @return {Ext.window.MessageBox} this
590 setIcon : function(icon) {
592 me.iconComponent.removeCls(me.iconCls);
594 me.iconComponent.show();
595 me.iconComponent.addCls(Ext.baseCSSPrefix + 'dlg-icon');
596 me.iconComponent.addCls(me.iconCls = icon);
598 me.iconComponent.removeCls(Ext.baseCSSPrefix + 'dlg-icon');
599 me.iconComponent.hide();
604 <span id='Ext-window.MessageBox-method-updateProgress'> /**
605 </span> * Updates a progress-style message box's text and progress bar. Only relevant on message boxes
606 * initiated via {@link Ext.window.MessageBox#progress} or {@link Ext.window.MessageBox#wait},
607 * or by calling {@link Ext.window.MessageBox#show} with progress: true.
608 * @param {Number} value Any number between 0 and 1 (e.g., .5, defaults to 0)
609 * @param {String} progressText The progress text to display inside the progress bar (defaults to '')
610 * @param {String} msg The message box's body text is replaced with the specified string (defaults to undefined
611 * so that any existing body text will not get overwritten by default unless a new value is passed in)
612 * @return {Ext.window.MessageBox} this
614 updateProgress : function(value, progressText, msg){
615 this.progressBar.updateProgress(value, progressText);
617 this.updateText(msg);
623 if (this.closable !== false) {
624 this.callParent(arguments);
628 <span id='Ext-window.MessageBox-method-confirm'> /**
629 </span> * Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).
630 * If a callback function is passed it will be called after the user clicks either button,
631 * and the id of the button that was clicked will be passed as the only parameter to the callback
632 * (could also be the top-right close button).
633 * @param {String} title The title bar text
634 * @param {String} msg The message box body text
635 * @param {Function} fn (optional) The callback function invoked after the message box is closed
636 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.
637 * @return {Ext.window.MessageBox} this
639 confirm: function(cfg, msg, fn, scope) {
640 if (Ext.isString(cfg)) {
643 icon: 'ext-mb-question',
650 return this.show(cfg);
653 <span id='Ext-window.MessageBox-method-prompt'> /**
654 </span> * Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).
655 * The prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user
656 * clicks either button, and the id of the button that was clicked (could also be the top-right
657 * close button) and the text that was entered will be passed as the two parameters to the callback.
658 * @param {String} title The title bar text
659 * @param {String} msg The message box body text
660 * @param {Function} fn (optional) The callback function invoked after the message box is closed
661 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.
662 * @param {Boolean/Number} multiline (optional) True to create a multiline textbox using the defaultTextHeight
663 * property, or the height in pixels to create the textbox (defaults to false / single-line)
664 * @param {String} value (optional) Default value of the text input element (defaults to '')
665 * @return {Ext.window.MessageBox} this
667 prompt : function(cfg, msg, fn, scope, multiline, value){
668 if (Ext.isString(cfg)) {
672 minWidth: this.minPromptWidth,
674 buttons: this.OKCANCEL,
677 multiline: multiline,
681 return this.show(cfg);
684 <span id='Ext-window.MessageBox-method-wait'> /**
685 </span> * Displays a message box with an infinitely auto-updating progress bar. This can be used to block user
686 * interaction while waiting for a long-running process to complete that does not have defined intervals.
687 * You are responsible for closing the message box when the process is complete.
688 * @param {String} msg The message box body text
689 * @param {String} title (optional) The title bar text
690 * @param {Object} config (optional) A {@link Ext.ProgressBar#waitConfig} object
691 * @return {Ext.window.MessageBox} this
693 wait : function(cfg, title, config){
694 if (Ext.isString(cfg)) {
701 minWidth: this.minProgressWidth,
705 return this.show(cfg);
708 <span id='Ext-window.MessageBox-method-alert'> /**
709 </span> * Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).
710 * If a callback function is passed it will be called after the user clicks the button, and the
711 * id of the button that was clicked will be passed as the only parameter to the callback
712 * (could also be the top-right close button).
713 * @param {String} title The title bar text
714 * @param {String} msg The message box body text
715 * @param {Function} fn (optional) The callback function invoked after the message box is closed
716 * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.
717 * @return {Ext.window.MessageBox} this
719 alert: function(cfg, msg, fn, scope) {
720 if (Ext.isString(cfg)) {
727 minWidth: this.minWidth
730 return this.show(cfg);
733 <span id='Ext-window.MessageBox-method-progress'> /**
734 </span> * Displays a message box with a progress bar. This message box has no buttons and is not closeable by
735 * the user. You are responsible for updating the progress bar as needed via {@link Ext.window.MessageBox#updateProgress}
736 * and closing the message box when the process is complete.
737 * @param {String} title The title bar text
738 * @param {String} msg The message box body text
739 * @param {String} progressText (optional) The text to display inside the progress bar (defaults to '')
740 * @return {Ext.window.MessageBox} this
742 progress : function(cfg, msg, progressText){
743 if (Ext.isString(cfg)) {
747 progressText: progressText
750 return this.show(cfg);
753 Ext.MessageBox = Ext.Msg = new this();
754 });</pre></pre></body></html>