1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.bootstrap.Modal</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.bootstrap.Modal-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.bootstrap.Modal-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.bootstrap.Modal-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.bootstrap.Modal-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
49 <img src="../../images/default/s.gif" height="1" width="60"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.bootstrap.Modal
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
59 Class Roo.bootstrap.Modal
62 <table cellspacing="0" class="class-summary-table">
64 <tr><td class="label">Package:</td><td class="hd-info">Roo.bootstrap</td></tr>
66 <tr><td class="label">Defined In:</td><td class="hd-info">
68 <a href="./src/Roo_bootstrap_Modal.js.html">Roo/bootstrap/Modal.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">Modal</td></tr>
76 <tr><td class="label">Extends:</td><td class="hd-info">
77 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
85 <!-- ============================== class summary ========================== -->
86 <div class="description">
91 <!-- ============================== Class comment block... ========================== -->
93 <div class="comments">
94 <b>Class Comments / Notes</B> =>
95 <u onclick="parent.CommentDialog.showCommentId = 'Roo.bootstrap.Modal';">[Add Your comment/notes about this class]</u>
97 <iframe frameborder="0" id="comments-Roo.bootstrap" style="border: none;width:100%;"
98 src="/blog.php/GtkDjsComments/Roo.bootstrap.Modal.html"></iframe>
103 <!-- ============================== config options ========================== -->
108 <div class="hr"></div>
109 <a id="Roo.bootstrap.Modal-configs"></a>
115 <table cellspacing="0" class="member-table">
116 <caption>Config Options (Usually are also Properties)</caption>
120 <th class="sig-header" colspan="2">Options</th>
122 <th class="msource-header">Defined By</th>
129 <tr class="config-row expandable config-row-alt0">
130 <td class="micon"><a class="exi" href="#expand"> </a></td>
133 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
134 <div class="fixedFont">
135 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
141 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
145 <div class="long">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
153 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
159 <tr class="config-row expandable config-row-alt1">
160 <td class="micon"><a class="exi" href="#expand"> </a></td>
163 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
164 <div class="fixedFont">
165 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
171 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
175 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
183 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
189 <tr class="config-row expandable config-row-alt0 notInherited">
190 <td class="micon"><a class="exi" href="#expand"> </a></td>
193 <a id="Roo.bootstrap.Modal-cfg-buttons" name=".buttons"></a>
194 <div class="fixedFont">
195 <b class="itemname">buttons</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
201 <div class="short">Array of buttons</div>
205 <div class="long">Array of buttons</div>
219 <tr class="config-row expandable config-row-alt1">
220 <td class="micon"><a class="exi" href="#expand"> </a></td>
223 <a id="Roo.bootstrap.Component-cfg-cls" name=".cls"></a>
224 <div class="fixedFont">
225 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
231 <div class="short">css class</div>
235 <div class="long">css class</div>
243 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
249 <tr class="config-row expandable config-row-alt0">
250 <td class="micon"><a class="exi" href="#expand"> </a></td>
253 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
254 <div class="fixedFont">
255 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
261 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
265 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
273 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
279 <tr class="config-row expandable config-row-alt1">
280 <td class="micon"><a class="exi" href="#expand"> </a></td>
283 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
284 <div class="fixedFont">
285 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
291 <div class="short">How this component should hidden.</div>
295 <div class="long">How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".</div>
303 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
309 <tr class="config-row expandable config-row-alt0">
310 <td class="micon"><a class="exi" href="#expand"> </a></td>
313 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
314 <div class="fixedFont">
315 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
321 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
325 <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
333 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
339 <tr class="config-row expandable config-row-alt1">
340 <td class="micon"><a class="exi" href="#expand"> </a></td>
343 <a id="Roo.bootstrap.Component-cfg-style" name=".style"></a>
344 <div class="fixedFont">
345 <b class="itemname">style</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
351 <div class="short">any extra css</div>
355 <div class="long">any extra css</div>
363 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
369 <tr class="config-row expandable config-row-alt0 notInherited">
370 <td class="micon"><a class="exi" href="#expand"> </a></td>
373 <a id="Roo.bootstrap.Modal-cfg-title" name=".title"></a>
374 <div class="fixedFont">
375 <b class="itemname">title</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
381 <div class="short">Title of dialog</div>
385 <div class="long">Title of dialog</div>
399 <tr class="config-row expandable config-row-alt1">
400 <td class="micon"><a class="exi" href="#expand"> </a></td>
403 <a id="Roo.bootstrap.Component-cfg-xattr" name=".xattr"></a>
404 <div class="fixedFont">
405 <b class="itemname">xattr</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
411 <div class="short">extra attributes to add to 'element' (used by builder to store stuff.</div>
415 <div class="long">extra attributes to add to 'element' (used by builder to store stuff.)</div>
423 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
439 <!-- ============================== public properties ==================== -->
443 <a id="Roo.bootstrap.Modal-props"></a>
449 <table cellspacing="0" class="member-table">
450 <caption class="Empty">Public Properties - Has None</caption>
456 <!-- ============================== methods summary / details ======================== -->
459 <a id="Roo.bootstrap.Modal-methods"></a>
460 <!-- constructor?? -->
467 <!-- then dynamics first -->
474 <table cellspacing="0" class="member-table">
475 <caption>Public Methods</caption>
477 <th class="sig-header" colspan="2">Method</th>
478 <th class="msource-header">Defined By</th>
488 <tr class="method-row config-row-alt0 expandable notInherited">
489 <td class="micon"><a class="exi" href="#expand"> </a></td>
493 <a id="Roo.bootstrap-method-Modal" name=".Modal"></a>
494 <div class="fixedFont">
495 <span class="attributes">new <B>Roo.bootstrap.</B></span><b class="itemname">Modal</b>
497 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
505 <div class="short">Create a new Roo.bootstrap.Modal</div>
512 Create a new Roo.bootstrap.Modal
515 <dl class="detailList">
516 <dt class="heading">Parameters:</dt>
519 <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>
522 <dd>The config object</dd>
546 <tr class="method-row config-row-alt1 expandable">
547 <td class="micon"><a class="exi" href="#expand"> </a></td>
551 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
552 <div class="fixedFont">
553 <span class="attributes"></span><b class="itemname">addEvents</b>
555 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
562 <div class="short">Used to define events on this Observable</div>
568 Used to define events on this Observable
575 <dl class="detailList">
576 <dt class="heading">Parameters:</dt>
579 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
582 <dd>The object with the events defined</dd>
602 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
608 <tr class="method-row config-row-alt0 expandable">
609 <td class="micon"><a class="exi" href="#expand"> </a></td>
613 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
614 <div class="fixedFont">
615 <span class="attributes"></span><b class="itemname">addListener</b>
617 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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:Object">Object</a> <B><i>options</i></B>)
624 <div class="short">Appends an event handler to this component</div>
630 Appends an event handler to this component
637 <dl class="detailList">
638 <dt class="heading">Parameters:</dt>
641 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
644 <dd>The type of event to listen for</dd>
647 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
650 <dd>The method the event invokes</dd>
653 <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>
656 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
659 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
662 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
682 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
688 <tr class="method-row config-row-alt1 expandable">
689 <td class="micon"><a class="exi" href="#expand"> </a></td>
693 <a id="Roo.Component-method-destroy" name=".destroy"></a>
694 <div class="fixedFont">
695 <span class="attributes"></span><b class="itemname">destroy</b>
704 <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.</div>
710 Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.
733 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
739 <tr class="method-row config-row-alt0 expandable">
740 <td class="micon"><a class="exi" href="#expand"> </a></td>
744 <a id="Roo.Component-method-disable" name=".disable"></a>
745 <div class="fixedFont">
746 <span class="attributes"></span><b class="itemname">disable</b>
754 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
763 <div class="short">Disable this component.</div>
769 Disable this component.
780 <dl class="detailList">
781 <dt class="heading">Returns:</dt>
783 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
799 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
805 <tr class="method-row config-row-alt1 expandable">
806 <td class="micon"><a class="exi" href="#expand"> </a></td>
810 <a id="Roo.Component-method-enable" name=".enable"></a>
811 <div class="fixedFont">
812 <span class="attributes"></span><b class="itemname">enable</b>
820 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
829 <div class="short">Enable this component.</div>
835 Enable this component.
846 <dl class="detailList">
847 <dt class="heading">Returns:</dt>
849 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
865 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
871 <tr class="method-row config-row-alt0 expandable">
872 <td class="micon"><a class="exi" href="#expand"> </a></td>
876 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
877 <div class="fixedFont">
878 <span class="attributes"></span><b class="itemname">fireEvent</b>
880 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
886 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
895 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
901 Fires the specified event with the passed parameters (minus the event name).
908 <dl class="detailList">
909 <dt class="heading">Parameters:</dt>
912 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
918 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
921 <dd>Variable number of parameters are passed to handlers</dd>
929 <dl class="detailList">
930 <dt class="heading">Returns:</dt>
932 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
948 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
954 <tr class="method-row config-row-alt1 expandable">
955 <td class="micon"><a class="exi" href="#expand"> </a></td>
959 <a id="Roo.Component-method-focus" name=".focus"></a>
960 <div class="fixedFont">
961 <span class="attributes"></span><b class="itemname">focus</b>
963 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
969 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
978 <div class="short">Try to focus this component.</div>
984 Try to focus this component.
991 <dl class="detailList">
992 <dt class="heading">Parameters:</dt>
995 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>selectText</b>
998 <dd>True to also select the text in this component (if applicable)</dd>
1006 <dl class="detailList">
1007 <dt class="heading">Returns:</dt>
1009 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1023 <td class="msource">
1025 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1031 <tr class="method-row config-row-alt0 expandable">
1032 <td class="micon"><a class="exi" href="#expand"> </a></td>
1036 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1037 <div class="fixedFont">
1038 <span class="attributes"></span><b class="itemname">getEl</b>
1046 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1055 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1061 Returns the underlying {<b>link</b> Roo.Element}.
1072 <dl class="detailList">
1073 <dt class="heading">Returns:</dt>
1075 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1089 <td class="msource">
1091 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1097 <tr class="method-row config-row-alt1 expandable">
1098 <td class="micon"><a class="exi" href="#expand"> </a></td>
1102 <a id="Roo.Component-method-getId" name=".getId"></a>
1103 <div class="fixedFont">
1104 <span class="attributes"></span><b class="itemname">getId</b>
1112 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1121 <div class="short">Returns the id of this component.</div>
1127 Returns the id of this component.
1138 <dl class="detailList">
1139 <dt class="heading">Returns:</dt>
1141 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1155 <td class="msource">
1157 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1163 <tr class="method-row config-row-alt0 expandable">
1164 <td class="micon"><a class="exi" href="#expand"> </a></td>
1168 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1169 <div class="fixedFont">
1170 <span class="attributes"></span><b class="itemname">hasListener</b>
1172 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1178 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1187 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1193 Checks to see if this object has any listeners for a specified event
1200 <dl class="detailList">
1201 <dt class="heading">Parameters:</dt>
1204 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1207 <dd>The name of the event to check for</dd>
1215 <dl class="detailList">
1216 <dt class="heading">Returns:</dt>
1218 <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 event is being listened for, else false</dd>
1232 <td class="msource">
1234 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1240 <tr class="method-row config-row-alt1 expandable">
1241 <td class="micon"><a class="exi" href="#expand"> </a></td>
1245 <a id="Roo.Component-method-hide" name=".hide"></a>
1246 <div class="fixedFont">
1247 <span class="attributes"></span><b class="itemname">hide</b>
1255 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1264 <div class="short">Hide this component.</div>
1270 Hide this component.
1281 <dl class="detailList">
1282 <dt class="heading">Returns:</dt>
1284 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1298 <td class="msource">
1300 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1306 <tr class="method-row config-row-alt0 expandable">
1307 <td class="micon"><a class="exi" href="#expand"> </a></td>
1311 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1312 <div class="fixedFont">
1313 <span class="attributes"></span><b class="itemname">isVisible</b>
1322 <div class="short">Returns true if this component is visible.</div>
1328 Returns true if this component is visible.
1349 <td class="msource">
1351 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1357 <tr class="method-row config-row-alt1 expandable">
1358 <td class="micon"><a class="exi" href="#expand"> </a></td>
1362 <a id="Roo.util.Observable-method-on" name=".on"></a>
1363 <div class="fixedFont">
1364 <span class="attributes"></span><b class="itemname">on</b>
1366 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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:Object">Object</a> <B><i>options</i></B>)
1373 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1379 Appends an event handler to this element (shorthand for addListener)
1386 <dl class="detailList">
1387 <dt class="heading">Parameters:</dt>
1390 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1393 <dd>The type of event to listen for</dd>
1396 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1399 <dd>The method the event invokes</dd>
1402 <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>
1405 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1408 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1429 <td class="msource">
1431 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1437 <tr class="method-row config-row-alt0 expandable">
1438 <td class="micon"><a class="exi" href="#expand"> </a></td>
1442 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1443 <div class="fixedFont">
1444 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1453 <div class="short">Removes all listeners for this object</div>
1459 Removes all listeners for this object
1480 <td class="msource">
1482 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1488 <tr class="method-row config-row-alt1 expandable">
1489 <td class="micon"><a class="exi" href="#expand"> </a></td>
1493 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1494 <div class="fixedFont">
1495 <span class="attributes"></span><b class="itemname">removeListener</b>
1497 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>)
1504 <div class="short">Removes a listener</div>
1517 <dl class="detailList">
1518 <dt class="heading">Parameters:</dt>
1521 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1524 <dd>The type of event to listen for</dd>
1527 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1530 <dd>The handler to remove</dd>
1533 <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>
1536 <dd>(optional) The scope (this object) for the handler</dd>
1554 <td class="msource">
1556 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1562 <tr class="method-row config-row-alt0 expandable">
1563 <td class="micon"><a class="exi" href="#expand"> </a></td>
1567 <a id="Roo.Component-method-render" name=".render"></a>
1568 <div class="fixedFont">
1569 <span class="attributes"></span><b class="itemname">render</b>
1571 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1578 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1584 If this is a lazy rendering component, render it to its container element.
1591 <dl class="detailList">
1592 <dt class="heading">Parameters:</dt>
1595 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1598 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1616 <td class="msource">
1618 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1624 <tr class="method-row config-row-alt1 expandable">
1625 <td class="micon"><a class="exi" href="#expand"> </a></td>
1629 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1630 <div class="fixedFont">
1631 <span class="attributes"></span><b class="itemname">setDisabled</b>
1633 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1640 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1646 Convenience function for setting disabled/enabled by boolean.
1653 <dl class="detailList">
1654 <dt class="heading">Parameters:</dt>
1657 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>disabled</b>
1678 <td class="msource">
1680 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1686 <tr class="method-row config-row-alt0 expandable">
1687 <td class="micon"><a class="exi" href="#expand"> </a></td>
1691 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
1692 <div class="fixedFont">
1693 <span class="attributes"></span><b class="itemname">setVisible</b>
1695 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1701 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1710 <div class="short">Convenience function to hide or show this component by boolean.</div>
1716 Convenience function to hide or show this component by boolean.
1723 <dl class="detailList">
1724 <dt class="heading">Parameters:</dt>
1727 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>visible</b>
1730 <dd>True to show, false to hide</dd>
1738 <dl class="detailList">
1739 <dt class="heading">Returns:</dt>
1741 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1755 <td class="msource">
1757 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1763 <tr class="method-row config-row-alt1 expandable">
1764 <td class="micon"><a class="exi" href="#expand"> </a></td>
1768 <a id="Roo.Component-method-show" name=".show"></a>
1769 <div class="fixedFont">
1770 <span class="attributes"></span><b class="itemname">show</b>
1778 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1787 <div class="short">Show this component.</div>
1793 Show this component.
1804 <dl class="detailList">
1805 <dt class="heading">Returns:</dt>
1807 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1821 <td class="msource">
1823 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1829 <tr class="method-row config-row-alt0 expandable">
1830 <td class="micon"><a class="exi" href="#expand"> </a></td>
1834 <a id="Roo.util.Observable-method-un" name=".un"></a>
1835 <div class="fixedFont">
1836 <span class="attributes"></span><b class="itemname">un</b>
1838 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>)
1845 <div class="short">Removes a listener (shorthand for removeListener)</div>
1851 Removes a listener (shorthand for removeListener)
1858 <dl class="detailList">
1859 <dt class="heading">Parameters:</dt>
1862 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1865 <dd>The type of event to listen for</dd>
1868 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1871 <dd>The handler to remove</dd>
1874 <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>
1877 <dd>(optional) The scope (this object) for the handler</dd>
1895 <td class="msource">
1897 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1906 <!-- ============================== events summary / details ======================== -->
1909 <a id="Roo.bootstrap.Modal-events"></a>
1918 <table cellspacing="0" class="member-table">
1919 <caption>Events</caption>
1922 <th class="sig-header" colspan="2">Event</th>
1923 <th class="msource-header">Defined By</th>
1932 <tr class="method-row expandable config-row-alt0">
1933 <td class="micon"><a class="exi" href="#expand"> </a></td>
1936 <a id="Roo.Component-event-*beforedestroy"></a>
1938 <div class="fixedFont">
1939 <b class="itemname">beforedestroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1945 <div class="short">Fires before the component is destroyed.
1951 Fires before the component is destroyed. Return false to stop the destroy.
1957 <dl class="detailList">
1958 <dt class="heading">Parameters:</dt>
1961 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1982 <td class="msource">
1983 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1987 <tr class="method-row expandable config-row-alt1">
1988 <td class="micon"><a class="exi" href="#expand"> </a></td>
1991 <a id="Roo.Component-event-*beforehide"></a>
1993 <div class="fixedFont">
1994 <b class="itemname">beforehide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2000 <div class="short">Fires before the component is hidden.
2006 Fires before the component is hidden. Return false to stop the hide.
2012 <dl class="detailList">
2013 <dt class="heading">Parameters:</dt>
2016 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2037 <td class="msource">
2038 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2042 <tr class="method-row expandable config-row-alt0">
2043 <td class="micon"><a class="exi" href="#expand"> </a></td>
2046 <a id="Roo.Component-event-*beforerender"></a>
2048 <div class="fixedFont">
2049 <b class="itemname">beforerender</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2055 <div class="short">Fires before the component is rendered.
2061 Fires before the component is rendered. Return false to stop the render.
2067 <dl class="detailList">
2068 <dt class="heading">Parameters:</dt>
2071 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2092 <td class="msource">
2093 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2097 <tr class="method-row expandable config-row-alt1">
2098 <td class="micon"><a class="exi" href="#expand"> </a></td>
2101 <a id="Roo.Component-event-*beforeshow"></a>
2103 <div class="fixedFont">
2104 <b class="itemname">beforeshow</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2110 <div class="short">Fires before the component is shown.
2116 Fires before the component is shown. Return false to stop the show.
2122 <dl class="detailList">
2123 <dt class="heading">Parameters:</dt>
2126 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2147 <td class="msource">
2148 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2152 <tr class="method-row expandable config-row-alt0">
2153 <td class="micon"><a class="exi" href="#expand"> </a></td>
2156 <a id="Roo.Component-event-*destroy"></a>
2158 <div class="fixedFont">
2159 <b class="itemname">destroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2165 <div class="short">Fires after the component is destroyed.
2171 Fires after the component is destroyed.
2177 <dl class="detailList">
2178 <dt class="heading">Parameters:</dt>
2181 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2202 <td class="msource">
2203 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2207 <tr class="method-row expandable config-row-alt1">
2208 <td class="micon"><a class="exi" href="#expand"> </a></td>
2211 <a id="Roo.Component-event-*disable"></a>
2213 <div class="fixedFont">
2214 <b class="itemname">disable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2220 <div class="short">Fires after the component is disabled.
2226 Fires after the component is disabled.
2232 <dl class="detailList">
2233 <dt class="heading">Parameters:</dt>
2236 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2257 <td class="msource">
2258 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2262 <tr class="method-row expandable config-row-alt0">
2263 <td class="micon"><a class="exi" href="#expand"> </a></td>
2266 <a id="Roo.Component-event-*enable"></a>
2268 <div class="fixedFont">
2269 <b class="itemname">enable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2275 <div class="short">Fires after the component is enabled.
2281 Fires after the component is enabled.
2287 <dl class="detailList">
2288 <dt class="heading">Parameters:</dt>
2291 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2312 <td class="msource">
2313 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2317 <tr class="method-row expandable config-row-alt1">
2318 <td class="micon"><a class="exi" href="#expand"> </a></td>
2321 <a id="Roo.Component-event-*hide"></a>
2323 <div class="fixedFont">
2324 <b class="itemname">hide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2330 <div class="short">Fires after the component is hidden.
2336 Fires after the component is hidden.
2342 <dl class="detailList">
2343 <dt class="heading">Parameters:</dt>
2346 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2367 <td class="msource">
2368 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2372 <tr class="method-row expandable config-row-alt0">
2373 <td class="micon"><a class="exi" href="#expand"> </a></td>
2376 <a id="Roo.Component-event-*render"></a>
2378 <div class="fixedFont">
2379 <b class="itemname">render</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2385 <div class="short">Fires after the component is rendered.
2391 Fires after the component is rendered.
2397 <dl class="detailList">
2398 <dt class="heading">Parameters:</dt>
2401 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2422 <td class="msource">
2423 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2427 <tr class="method-row expandable config-row-alt1">
2428 <td class="micon"><a class="exi" href="#expand"> </a></td>
2431 <a id="Roo.Component-event-*show"></a>
2433 <div class="fixedFont">
2434 <b class="itemname">show</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2440 <div class="short">Fires after the component is shown.
2446 Fires after the component is shown.
2452 <dl class="detailList">
2453 <dt class="heading">Parameters:</dt>
2456 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2477 <td class="msource">
2478 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2489 <!-- ============================== footer ================================= -->
2490 <div class="fineprint" style="clear:both">
2492 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Feb 07 2014 15:20:20 GMT+0800 (HKT)
2494 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>