- Ext.MessageBox<div class="mdesc"><div class="short">Displays a new message box, or reinitializes an existing message box, based on the config options
-passed in. All disp...</div><div class="long">Displays a new message box, or reinitializes an existing message box, based on the config options
-passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,
-although those calls are basic shortcuts and do not support all of the config options allowed here.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The following config options are supported: <ul>
-<li><b>animEl</b> : String/Element<div class="sub-desc">An id or Element from which the message box should animate as it
-opens and closes (defaults to undefined)</div></li>
-<li><b>buttons</b> : Object/Boolean<div class="sub-desc">A button config object (e.g., Ext.MessageBox.OKCANCEL or {ok:'Foo',
-cancel:'Bar'}), or false to not show any buttons (defaults to false)</div></li>
-<li><b>closable</b> : Boolean<div class="sub-desc">False to hide the top-right close button (defaults to true). Note that
-progress and wait dialogs will ignore this property and always hide the close button as they can only
-be closed programmatically.</div></li>
-<li><b>cls</b> : String<div class="sub-desc">A custom CSS class to apply to the message box's container element</div></li>
-<li><b>fn</b> : Function<div class="sub-desc">A callback function which is called when the dialog is dismissed either
-by clicking on the configured buttons, or on the dialog close button, or by pressing
-the return button to enter input.
-<p>Progress and wait dialogs will ignore this option since they do not respond to user
-actions and can only be closed programmatically, so any required function should be called
-by the same code after it closes the dialog. Parameters passed:<ul>
-<li><b>buttonId</b> : String<div class="sub-desc">The ID of the button pressed, one of:<div class="sub-desc"><ul>
-<li><tt>ok</tt></li>
-<li><tt>yes</tt></li>
-<li><tt>no</tt></li>
-<li><tt>cancel</tt></li>
-</ul></div></div></li>
-<li><b>text</b> : String<div class="sub-desc">Value of the input field if either <tt><a href="#show-option-prompt" ext:member="show-option-prompt" ext:cls="Ext.MessageBox">prompt</a></tt>
-or <tt><a href="#show-option-multiline" ext:member="show-option-multiline" ext:cls="Ext.MessageBox">multiline</a></tt> is true</div></li>
-<li><b>opt</b> : Object<div class="sub-desc">The config object passed to show.</div></li>
-</ul></p></div></li>
-<li><b>scope</b> : Object<div class="sub-desc">The scope of the callback function</div></li>
-<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
-dialog (e.g. Ext.MessageBox.WARNING or 'custom-class') (defaults to '')</div></li>
-<li><b>iconCls</b> : String<div class="sub-desc">The standard <a href="output/Ext.Window.html#Ext.Window-iconCls" ext:member="iconCls" ext:cls="Ext.Window">Ext.Window.iconCls</a> to
-add an optional header icon (defaults to '')</div></li>
-<li><b>maxWidth</b> : Number<div class="sub-desc">The maximum width in pixels of the message box (defaults to 600)</div></li>
-<li><b>minWidth</b> : Number<div class="sub-desc">The minimum width in pixels of the message box (defaults to 100)</div></li>
-<li><b>modal</b> : Boolean<div class="sub-desc">False to allow user interaction with the page while the message box is
-displayed (defaults to true)</div></li>
-<li><b>msg</b> : String<div class="sub-desc">A string that will replace the existing message box body text (defaults to the
-XHTML-compliant non-breaking space character '&#160;')</div></li>
-<li><a id="show-option-multiline"></a><b>multiline</b> : Boolean/Number<div class="sub-desc">
-If <code>prompt</code> is true, instead of prompting the user with a single line textbox,
-specify <code>multiline = true</code> to prompt the user with a multiline textarea
-using the <code><a href="output/Ext.MessageBox.html#Ext.MessageBox-defaultTextHeight" ext:member="defaultTextHeight" ext:cls="Ext.MessageBox">defaultTextHeight</a></code> property, or specify a height in pixels
-to create the textarea (defaults to false creating a single-line textbox)</div></li>
-<li><b>progress</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
-<li><b>progressText</b> : String<div class="sub-desc">The text to display inside the progress bar if progress = true (defaults to '')</div></li>
-<li><a id="show-option-prompt"></a><b>prompt</b> : Boolean<div class="sub-desc">
-True to prompt the user with a textbox or textarea (defaults to false)</div></li>
-<li><b>proxyDrag</b> : Boolean<div class="sub-desc">True to display a lightweight proxy while dragging (defaults to false)</div></li>
-<li><b>title</b> : String<div class="sub-desc">The title text</div></li>
-<li><b>value</b> : String<div class="sub-desc">The string value to set into the active textbox element if displayed</div></li>
-<li><b>wait</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>
-<li><b>waitConfig</b> : Object<div class="sub-desc">A <a href="output/Ext.ProgressBar.html#Ext.ProgressBar-waitConfig" ext:member="waitConfig" ext:cls="Ext.ProgressBar">Ext.ProgressBar.waitConfig</a> object (applies only if wait = true)</div></li>
-<li><b>width</b> : Number<div class="sub-desc">The width of the dialog in pixels</div></li>
-</ul>
-Example usage:
-<pre><code>Ext.Msg.show({
- title: <em>'Address'</em>,
- msg: <em>'Please enter your address:'</em>,
- width: 300,
- buttons: Ext.MessageBox.OKCANCEL,
- multiline: true, <i>// show a multiline textarea using the <a href="output/Ext.MessageBox.html#Ext.MessageBox-defaultTextHeight" ext:member="defaultTextHeight" ext:cls="Ext.MessageBox">defaultTextHeight</a></i>
- fn: saveAddress,
- animEl: <em>'addAddressBtn'</em>,
- icon: Ext.MessageBox.INFO
+ Ext.MessageBox<div class="mdesc"><div class="short">Displays a new message box, or reinitializes an existing message box, based on the config options
+passed in. All dis...</div><div class="long">Displays a new message box, or reinitializes an existing message box, based on the config options\r
+passed in. All display functions (e.g. prompt, alert, etc.) on MessageBox call this function internally,\r
+although those calls are basic shortcuts and do not support all of the config options allowed here.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The following config options are supported: <ul>\r
+<li><b>animEl</b> : String/Element<div class="sub-desc">An id or Element from which the message box should animate as it\r
+opens and closes (defaults to undefined)</div></li>\r
+<li><b>buttons</b> : Object/Boolean<div class="sub-desc">A button config object (e.g., Ext.MessageBox.OKCANCEL or {ok:'Foo',\r
+cancel:'Bar'}), or false to not show any buttons (defaults to false)</div></li>\r
+<li><b>closable</b> : Boolean<div class="sub-desc">False to hide the top-right close button (defaults to true). Note that\r
+progress and wait dialogs will ignore this property and always hide the close button as they can only\r
+be closed programmatically.</div></li>\r
+<li><b>cls</b> : String<div class="sub-desc">A custom CSS class to apply to the message box's container element</div></li>\r
+<li><b>defaultTextHeight</b> : Number<div class="sub-desc">The default height in pixels of the message box's multiline textarea\r
+if displayed (defaults to 75)</div></li>\r
+<li><b>fn</b> : Function<div class="sub-desc">A callback function which is called when the dialog is dismissed either\r
+by clicking on the configured buttons, or on the dialog close button, or by pressing\r
+the return button to enter input.\r
+<p>Progress and wait dialogs will ignore this option since they do not respond to user\r
+actions and can only be closed programmatically, so any required function should be called\r
+by the same code after it closes the dialog. Parameters passed:<ul>\r
+<li><b>buttonId</b> : String<div class="sub-desc">The ID of the button pressed, one of:<div class="sub-desc"><ul>\r
+<li><tt>ok</tt></li>\r
+<li><tt>yes</tt></li>\r
+<li><tt>no</tt></li>\r
+<li><tt>cancel</tt></li>\r
+</ul></div></div></li>\r
+<li><b>text</b> : String<div class="sub-desc">Value of the input field if either <tt><a href="#show-option-prompt" ext:member="show-option-prompt" ext:cls="Ext.MessageBox">prompt</a></tt>\r
+or <tt><a href="#show-option-multiline" ext:member="show-option-multiline" ext:cls="Ext.MessageBox">multiline</a></tt> is true</div></li>\r
+<li><b>opt</b> : Object<div class="sub-desc">The config object passed to show.</div></li>\r
+</ul></p></div></li>\r
+<li><b>scope</b> : Object<div class="sub-desc">The scope of the callback function</div></li>\r
+<li><b>icon</b> : String<div class="sub-desc">A CSS class that provides a background image to be used as the body icon for the\r
+dialog (e.g. Ext.MessageBox.WARNING or 'custom-class') (defaults to '')</div></li>\r
+<li><b>iconCls</b> : String<div class="sub-desc">The standard <a href="output/Ext.Window.html#Ext.Window-iconCls" ext:member="iconCls" ext:cls="Ext.Window">Ext.Window.iconCls</a> to\r
+add an optional header icon (defaults to '')</div></li>\r
+<li><b>maxWidth</b> : Number<div class="sub-desc">The maximum width in pixels of the message box (defaults to 600)</div></li>\r
+<li><b>minWidth</b> : Number<div class="sub-desc">The minimum width in pixels of the message box (defaults to 100)</div></li>\r
+<li><b>modal</b> : Boolean<div class="sub-desc">False to allow user interaction with the page while the message box is\r
+displayed (defaults to true)</div></li>\r
+<li><b>msg</b> : String<div class="sub-desc">A string that will replace the existing message box body text (defaults to the\r
+XHTML-compliant non-breaking space character '&#160;')</div></li>\r
+<li><a id="show-option-multiline"></a><b>multiline</b> : Boolean<div class="sub-desc">\r
+True to prompt the user to enter multi-line text (defaults to false)</div></li>\r
+<li><b>progress</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>\r
+<li><b>progressText</b> : String<div class="sub-desc">The text to display inside the progress bar if progress = true (defaults to '')</div></li>\r
+<li><a id="show-option-prompt"></a><b>prompt</b> : Boolean<div class="sub-desc">True to prompt the user to enter single-line text (defaults to false)</div></li>\r
+<li><b>proxyDrag</b> : Boolean<div class="sub-desc">True to display a lightweight proxy while dragging (defaults to false)</div></li>\r
+<li><b>title</b> : String<div class="sub-desc">The title text</div></li>\r
+<li><b>value</b> : String<div class="sub-desc">The string value to set into the active textbox element if displayed</div></li>\r
+<li><b>wait</b> : Boolean<div class="sub-desc">True to display a progress bar (defaults to false)</div></li>\r
+<li><b>waitConfig</b> : Object<div class="sub-desc">A <a href="output/Ext.ProgressBar.html#Ext.ProgressBar-waitConfig" ext:member="waitConfig" ext:cls="Ext.ProgressBar">Ext.ProgressBar.waitConfig</a> object (applies only if wait = true)</div></li>\r
+<li><b>width</b> : Number<div class="sub-desc">The width of the dialog in pixels</div></li>\r
+</ul>\r
+Example usage:\r
+<pre><code>Ext.Msg.show({\r
+ title: <em>'Address'</em>,\r
+ msg: <em>'Please enter your address:'</em>,\r
+ width: 300,\r
+ buttons: Ext.MessageBox.OKCANCEL,\r
+ multiline: true,\r
+ fn: saveAddress,\r
+ animEl: <em>'addAddressBtn'</em>,\r
+ icon: Ext.MessageBox.INFO\r
git.ithinksw.org / extjs.git / blobdiff