--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=undefined" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+
+ <title>JsDoc Reference - Roo.bootstrap.MessageBox</title>
+
+
+ <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
+ <link rel="stylesheet" type="text/css" href="../default.css" />
+
+
+ <script type="text/javascript" src="../page.js">
+
+ </script>
+
+
+ </head>
+
+ <body onload="RooDocsPage.onload();">
+
+
+<div class="body-wrap">
+
+ <!-- ============================== links to methods. ================================= -->
+
+ <div class="top-tools">
+ <!--
+ <a class="inner-link" href="#Roo.bootstrap.MessageBox-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+ <a class="inner-link" href="#Roo.bootstrap.MessageBox-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+ <a class="inner-link" href="#Roo.bootstrap.MessageBox-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+ <a class="inner-link" href="#Roo.bootstrap.MessageBox-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+ <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+ -->
+ </div>
+
+
+<!-- ============================== inheritance Block. ================================= -->
+
+<!-- ============================== class title / details ============================ -->
+
+
+ <h1 class="classTitle">
+
+ Class Roo.bootstrap.MessageBox
+ </h1>
+
+ <table cellspacing="0" class="class-summary-table">
+
+ <tr><td class="label">Package:</td><td class="hd-info">Roo.bootstrap</td></tr>
+
+ <tr><td class="label">Defined In:</td><td class="hd-info">
+
+ <a href="./src/Roo_bootstrap_MessageBox.js.html">Roo/bootstrap/MessageBox.js</a>.
+
+ </td></tr>
+ <tr><td class="label">Class:</td><td class="hd-info">MessageBox</td></tr>
+
+
+
+
+ </table>
+
+
+<!-- ============================== class summary ========================== -->
+ <div class="description">
+ Utility class for generating different styles of message boxes. The alias Roo.Msg can also be used.<br/>Example usage:<br/><pre><code><br/>// Basic alert:<br/>Roo.Msg.alert('Status', 'Changes saved successfully.');<br/><br/>// Prompt for user data:<br/>Roo.Msg.prompt('Name', 'Please enter your name:', function(btn, text){<br/> if (btn == 'ok'){<br/> // process text value...<br/> }<br/>});<br/><br/>// Show a dialog using config options:<br/>Roo.Msg.show({<br/> title:'Save Changes?',<br/> msg: 'Your are closing a tab that has unsaved changes. Would you like to save your changes?',<br/> buttons: Roo.Msg.YESNOCANCEL,<br/> fn: processResult,<br/> animEl: 'elId'<br/>});<br/></code></pre>
+ </div>
+
+
+<!-- ============================== Class comment block... ========================== -->
+
+<div class="comments">
+ <b>Class Comments / Notes</B> =>
+ <u onclick="parent.CommentDialog.showCommentId = 'Roo.bootstrap.MessageBox';">[Add Your comment/notes about this class]</u>
+ <br/>
+ <iframe frameborder="0" id="comments-Roo.bootstrap" style="border: none;width:100%;"
+ src="/blog.php/GtkDjsComments/Roo.bootstrap.MessageBox.html"></iframe>
+</div>
+
+
+
+<!-- ============================== config options ========================== -->
+
+
+
+
+ <div class="hr"></div>
+ <a id="Roo.bootstrap.MessageBox-configs"></a>
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Config Options - Has None</caption>
+ </table>
+
+
+
+
+
+
+
+
+
+
+
+
+ <!-- ============================== public properties ==================== -->
+
+
+
+ <a id="Roo.bootstrap.MessageBox-props"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Public Properties - Has None</caption>
+ </table>
+
+
+
+
+ <!-- ============================== methods summary / details ======================== -->
+
+
+ <a id="Roo.bootstrap.MessageBox-methods"></a>
+ <!-- constructor?? -->
+
+ <!-- static's first
+
+
+ -->
+
+ <!-- then dynamics first -->
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Public Methods</caption>
+ <tr>
+ <th class="sig-header" colspan="2">Method</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+
+
+
+
+
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-alert" name=".alert"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">alert</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
+
+
+ :
+
+
+ <a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).</div>
+
+
+
+ <div class="long">
+
+ Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).<br/>If a callback function is passed it will be called after the user clicks the button, and the<br/>id of the button that was clicked will be passed as the only parameter to the callback<br/>(could also be the top-right close button).
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>title</b>
+
+ </dt>
+ <dd>The title bar text</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
+
+ </dt>
+ <dd>The message box body text</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
+
+ </dt>
+ <dd>(optional) The callback function invoked after the message box is closed</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
+
+ </dt>
+ <dd>(optional) The scope of the callback function</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a></span> This message box</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-confirm" name=".confirm"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">confirm</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
+
+
+ :
+
+
+ <a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).</div>
+
+
+
+ <div class="long">
+
+ Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).<br/>If a callback function is passed it will be called after the user clicks either button, and the id of the<br/>button that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>title</b>
+
+ </dt>
+ <dd>The title bar text</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
+
+ </dt>
+ <dd>The message box body text</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
+
+ </dt>
+ <dd>(optional) The callback function invoked after the message box is closed</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
+
+ </dt>
+ <dd>(optional) The scope of the callback function</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a></span> This message box</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-getDialog" name=".getDialog"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">getDialog</b>
+
+ ()
+
+
+ :
+
+
+ <a href="./Roo.BasicDialog.html#constructor" roo:cls="Roo.BasicDialog.html#constructor">Roo.BasicDialog</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Returns a reference to the underlying {<b>link</b> Roo.BasicDialog} element</div>
+
+
+
+ <div class="long">
+
+ Returns a reference to the underlying {<b>link</b> Roo.BasicDialog} element
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.BasicDialog.html#constructor" roo:cls="Roo.BasicDialog.html#constructor">Roo.BasicDialog</a></span> The BasicDialog element</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-hide" name=".hide"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">hide</b>
+
+ ()
+
+
+
+ </div>
+ <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>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-isVisible" name=".isVisible"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">isVisible</b>
+
+ ()
+
+
+ :
+
+
+ <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+
+
+
+ </div>
+ <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
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the message box is visible, else false</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-progress" name=".progress"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">progress</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>)
+
+
+ :
+
+
+ <a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Displays a message box with a progress bar.</div>
+
+
+
+ <div class="long">
+
+ Displays a message box with a progress bar. This message box has no buttons and is not closeable by<br/>the user. You are responsible for updating the progress bar as needed via {<b>link</b> Roo.MessageBox<b>updateProgress</b>}<br/>and closing the message box when the process is complete.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>title</b>
+
+ </dt>
+ <dd>The title bar text</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
+
+ </dt>
+ <dd>The message box body text</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a></span> This message box</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-prompt" name=".prompt"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">prompt</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Number <B><i>multiline</i></B>)
+
+
+ :
+
+
+ <a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to<br/>JavaScript's Window.prompt).</div>
+
+
+
+ <div class="long">
+
+ Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to<br/>JavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function<br/>is passed it will be called after the user clicks either button, and the id of the button that was clicked<br/>(could also be the top-right close button) and the text that was entered will be passed as the two<br/>parameters to the callback.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>title</b>
+
+ </dt>
+ <dd>The title bar text</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
+
+ </dt>
+ <dd>The message box body text</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>fn</b>
+
+ </dt>
+ <dd>(optional) The callback function invoked after the message box is closed</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
+
+ </dt>
+ <dd>(optional) The scope of the callback function</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Number</span> <b>multiline</b>
+
+ </dt>
+ <dd>(optional) True to create a multiline textbox using the defaultTextHeight<br/>property, or the height in pixels to create the textbox (defaults to false / single-line)</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a></span> This message box</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-show" name=".show"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">show</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
+
+
+ :
+
+
+ <a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Displays a new message box, or reinitializes an existing message box, based on the config options<br/>passed in.</div>
+
+
+
+ <div class="long">
+
+ Displays a new message box, or reinitializes an existing message box, based on the config options<br/>passed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.<br/>The following config object properties are supported:<br/><pre><br/>Property Type Description<br/>---------- --------------- ------------------------------------------------------------------------------------<br/>animEl String/Element An id or Element from which the message box should animate as it opens and<br/> closes (defaults to undefined)<br/>buttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',<br/> cancel:'Bar'}), or false to not show any buttons (defaults to false)<br/>closable Boolean False to hide the top-right close button (defaults to true). Note that<br/> progress and wait dialogs will ignore this property and always hide the<br/> close button as they can only be closed programmatically.<br/>cls String A custom CSS class to apply to the message box element<br/>defaultTextHeight Number The default height in pixels of the message box's multiline textarea if<br/> displayed (defaults to 75)<br/>fn Function A callback function to execute after closing the dialog. The arguments to the<br/> function will be btn (the name of the button that was clicked, if applicable,<br/> e.g. "ok"), and text (the value of the active text field, if applicable).<br/> Progress and wait dialogs will ignore this option since they do not respond to<br/> user actions and can only be closed programmatically, so any required function<br/> should be called by the same code after it closes the dialog.<br/>icon String A CSS class that provides a background image to be used as an icon for<br/> the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')<br/>maxWidth Number The maximum width in pixels of the message box (defaults to 600)<br/>minWidth Number The minimum width in pixels of the message box (defaults to 100)<br/>modal Boolean False to allow user interaction with the page while the message box is<br/> displayed (defaults to true)<br/>msg String A string that will replace the existing message box body text (defaults<br/> to the XHTML-compliant non-breaking space character ' ')<br/>multiline Boolean True to prompt the user to enter multi-line text (defaults to false)<br/>progress Boolean True to display a progress bar (defaults to false)<br/>progressText String The text to display inside the progress bar if progress = true (defaults to '')<br/>prompt Boolean True to prompt the user to enter single-line text (defaults to false)<br/>proxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)<br/>title String The title text<br/>value String The string value to set into the active textbox element if displayed<br/>wait Boolean True to display a progress bar (defaults to false)<br/>width Number The width of the dialog in pixels<br/></pre><br/><br/>Example usage:<br/><pre><code><br/>Roo.Msg.show({<br/> title: 'Address',<br/> msg: 'Please enter your address:',<br/> width: 300,<br/> buttons: Roo.MessageBox.OKCANCEL,<br/> multiline: true,<br/> fn: saveAddress,<br/> animEl: 'addAddressBtn'<br/>});<br/></code></pre>
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
+
+ </dt>
+ <dd>Configuration options</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a></span> This message box</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-updateProgress" name=".updateProgress"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">updateProgress</b>
+
+ (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>value</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
+
+
+ :
+
+
+ <a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Updates a progress-style message box's text and progress bar.</div>
+
+
+
+ <div class="long">
+
+ Updates a progress-style message box's text and progress bar. Only relevant on message boxes<br/>initiated via {<b>link</b> Roo.MessageBox<b>progress</b>} or by calling {<b>link</b> Roo.MessageBox<b>show</b>} with progress: true.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>value</b>
+
+ </dt>
+ <dd>Any number between 0 and 1 (e.g., .5)</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
+
+ </dt>
+ <dd>(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a></span> This message box</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-updateText" name=".updateText"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">updateText</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
+
+
+ :
+
+
+ <a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Updates the message box body text</div>
+
+
+
+ <div class="long">
+
+ Updates the message box body text
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
+
+ </dt>
+ <dd>(optional) Replaces the message box element's innerHTML with the specified string (defaults to<br/>the XHTML-compliant non-breaking space character '&#160;')</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a></span> This message box</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.bootstrap.MessageBox-method-wait" name=".wait"></a>
+ <div class="fixedFont">
+ <span class="attributes">Roo.bootstrap.MessageBox.</span><b class="itemname">wait</b>
+
+ (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>)
+
+
+ :
+
+
+ <a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a>
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Displays a message box with an infinitely auto-updating progress bar.</div>
+
+
+
+ <div class="long">
+
+ Displays a message box with an infinitely auto-updating progress bar. This can be used to block user<br/>interaction while waiting for a long-running process to complete that does not have defined intervals.<br/>You are responsible for closing the message box when the process is complete.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
+
+ </dt>
+ <dd>The message box body text</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>title</b>
+
+ </dt>
+ <dd>(optional) The title bar text</dd>
+
+ </dl>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont"><a href="./Roo.html#.MessageBox" roo:cls="Roo.html#.MessageBox">Roo.MessageBox</a></span> This message box</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.bootstrap.MessageBox
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+ <!-- ============================== events summary / details ======================== -->
+
+
+ <a id="Roo.bootstrap.MessageBox-events"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Events - Has None</caption>
+ </table>
+
+
+
+
+
+
+
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
+ Based on
+ <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
+ </div>
+ </body>
+</html>
projects / roojs1 / blobdiff