- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.MessageBox-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.MessageBox-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.MessageBox-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="bookmark" href="../docs/?class=Ext.MessageBox"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.MessageBox</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/MessageBox.js" target="_blank">MessageBox.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">MessageBox</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- *
-<p>Utility class for generating different styles of message boxes. The alias Ext.Msg can also be used.<p/>
-<p>Note that the MessageBox is asynchronous. Unlike a regular JavaScript <code>alert</code> (which will halt
-browser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code
-that should only run <em>after</em> some user feedback from the MessageBox, you must use a callback function
-(see the <code>function</code> parameter for <a ext:cls="Ext.MessageBox" ext:member="show" href="output/Ext.MessageBox.html#show">show</a> for more details).</p>
-<p>Example usage:</p>
-<pre><code><i>// Basic alert:</i>
-Ext.Msg.alert(<em>'Status'</em>, <em>'Changes saved successfully.'</em>);
-
-<i>// Prompt <b>for</b> user data and process the result using a callback:</i>
-Ext.Msg.prompt(<em>'Name'</em>, <em>'Please enter your name:'</em>, <b>function</b>(btn, text){
- <b>if</b> (btn == <em>'ok'</em>){
- <i>// process text value and close...</i>
- }
-});
-
-<i>// Show a dialog using config options:</i>
-Ext.Msg.show({
- title:<em>'Save Changes?'</em>,
- msg: <em>'You are closing a tab that has unsaved changes. Would you like to save your changes?'</em>,
- buttons: Ext.Msg.YESNOCANCEL,
- fn: processResult,
- animEl: <em>'elId'</em>,
- icon: Ext.MessageBox.QUESTION
-});</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i> </div>
-
- <div class="hr"></div>
- <a id="Ext.MessageBox-props"></a>
- <h2>Public Properties</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Property</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-CANCEL"></a>\r
- <b>CANCEL</b> : Object <div class="mdesc">\r
- Button config that displays a single Cancel button </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-ERROR"></a>\r
- <b>ERROR</b> : String <div class="mdesc">\r
- The CSS class that provides the ERROR icon image </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-INFO"></a>\r
- <b>INFO</b> : String <div class="mdesc">\r
- The CSS class that provides the INFO icon image </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-OK"></a>\r
- <b>OK</b> : Object <div class="mdesc">\r
- Button config that displays a single OK button </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-OKCANCEL"></a>\r
- <b>OKCANCEL</b> : Object <div class="mdesc">\r
- Button config that displays OK and Cancel buttons </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-QUESTION"></a>\r
- <b>QUESTION</b> : String <div class="mdesc">\r
- The CSS class that provides the QUESTION icon image </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-WARNING"></a>\r
- <b>WARNING</b> : String <div class="mdesc">\r
- The CSS class that provides the WARNING icon image </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-YESNO"></a>\r
- <b>YESNO</b> : Object <div class="mdesc">\r
- Button config that displays Yes and No buttons </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-YESNOCANCEL"></a>\r
- <b>YESNOCANCEL</b> : Object <div class="mdesc">\r
- Button config that displays Yes, No and Cancel buttons </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-buttonText"></a>\r
- <b>buttonText</b> : Object <div class="mdesc">\r
- <div class="short">An object containing the default button text strings that can be overriden for localized language support.
-Supported ...</div>\r
- <div class="long">\r
- An object containing the default button text strings that can be overriden for localized language support.
-Supported properties are: ok, cancel, yes and no. Generally you should include a locale-specific
-resource file for handling language support across the framework.
-Customize the default text like so: Ext.MessageBox.buttonText.yes = "oui"; //french </div>\r
- </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-defaultTextHeight"></a>\r
- <b>defaultTextHeight</b> : Number <div class="mdesc">\r
- The default height in pixels of the message box's multiline textarea if displayed (defaults to 75) </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-maxWidth"></a>\r
- <b>maxWidth</b> : Number <div class="mdesc">\r
- The maximum width in pixels of the message box (defaults to 600) </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-minProgressWidth"></a>\r
- <b>minProgressWidth</b> : Number <div class="mdesc">\r
- <div class="short">The minimum width in pixels of the message box if it is a progress-style dialog. This is useful
-for setting a differ...</div>\r
- <div class="long">\r
- The minimum width in pixels of the message box if it is a progress-style dialog. This is useful
-for setting a different minimum width than text-only dialogs may need (defaults to 250) </div>\r
- </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="property-row alt">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-minWidth"></a>\r
- <b>minWidth</b> : Number <div class="mdesc">\r
- The minimum width in pixels of the message box (defaults to 100) </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- </table>
- <a id="Ext.MessageBox-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-alert"></a>\r
- <b>alert</b>( <code>String title</code>, <code>String msg</code>, <span class="optional" title="Optional">[<code>Function fn</code>]</span>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Ext.MessageBox <div class="mdesc">\r
- <div class="short">Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).
-If a c...</div>\r
- <div class="long">\r
- Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).
-If a callback function is passed it will be called after the user clicks the button, and the
-id of the button that was clicked will be passed as the only parameter to the callback
-(could also be the top-right close button). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>title</code> : String<div class="sub-desc">The title bar text</div></li><li><code>msg</code> : String<div class="sub-desc">The message box body text</div></li><li><code>fn</code> : Function<div class="sub-desc">(optional) The callback function invoked after the message box is closed</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the callback function</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-confirm"></a>\r
- <b>confirm</b>( <code>String title</code>, <code>String msg</code>, <span class="optional" title="Optional">[<code>Function fn</code>]</span>, <span class="optional" title="Optional">[<code>Object scope</code>]</span> ) : Ext.MessageBox <div class="mdesc">\r
- <div class="short">Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).
-If a callback funct...</div>\r
- <div class="long">\r
- Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).
-If a callback function is passed it will be called after the user clicks either button,
-and the id of the button that was clicked will be passed as the only parameter to the callback
-(could also be the top-right close button). <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>title</code> : String<div class="sub-desc">The title bar text</div></li><li><code>msg</code> : String<div class="sub-desc">The message box body text</div></li><li><code>fn</code> : Function<div class="sub-desc">(optional) The callback function invoked after the message box is closed</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the callback function</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-getDialog"></a>\r
- <b>getDialog</b>() : Ext.Window <div class="mdesc">\r
- <div class="short">Returns a reference to the underlying <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a> element</div>\r
- <div class="long">\r
- Returns a reference to the underlying <a ext:cls="Ext.Window" href="output/Ext.Window.html">Ext.Window</a> element <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.Window</code><div class="sub-desc">The window</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-hide"></a>\r
- <b>hide</b>() : Ext.MessageBox <div class="mdesc">\r
- <div class="short">Hides the message box if it is displayed</div>\r
- <div class="long">\r
- Hides the message box if it is displayed <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-isVisible"></a>\r
- <b>isVisible</b>() : Boolean <div class="mdesc">\r
- <div class="short">Returns true if the message box is currently displayed</div>\r
- <div class="long">\r
- Returns true if the message box is currently displayed <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li>None.</li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Boolean</code><div class="sub-desc">True if the message box is visible, else false</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-progress"></a>\r
- <b>progress</b>( <code>String title</code>, <code>String msg</code>, <span class="optional" title="Optional">[<code>String progressText</code>]</span> ) : Ext.MessageBox <div class="mdesc">\r
- <div class="short">Displays a message box with a progress bar. This message box has no buttons and is not closeable by
-the user. You a...</div>\r
- <div class="long">\r
- Displays a message box with a progress bar. This message box has no buttons and is not closeable by
-the user. You are responsible for updating the progress bar as needed via <a ext:cls="Ext.MessageBox" ext:member="updateProgress" href="output/Ext.MessageBox.html#updateProgress">Ext.MessageBox.updateProgress</a>
-and closing the message box when the process is complete. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>title</code> : String<div class="sub-desc">The title bar text</div></li><li><code>msg</code> : String<div class="sub-desc">The message box body text</div></li><li><code>progressText</code> : String<div class="sub-desc">(optional) The text to display inside the progress bar (defaults to '')</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="method-row expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-prompt"></a>\r
- <b>prompt</b>( <code>String title</code>, <code>String msg</code>, <span class="optional" title="Optional">[<code>Function fn</code>]</span>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Boolean/Number multiline</code>]</span>, <span class="optional" title="Optional">[<code>String value</code>]</span> ) : Ext.MessageBox <div class="mdesc">\r
- <div class="short">Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's p...</div>\r
- <div class="long">\r
- Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).
-The prompt can be a single-line or multi-line textbox. If a callback function is passed it will be called after the user
-clicks either button, and the id of the button that was clicked (could also be the top-right
-close button) and the text that was entered will be passed as the two parameters to the callback. <div class="mdetail-params">\r
- <strong>Parameters:</strong>\r
- <ul><li><code>title</code> : String<div class="sub-desc">The title bar text</div></li><li><code>msg</code> : String<div class="sub-desc">The message box body text</div></li><li><code>fn</code> : Function<div class="sub-desc">(optional) The callback function invoked after the message box is closed</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope of the callback function</div></li><li><code>multiline</code> : Boolean/Number<div class="sub-desc">(optional) True to create a multiline textbox using the defaultTextHeight
-property, or the height in pixels to create the textbox (defaults to false / single-line)</div></li><li><code>value</code> : String<div class="sub-desc">(optional) Default value of the text input element (defaults to '')</div></li> </ul>\r
- <strong>Returns:</strong>\r
- <ul>\r
- <li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li>\r
- </ul>\r
- </div>\r
- </div>\r
- </div>\r
- </td>\r
- <td class="msource">MessageBox</td>\r
- </tr>\r
- <tr class="method-row alt expandable">\r
- <td class="micon"><a class="exi" href="#expand"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.MessageBox-setIcon"></a>\r
- <b>setIcon</b>( <code>String icon</code> ) : Ext.MessageBox <div class="mdesc">\r
- <div class="short">Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default
-styling, and the c...</div>\r
- <div class="long">\r
- Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default
-styling, and the class passed in is expected to supply the background image url. Pass in empty string ('')
-to clear any existing icon. The following built-in icon classes are supported, but you can also pass
-in a custom class name:
-<pre>Ext.MessageBox.INFO\r
+<div xmlns:ext="http://www.extjs.com" class="body-wrap"><h1>Class <a href="source/MessageBox.html#cls-Ext.MessageBox">Ext.MessageBox</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">MessageBox.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/MessageBox.html#cls-Ext.MessageBox">MessageBox</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>Utility class for generating different styles of message boxes. The alias Ext.Msg can also be used.<p/>\r
+<p>Note that the MessageBox is asynchronous. Unlike a regular JavaScript <code>alert</code> (which will halt\r
+browser execution), showing a MessageBox will not cause the code to stop. For this reason, if you have code\r
+that should only run <em>after</em> some user feedback from the MessageBox, you must use a callback function\r
+(see the <code><b>function</b></code> parameter for <a href="output/Ext.MessageBox.html#Ext.MessageBox-show" ext:member="show" ext:cls="Ext.MessageBox">show</a> for more details).</p>\r
+<p>Example usage:</p>\r
+<pre><code><i>// Basic alert:\r</i>
+Ext.Msg.alert(<em>'Status'</em>, <em>'Changes saved successfully.'</em>);\r
+\r
+<i>// Prompt <b>for</b> user data and process the result using a callback:\r</i>
+Ext.Msg.prompt(<em>'Name'</em>, <em>'Please enter your name:'</em>, <b>function</b>(btn, text){\r
+ <b>if</b> (btn == <em>'ok'</em>){\r
+ <i>// process text value and close...\r</i>
+ }\r
+});\r
+\r
+<i>// Show a dialog using config options:\r</i>
+Ext.Msg.show({\r
+ title:<em>'Save Changes?'</em>,\r
+ msg: <em>'You are closing a tab that has unsaved changes. Would you like to save your changes?'</em>,\r
+ buttons: Ext.Msg.YESNOCANCEL,\r
+ fn: processResult,\r
+ animEl: <em>'elId'</em>,\r
+ icon: Ext.MessageBox.QUESTION\r
+});</code></pre><br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext.MessageBox-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-CANCEL"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-CANCEL">CANCEL</a></b> : Object<div class="mdesc">Button config that displays a single Cancel button</div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-ERROR"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-ERROR">ERROR</a></b> : String<div class="mdesc">The CSS class that provides the ERROR icon image</div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-INFO"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-INFO">INFO</a></b> : String<div class="mdesc">The CSS class that provides the INFO icon image</div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-Msg"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-Msg">Msg</a></b> : Object<div class="mdesc">Shorthand for <a href="output/Ext.MessageBox.html" ext:cls="Ext.MessageBox">Ext.MessageBox</a></div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-OK"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-OK">OK</a></b> : Object<div class="mdesc">Button config that displays a single OK button</div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-OKCANCEL"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-OKCANCEL">OKCANCEL</a></b> : Object<div class="mdesc">Button config that displays OK and Cancel buttons</div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-QUESTION"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-QUESTION">QUESTION</a></b> : String<div class="mdesc">The CSS class that provides the QUESTION icon image</div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-WARNING"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-WARNING">WARNING</a></b> : String<div class="mdesc">The CSS class that provides the WARNING icon image</div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-YESNO"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-YESNO">YESNO</a></b> : Object<div class="mdesc">Button config that displays Yes and No buttons</div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-YESNOCANCEL"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-YESNOCANCEL">YESNOCANCEL</a></b> : Object<div class="mdesc">Button config that displays Yes, No and Cancel buttons</div></td><td class="msource">MessageBox</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-buttonText"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-buttonText">buttonText</a></b> : Object<div class="mdesc"><div class="short">An object containing the default button text strings that can be overriden for localized language support. \r
+Supported...</div><div class="long">An object containing the default button text strings that can be overriden for localized language support.\r
+Supported properties are: ok, cancel, yes and no. Generally you should include a locale-specific\r
+resource file for handling language support across the framework.\r
+Customize the default text like so: Ext.MessageBox.buttonText.yes = "oui"; //french</div></div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-defaultTextHeight"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-defaultTextHeight">defaultTextHeight</a></b> : Number<div class="mdesc">The default height in pixels of the message box's multiline textarea if displayed (defaults to 75)</div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-maxWidth"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-maxWidth">maxWidth</a></b> : Number<div class="mdesc">The maximum width in pixels of the message box (defaults to 600)</div></td><td class="msource">MessageBox</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-minProgressWidth"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-minProgressWidth">minProgressWidth</a></b> : Number<div class="mdesc"><div class="short">The minimum width in pixels of the message box if it is a progress-style dialog. This is useful \r
+for setting a diffe...</div><div class="long">The minimum width in pixels of the message box if it is a progress-style dialog. This is useful\r
+for setting a different minimum width than text-only dialogs may need (defaults to 250)</div></div></td><td class="msource">MessageBox</td></tr><tr class="property-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-minWidth"></a><b><a href="source/MessageBox.html#prop-Ext.MessageBox-minWidth">minWidth</a></b> : Number<div class="mdesc">The minimum width in pixels of the message box (defaults to 100)</div></td><td class="msource">MessageBox</td></tr></tbody></table><a id="Ext.MessageBox-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-alert"></a><b><a href="source/MessageBox.html#method-Ext.MessageBox-alert">alert</a></b>( <code>String title</code>, <code>String msg</code>, <span title="Optional" class="optional">[<code>Function fn</code>]</span>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
+ :\r
+ Ext.MessageBox<div class="mdesc"><div class="short">Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt). \r
+If a ...</div><div class="long">Displays a standard read-only message box with an OK button (comparable to the basic JavaScript alert prompt).\r
+If a callback function is passed it will be called after the user clicks the button, and the\r
+id of the button that was clicked will be passed as the only parameter to the callback\r
+(could also be the top-right close button).<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>title</code> : String<div class="sub-desc">The title bar text</div></li><li><code>msg</code> : String<div class="sub-desc">The message box body text</div></li><li><code>fn</code> : Function<div class="sub-desc">(optional) The callback function invoked after the message box is closed</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">MessageBox</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-confirm"></a><b><a href="source/MessageBox.html#method-Ext.MessageBox-confirm">confirm</a></b>( <code>String title</code>, <code>String msg</code>, <span title="Optional" class="optional">[<code>Function fn</code>]</span>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
+ :\r
+ Ext.MessageBox<div class="mdesc"><div class="short">Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm). \r
+If a callback func...</div><div class="long">Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's confirm).\r
+If a callback function is passed it will be called after the user clicks either button,\r
+and the id of the button that was clicked will be passed as the only parameter to the callback\r
+(could also be the top-right close button).<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>title</code> : String<div class="sub-desc">The title bar text</div></li><li><code>msg</code> : String<div class="sub-desc">The message box body text</div></li><li><code>fn</code> : Function<div class="sub-desc">(optional) The callback function invoked after the message box is closed</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">MessageBox</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-getDialog"></a><b><a href="source/MessageBox.html#method-Ext.MessageBox-getDialog">getDialog</a></b>()\r
+ :\r
+ Ext.Window<div class="mdesc"><div class="short">Returns a reference to the underlying Ext.Window element</div><div class="long">Returns a reference to the underlying <a href="output/Ext.Window.html" ext:cls="Ext.Window">Ext.Window</a> element<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Window</code><div class="sub-desc">The window</div></li></ul></div></div></div></td><td class="msource">MessageBox</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-hide"></a><b><a href="source/MessageBox.html#method-Ext.MessageBox-hide">hide</a></b>()\r
+ :\r
+ Ext.MessageBox<div class="mdesc"><div class="short">Hides the message box if it is displayed</div><div class="long">Hides the message box if it is displayed<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">MessageBox</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-isVisible"></a><b><a href="source/MessageBox.html#method-Ext.MessageBox-isVisible">isVisible</a></b>()\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the message box is currently displayed</div><div class="long">Returns true if the message box is currently displayed<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the message box is visible, else false</div></li></ul></div></div></div></td><td class="msource">MessageBox</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-progress"></a><b><a href="source/MessageBox.html#method-Ext.MessageBox-progress">progress</a></b>( <code>String title</code>, <code>String msg</code>, <span title="Optional" class="optional">[<code>String progressText</code>]</span> )\r
+ :\r
+ Ext.MessageBox<div class="mdesc"><div class="short">Displays a message box with a progress bar. This message box has no buttons and is not closeable by \r
+the user. You ...</div><div class="long">Displays a message box with a progress bar. This message box has no buttons and is not closeable by\r
+the user. You are responsible for updating the progress bar as needed via <a href="output/Ext.MessageBox.html#Ext.MessageBox-updateProgress" ext:member="updateProgress" ext:cls="Ext.MessageBox">Ext.MessageBox.updateProgress</a>\r
+and closing the message box when the process is complete.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>title</code> : String<div class="sub-desc">The title bar text</div></li><li><code>msg</code> : String<div class="sub-desc">The message box body text</div></li><li><code>progressText</code> : String<div class="sub-desc">(optional) The text to display inside the progress bar (defaults to '')</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">MessageBox</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-prompt"></a><b><a href="source/MessageBox.html#method-Ext.MessageBox-prompt">prompt</a></b>( <code>String title</code>, <code>String msg</code>, <span title="Optional" class="optional">[<code>Function fn</code>]</span>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Boolean/Number multiline</code>]</span>, <span title="Optional" class="optional">[<code>String value</code>]</span> )\r
+ :\r
+ Ext.MessageBox<div class="mdesc"><div class="short">Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's p...</div><div class="long">Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to JavaScript's prompt).\r
+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
+clicks either button, and the id of the button that was clicked (could also be the top-right\r
+close button) and the text that was entered will be passed as the two parameters to the callback.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>title</code> : String<div class="sub-desc">The title bar text</div></li><li><code>msg</code> : String<div class="sub-desc">The message box body text</div></li><li><code>fn</code> : Function<div class="sub-desc">(optional) The callback function invoked after the message box is closed</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code>this</code> reference) in which the callback is executed. Defaults to the browser wnidow.</div></li><li><code>multiline</code> : Boolean/Number<div class="sub-desc">(optional) True to create a multiline textbox using the defaultTextHeight\r
+property, or the height in pixels to create the textbox (defaults to false / single-line)</div></li><li><code>value</code> : String<div class="sub-desc">(optional) Default value of the text input element (defaults to '')</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.MessageBox</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource">MessageBox</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.MessageBox-setIcon"></a><b><a href="source/MessageBox.html#method-Ext.MessageBox-setIcon">setIcon</a></b>( <code>String icon</code> )\r
+ :\r
+ Ext.MessageBox<div class="mdesc"><div class="short">Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default \r
+styling, and the ...</div><div class="long">Adds the specified icon to the dialog. By default, the class 'ext-mb-icon' is applied for default\r
+styling, and the class passed in is expected to supply the background image url. Pass in empty string ('')\r
+to clear any existing icon. This method must be called before the MessageBox is shown.\r
+The following built-in icon classes are supported, but you can also pass in a custom class name:\r
+<pre>\r
+Ext.MessageBox.INFO\r
git.ithinksw.org / extjs.git / blobdiff