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.Component</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.Component-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.Component-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.Component-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.Component-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 class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.Component
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_Component.js.html">Roo/Component.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Component</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>, <a href="./Roo.ColorPalette.html#constructor" roo:cls="Roo.ColorPalette.html#constructor">Roo.ColorPalette</a>, <a href="./Roo.DatePicker.html#constructor" roo:cls="Roo.DatePicker.html#constructor">Roo.DatePicker</a>, <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>, <a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a>, <a href="./Roo.form.Column.html#constructor" roo:cls="Roo.form.Column.html#constructor">Roo.form.Column</a>, <a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a>, <a href="./Roo.form.DateField.html#constructor" roo:cls="Roo.form.DateField.html#constructor">Roo.form.DateField</a>, <a href="./Roo.form.FCKeditor.html#constructor" roo:cls="Roo.form.FCKeditor.html#constructor">Roo.form.FCKeditor</a>, <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>, <a href="./Roo.form.FieldSet.html#constructor" roo:cls="Roo.form.FieldSet.html#constructor">Roo.form.FieldSet</a>, <a href="./Roo.form.GridField.html#constructor" roo:cls="Roo.form.GridField.html#constructor">Roo.form.GridField</a>, <a href="./Roo.form.Hidden.html#constructor" roo:cls="Roo.form.Hidden.html#constructor">Roo.form.Hidden</a>, <a href="./Roo.form.Layout.html#constructor" roo:cls="Roo.form.Layout.html#constructor">Roo.form.Layout</a>, <a href="./Roo.form.NumberField.html#constructor" roo:cls="Roo.form.NumberField.html#constructor">Roo.form.NumberField</a>, <a href="./Roo.form.Radio.html#constructor" roo:cls="Roo.form.Radio.html#constructor">Roo.form.Radio</a>, <a href="./Roo.form.Row.html#constructor" roo:cls="Roo.form.Row.html#constructor">Roo.form.Row</a>, <a href="./Roo.form.TextArea.html#constructor" roo:cls="Roo.form.TextArea.html#constructor">Roo.form.TextArea</a>, <a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>, <a href="./Roo.form.TriggerField.html#constructor" roo:cls="Roo.form.TriggerField.html#constructor">Roo.form.TriggerField</a>, <a href="./Roo.grid.GridEditor.html#constructor" roo:cls="Roo.grid.GridEditor.html#constructor">Roo.grid.GridEditor</a>, <a href="./Roo.menu.Adapter.html#constructor" roo:cls="Roo.menu.Adapter.html#constructor">Roo.menu.Adapter</a>, <a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a>, <a href="./Roo.menu.CheckItem.html#constructor" roo:cls="Roo.menu.CheckItem.html#constructor">Roo.menu.CheckItem</a>, <a href="./Roo.menu.ColorItem.html#constructor" roo:cls="Roo.menu.ColorItem.html#constructor">Roo.menu.ColorItem</a>, <a href="./Roo.menu.DateItem.html#constructor" roo:cls="Roo.menu.DateItem.html#constructor">Roo.menu.DateItem</a>, <a href="./Roo.menu.Item.html#constructor" roo:cls="Roo.menu.Item.html#constructor">Roo.menu.Item</a>, <a href="./Roo.menu.Separator.html#constructor" roo:cls="Roo.menu.Separator.html#constructor">Roo.menu.Separator</a>, <a href="./Roo.menu.TextItem.html#constructor" roo:cls="Roo.menu.TextItem.html#constructor">Roo.menu.TextItem</a>, <a href="./Roo.tree.TreeEditor.html#constructor" roo:cls="Roo.tree.TreeEditor.html#constructor">Roo.tree.TreeEditor</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 Base class for all major Roo components. All subclasses of Component can automatically participate in the standard<br/>Roo component lifecycle of creation, rendering and destruction. They also have automatic support for basic hide/show<br/>and enable/disable behavior. Component allows any subclass to be lazy-rendered into any {<b>link</b> Roo.Container} and<br/>to be automatically registered with the {<b>link</b> Roo.ComponentMgr} so that it can be referenced at any time via {<b>link</b> Roo.getCmp}.<br/>All visual components (widgets) that require rendering into a layout should subclass Component.
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.Component';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.Component.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.Component-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0 notInherited">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
139 <div class="fixedFont">
140 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
146 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
150 <div class="long">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
164 <tr class="config-row expandable config-row-alt1 notInherited">
165 <td class="micon"><a class="exi" href="#expand"> </a></td>
168 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
169 <div class="fixedFont">
170 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
176 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
180 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
194 <tr class="config-row expandable config-row-alt0 notInherited">
195 <td class="micon"><a class="exi" href="#expand"> </a></td>
198 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
199 <div class="fixedFont">
200 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
206 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
210 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
224 <tr class="config-row expandable config-row-alt1 notInherited">
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
229 <div class="fixedFont">
230 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
236 <div class="short">How this component should hidden.</div>
240 <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>
254 <tr class="config-row expandable config-row-alt0">
255 <td class="micon"><a class="exi" href="#expand"> </a></td>
258 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
259 <div class="fixedFont">
260 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
266 <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>
270 <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>
278 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
294 <!-- ============================== public properties ==================== -->
298 <a id="Roo.Component-props"></a>
304 <table cellspacing="0" class="member-table">
305 <caption class="Empty">Public Properties - Has None</caption>
311 <!-- ============================== methods summary / details ======================== -->
314 <a id="Roo.Component-methods"></a>
315 <!-- constructor?? -->
322 <!-- then dynamics first -->
329 <table cellspacing="0" class="member-table">
330 <caption>Public Methods</caption>
332 <th class="sig-header" colspan="2">Method</th>
333 <th class="msource-header">Defined By</th>
343 <tr class="method-row config-row-alt0 expandable notInherited">
344 <td class="micon"><a class="exi" href="#expand"> </a></td>
348 <a id="Roo-method-Component" name=".Component"></a>
349 <div class="fixedFont">
350 <span class="attributes">new <B>Roo.</B></span><b class="itemname">Component</b>
352 (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object <B><i>config</i></B>)
360 <div class="short">Create a new Roo.Component</div>
367 Create a new Roo.Component
370 <dl class="detailList">
371 <dt class="heading">Parameters:</dt>
374 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object</span> <b>config</b>
377 <dd>The configuration options. If an element is passed, it is set as the internal<br/>element and its id used as the component id. If a string is passed, it is assumed to be the id of an existing element<br/>and is used as the component id. Otherwise, it is assumed to be a standard config object and is applied to the component.</dd>
401 <tr class="method-row config-row-alt1 expandable">
402 <td class="micon"><a class="exi" href="#expand"> </a></td>
406 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
407 <div class="fixedFont">
408 <span class="attributes"></span><b class="itemname">addEvents</b>
410 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
417 <div class="short">Used to define events on this Observable</div>
423 Used to define events on this Observable
430 <dl class="detailList">
431 <dt class="heading">Parameters:</dt>
434 <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>
437 <dd>The object with the events defined</dd>
457 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
463 <tr class="method-row config-row-alt0 expandable">
464 <td class="micon"><a class="exi" href="#expand"> </a></td>
468 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
469 <div class="fixedFont">
470 <span class="attributes"></span><b class="itemname">addListener</b>
472 (<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>)
479 <div class="short">Appends an event handler to this component</div>
485 Appends an event handler to this component
492 <dl class="detailList">
493 <dt class="heading">Parameters:</dt>
496 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
499 <dd>The type of event to listen for</dd>
502 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
505 <dd>The method the event invokes</dd>
508 <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>
511 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
514 <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>
517 <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>
537 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
543 <tr class="method-row config-row-alt1 expandable notInherited">
544 <td class="micon"><a class="exi" href="#expand"> </a></td>
548 <a id="Roo.Component-method-destroy" name=".destroy"></a>
549 <div class="fixedFont">
550 <span class="attributes"></span><b class="itemname">destroy</b>
559 <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>
565 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}.
594 <tr class="method-row config-row-alt0 expandable notInherited">
595 <td class="micon"><a class="exi" href="#expand"> </a></td>
599 <a id="Roo.Component-method-disable" name=".disable"></a>
600 <div class="fixedFont">
601 <span class="attributes"></span><b class="itemname">disable</b>
609 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
618 <div class="short">Disable this component.</div>
624 Disable this component.
635 <dl class="detailList">
636 <dt class="heading">Returns:</dt>
638 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
660 <tr class="method-row config-row-alt1 expandable notInherited">
661 <td class="micon"><a class="exi" href="#expand"> </a></td>
665 <a id="Roo.Component-method-enable" name=".enable"></a>
666 <div class="fixedFont">
667 <span class="attributes"></span><b class="itemname">enable</b>
675 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
684 <div class="short">Enable this component.</div>
690 Enable this component.
701 <dl class="detailList">
702 <dt class="heading">Returns:</dt>
704 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
726 <tr class="method-row config-row-alt0 expandable">
727 <td class="micon"><a class="exi" href="#expand"> </a></td>
731 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
732 <div class="fixedFont">
733 <span class="attributes"></span><b class="itemname">fireEvent</b>
735 (<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>)
741 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
750 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
756 Fires the specified event with the passed parameters (minus the event name).
763 <dl class="detailList">
764 <dt class="heading">Parameters:</dt>
767 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
773 <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>
776 <dd>Variable number of parameters are passed to handlers</dd>
784 <dl class="detailList">
785 <dt class="heading">Returns:</dt>
787 <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>
803 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
809 <tr class="method-row config-row-alt1 expandable notInherited">
810 <td class="micon"><a class="exi" href="#expand"> </a></td>
814 <a id="Roo.Component-method-focus" name=".focus"></a>
815 <div class="fixedFont">
816 <span class="attributes"></span><b class="itemname">focus</b>
818 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
824 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
833 <div class="short">Try to focus this component.</div>
839 Try to focus this component.
846 <dl class="detailList">
847 <dt class="heading">Parameters:</dt>
850 <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>
853 <dd>True to also select the text in this component (if applicable)</dd>
861 <dl class="detailList">
862 <dt class="heading">Returns:</dt>
864 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
886 <tr class="method-row config-row-alt0 expandable notInherited">
887 <td class="micon"><a class="exi" href="#expand"> </a></td>
891 <a id="Roo.Component-method-getEl" name=".getEl"></a>
892 <div class="fixedFont">
893 <span class="attributes"></span><b class="itemname">getEl</b>
901 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
910 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
916 Returns the underlying {<b>link</b> Roo.Element}.
927 <dl class="detailList">
928 <dt class="heading">Returns:</dt>
930 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
952 <tr class="method-row config-row-alt1 expandable notInherited">
953 <td class="micon"><a class="exi" href="#expand"> </a></td>
957 <a id="Roo.Component-method-getId" name=".getId"></a>
958 <div class="fixedFont">
959 <span class="attributes"></span><b class="itemname">getId</b>
967 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
976 <div class="short">Returns the id of this component.</div>
982 Returns the id of this component.
993 <dl class="detailList">
994 <dt class="heading">Returns:</dt>
996 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1010 <td class="msource">
1018 <tr class="method-row config-row-alt0 expandable">
1019 <td class="micon"><a class="exi" href="#expand"> </a></td>
1023 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1024 <div class="fixedFont">
1025 <span class="attributes"></span><b class="itemname">hasListener</b>
1027 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1033 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1042 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1048 Checks to see if this object has any listeners for a specified event
1055 <dl class="detailList">
1056 <dt class="heading">Parameters:</dt>
1059 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1062 <dd>The name of the event to check for</dd>
1070 <dl class="detailList">
1071 <dt class="heading">Returns:</dt>
1073 <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>
1087 <td class="msource">
1089 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1095 <tr class="method-row config-row-alt1 expandable notInherited">
1096 <td class="micon"><a class="exi" href="#expand"> </a></td>
1100 <a id="Roo.Component-method-hide" name=".hide"></a>
1101 <div class="fixedFont">
1102 <span class="attributes"></span><b class="itemname">hide</b>
1110 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1119 <div class="short">Hide this component.</div>
1125 Hide this component.
1136 <dl class="detailList">
1137 <dt class="heading">Returns:</dt>
1139 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1153 <td class="msource">
1161 <tr class="method-row config-row-alt0 expandable notInherited">
1162 <td class="micon"><a class="exi" href="#expand"> </a></td>
1166 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1167 <div class="fixedFont">
1168 <span class="attributes"></span><b class="itemname">isVisible</b>
1177 <div class="short">Returns true if this component is visible.</div>
1183 Returns true if this component is visible.
1204 <td class="msource">
1212 <tr class="method-row config-row-alt1 expandable">
1213 <td class="micon"><a class="exi" href="#expand"> </a></td>
1217 <a id="Roo.util.Observable-method-on" name=".on"></a>
1218 <div class="fixedFont">
1219 <span class="attributes"></span><b class="itemname">on</b>
1221 (<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>)
1228 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1234 Appends an event handler to this element (shorthand for addListener)
1241 <dl class="detailList">
1242 <dt class="heading">Parameters:</dt>
1245 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1248 <dd>The type of event to listen for</dd>
1251 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1254 <dd>The method the event invokes</dd>
1257 <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>
1260 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1263 <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>
1284 <td class="msource">
1286 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1292 <tr class="method-row config-row-alt0 expandable">
1293 <td class="micon"><a class="exi" href="#expand"> </a></td>
1297 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1298 <div class="fixedFont">
1299 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1308 <div class="short">Removes all listeners for this object</div>
1314 Removes all listeners for this object
1335 <td class="msource">
1337 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1343 <tr class="method-row config-row-alt1 expandable">
1344 <td class="micon"><a class="exi" href="#expand"> </a></td>
1348 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1349 <div class="fixedFont">
1350 <span class="attributes"></span><b class="itemname">removeListener</b>
1352 (<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>)
1359 <div class="short">Removes a listener</div>
1372 <dl class="detailList">
1373 <dt class="heading">Parameters:</dt>
1376 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1379 <dd>The type of event to listen for</dd>
1382 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1385 <dd>The handler to remove</dd>
1388 <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>
1391 <dd>(optional) The scope (this object) for the handler</dd>
1409 <td class="msource">
1411 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1417 <tr class="method-row config-row-alt0 expandable notInherited">
1418 <td class="micon"><a class="exi" href="#expand"> </a></td>
1422 <a id="Roo.Component-method-render" name=".render"></a>
1423 <div class="fixedFont">
1424 <span class="attributes"></span><b class="itemname">render</b>
1426 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1433 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1439 If this is a lazy rendering component, render it to its container element.
1446 <dl class="detailList">
1447 <dt class="heading">Parameters:</dt>
1450 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1453 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1471 <td class="msource">
1479 <tr class="method-row config-row-alt1 expandable notInherited">
1480 <td class="micon"><a class="exi" href="#expand"> </a></td>
1484 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1485 <div class="fixedFont">
1486 <span class="attributes"></span><b class="itemname">setDisabled</b>
1488 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1495 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1501 Convenience function for setting disabled/enabled by boolean.
1508 <dl class="detailList">
1509 <dt class="heading">Parameters:</dt>
1512 <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>
1533 <td class="msource">
1541 <tr class="method-row config-row-alt0 expandable notInherited">
1542 <td class="micon"><a class="exi" href="#expand"> </a></td>
1546 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
1547 <div class="fixedFont">
1548 <span class="attributes"></span><b class="itemname">setVisible</b>
1550 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1556 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1565 <div class="short">Convenience function to hide or show this component by boolean.</div>
1571 Convenience function to hide or show this component by boolean.
1578 <dl class="detailList">
1579 <dt class="heading">Parameters:</dt>
1582 <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>
1585 <dd>True to show, false to hide</dd>
1593 <dl class="detailList">
1594 <dt class="heading">Returns:</dt>
1596 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1610 <td class="msource">
1618 <tr class="method-row config-row-alt1 expandable notInherited">
1619 <td class="micon"><a class="exi" href="#expand"> </a></td>
1623 <a id="Roo.Component-method-show" name=".show"></a>
1624 <div class="fixedFont">
1625 <span class="attributes"></span><b class="itemname">show</b>
1633 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1642 <div class="short">Show this component.</div>
1648 Show this component.
1659 <dl class="detailList">
1660 <dt class="heading">Returns:</dt>
1662 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1676 <td class="msource">
1684 <tr class="method-row config-row-alt0 expandable">
1685 <td class="micon"><a class="exi" href="#expand"> </a></td>
1689 <a id="Roo.util.Observable-method-un" name=".un"></a>
1690 <div class="fixedFont">
1691 <span class="attributes"></span><b class="itemname">un</b>
1693 (<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>)
1700 <div class="short">Removes a listener (shorthand for removeListener)</div>
1706 Removes a listener (shorthand for removeListener)
1713 <dl class="detailList">
1714 <dt class="heading">Parameters:</dt>
1717 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1720 <dd>The type of event to listen for</dd>
1723 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1726 <dd>The handler to remove</dd>
1729 <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>
1732 <dd>(optional) The scope (this object) for the handler</dd>
1750 <td class="msource">
1752 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1761 <!-- ============================== events summary / details ======================== -->
1764 <a id="Roo.Component-events"></a>
1773 <table cellspacing="0" class="member-table">
1774 <caption>Events</caption>
1777 <th class="sig-header" colspan="2">Event</th>
1778 <th class="msource-header">Defined By</th>
1787 <tr class="method-row expandable config-row-alt0 notInherited">
1788 <td class="micon"><a class="exi" href="#expand"> </a></td>
1791 <a id="Roo.Component-event-*beforedestroy"></a>
1793 <div class="fixedFont">
1794 <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>)
1800 <div class="short">Fires before the component is destroyed.
1806 Fires before the component is destroyed. Return false to stop the destroy.
1812 <dl class="detailList">
1813 <dt class="heading">Parameters:</dt>
1816 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1837 <td class="msource">
1842 <tr class="method-row expandable config-row-alt1 notInherited">
1843 <td class="micon"><a class="exi" href="#expand"> </a></td>
1846 <a id="Roo.Component-event-*beforehide"></a>
1848 <div class="fixedFont">
1849 <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>)
1855 <div class="short">Fires before the component is hidden.
1861 Fires before the component is hidden. Return false to stop the hide.
1867 <dl class="detailList">
1868 <dt class="heading">Parameters:</dt>
1871 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1892 <td class="msource">
1897 <tr class="method-row expandable config-row-alt0 notInherited">
1898 <td class="micon"><a class="exi" href="#expand"> </a></td>
1901 <a id="Roo.Component-event-*beforerender"></a>
1903 <div class="fixedFont">
1904 <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>)
1910 <div class="short">Fires before the component is rendered.
1916 Fires before the component is rendered. Return false to stop the render.
1922 <dl class="detailList">
1923 <dt class="heading">Parameters:</dt>
1926 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1947 <td class="msource">
1952 <tr class="method-row expandable config-row-alt1 notInherited">
1953 <td class="micon"><a class="exi" href="#expand"> </a></td>
1956 <a id="Roo.Component-event-*beforeshow"></a>
1958 <div class="fixedFont">
1959 <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>)
1965 <div class="short">Fires before the component is shown.
1971 Fires before the component is shown. Return false to stop the show.
1977 <dl class="detailList">
1978 <dt class="heading">Parameters:</dt>
1981 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2002 <td class="msource">
2007 <tr class="method-row expandable config-row-alt0 notInherited">
2008 <td class="micon"><a class="exi" href="#expand"> </a></td>
2011 <a id="Roo.Component-event-*destroy"></a>
2013 <div class="fixedFont">
2014 <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>)
2020 <div class="short">Fires after the component is destroyed.
2026 Fires after the component is destroyed.
2032 <dl class="detailList">
2033 <dt class="heading">Parameters:</dt>
2036 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2057 <td class="msource">
2062 <tr class="method-row expandable config-row-alt1 notInherited">
2063 <td class="micon"><a class="exi" href="#expand"> </a></td>
2066 <a id="Roo.Component-event-*disable"></a>
2068 <div class="fixedFont">
2069 <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>)
2075 <div class="short">Fires after the component is disabled.
2081 Fires after the component is disabled.
2087 <dl class="detailList">
2088 <dt class="heading">Parameters:</dt>
2091 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2112 <td class="msource">
2117 <tr class="method-row expandable config-row-alt0 notInherited">
2118 <td class="micon"><a class="exi" href="#expand"> </a></td>
2121 <a id="Roo.Component-event-*enable"></a>
2123 <div class="fixedFont">
2124 <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>)
2130 <div class="short">Fires after the component is enabled.
2136 Fires after the component is enabled.
2142 <dl class="detailList">
2143 <dt class="heading">Parameters:</dt>
2146 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2167 <td class="msource">
2172 <tr class="method-row expandable config-row-alt1 notInherited">
2173 <td class="micon"><a class="exi" href="#expand"> </a></td>
2176 <a id="Roo.Component-event-*hide"></a>
2178 <div class="fixedFont">
2179 <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>)
2185 <div class="short">Fires after the component is hidden.
2191 Fires after the component is hidden.
2197 <dl class="detailList">
2198 <dt class="heading">Parameters:</dt>
2201 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2222 <td class="msource">
2227 <tr class="method-row expandable config-row-alt0 notInherited">
2228 <td class="micon"><a class="exi" href="#expand"> </a></td>
2231 <a id="Roo.Component-event-*render"></a>
2233 <div class="fixedFont">
2234 <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>)
2240 <div class="short">Fires after the component is rendered.
2246 Fires after the component is rendered.
2252 <dl class="detailList">
2253 <dt class="heading">Parameters:</dt>
2256 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2277 <td class="msource">
2282 <tr class="method-row expandable config-row-alt1 notInherited">
2283 <td class="micon"><a class="exi" href="#expand"> </a></td>
2286 <a id="Roo.Component-event-*show"></a>
2288 <div class="fixedFont">
2289 <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>)
2295 <div class="short">Fires after the component is shown.
2301 Fires after the component is shown.
2307 <dl class="detailList">
2308 <dt class="heading">Parameters:</dt>
2311 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2332 <td class="msource">
2344 <!-- ============================== footer ================================= -->
2345 <div class="fineprint" style="clear:both">
2347 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Jul 27 2010 11:08:31 GMT+0800 (HKT)
2349 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>