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.BoxComponent</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.BoxComponent-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.BoxComponent-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.BoxComponent-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.BoxComponent-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 class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.BoxComponent
53 <!-- ============================== class title / details ============================ -->
56 <h1 class="classTitle">
58 Class Roo.BoxComponent
61 <table cellspacing="0" class="class-summary-table">
63 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
65 <tr><td class="label">Defined In:</td><td class="hd-info">
67 <a href="./src/Roo_BoxComponent.js.html">Roo/BoxComponent.js</a>.
70 <tr><td class="label">Class:</td><td class="hd-info">BoxComponent</td></tr>
73 <tr><td class="label">Subclasses:</td><td class="hd-info">
74 <a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a>, <a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a>, <a href="./Roo.form.ComboBoxArray.html#constructor" roo:cls="Roo.form.ComboBoxArray.html#constructor">Roo.form.ComboBoxArray</a>, <a href="./Roo.form.ComboBoxArray.Item.html#constructor" roo:cls="Roo.form.ComboBoxArray.Item.html#constructor">Roo.form.ComboBoxArray.Item</a>, <a href="./Roo.form.ComboCheck.html#constructor" roo:cls="Roo.form.ComboCheck.html#constructor">Roo.form.ComboCheck</a>, <a href="./Roo.form.DateField.html#constructor" roo:cls="Roo.form.DateField.html#constructor">Roo.form.DateField</a>, <a href="./Roo.form.DayPicker.html#constructor" roo:cls="Roo.form.DayPicker.html#constructor">Roo.form.DayPicker</a>, <a href="./Roo.form.DisplayField.html#constructor" roo:cls="Roo.form.DisplayField.html#constructor">Roo.form.DisplayField</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.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.HtmlEditor.html#constructor" roo:cls="Roo.form.HtmlEditor.html#constructor">Roo.form.HtmlEditor</a>, <a href="./Roo.form.MonthField.html#constructor" roo:cls="Roo.form.MonthField.html#constructor">Roo.form.MonthField</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.Select.html#constructor" roo:cls="Roo.form.Select.html#constructor">Roo.form.Select</a>, <a href="./Roo.form.Signature.html#constructor" roo:cls="Roo.form.Signature.html#constructor">Roo.form.Signature</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>
82 <tr><td class="label">Extends:</td><td class="hd-info">
83 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
91 <!-- ============================== class summary ========================== -->
92 <div class="description">
93 Base class for any visual {<b>link</b> Roo.Component} that uses a box container. BoxComponent provides automatic box<br/>model adjustments for sizing and positioning and will work correctly withnin the Component rendering model. All<br/>container classes should subclass BoxComponent so that they will work consistently when nested within other Ext<br/>layout containers.
97 <!-- ============================== Class comment block... ========================== -->
99 <div class="comments">
100 <b>Class Comments / Notes</B> =>
101 <u onclick="parent.CommentDialog.showCommentId = 'Roo.BoxComponent';">[Add Your comment/notes about this class]</u>
103 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
104 src="/blog.php/GtkDjsComments/Roo.BoxComponent.html"></iframe>
109 <!-- ============================== config options ========================== -->
114 <div class="hr"></div>
115 <a id="Roo.BoxComponent-configs"></a>
121 <table cellspacing="0" class="member-table">
122 <caption>Config Options (Usually are also Properties)</caption>
126 <th class="sig-header" colspan="2">Options</th>
128 <th class="msource-header">Defined By</th>
135 <tr class="config-row expandable config-row-alt0">
136 <td class="micon"><a class="exi" href="#expand"> </a></td>
139 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
140 <div class="fixedFont">
141 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
147 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
152 which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'
162 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
168 <tr class="config-row expandable config-row-alt1">
169 <td class="micon"><a class="exi" href="#expand"> </a></td>
172 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
173 <div class="fixedFont">
174 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
180 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
185 Whether the component can move the Dom node when rendering (defaults to true).
195 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
201 <tr class="config-row expandable config-row-alt0">
202 <td class="micon"><a class="exi" href="#expand"> </a></td>
205 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
206 <div class="fixedFont">
207 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
213 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
218 CSS class added to the component when it is disabled (defaults to "x-item-disabled").
228 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
234 <tr class="config-row expandable config-row-alt1 notInherited">
235 <td class="micon"><a class="exi" href="#expand"> </a></td>
238 <a id="Roo.BoxComponent-cfg-height" name=".height"></a>
239 <div class="fixedFont">
240 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
246 <div class="short">height (optional) size of component</div>
251 height (optional) size of component
267 <tr class="config-row expandable config-row-alt0">
268 <td class="micon"><a class="exi" href="#expand"> </a></td>
271 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
272 <div class="fixedFont">
273 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
279 <div class="short">How this component should hidden.</div>
284 How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".
285 <BR/>Possible Values: display, visibility
294 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
300 <tr class="config-row expandable config-row-alt1">
301 <td class="micon"><a class="exi" href="#expand"> </a></td>
304 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
305 <div class="fixedFont">
306 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
312 <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>
317 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>
327 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
333 <tr class="config-row expandable config-row-alt0 notInherited">
334 <td class="micon"><a class="exi" href="#expand"> </a></td>
337 <a id="Roo.BoxComponent-cfg-width" name=".width"></a>
338 <div class="fixedFont">
339 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
345 <div class="short">width (optional) size of component</div>
350 width (optional) size of component
376 <!-- ============================== public properties ==================== -->
380 <a id="Roo.BoxComponent-props"></a>
386 <table cellspacing="0" class="member-table">
387 <caption class="Empty">Public Properties - Has None</caption>
393 <!-- ============================== methods summary / details ======================== -->
396 <a id="Roo.BoxComponent-methods"></a>
397 <!-- constructor?? -->
404 <!-- then dynamics first -->
411 <table cellspacing="0" class="member-table">
412 <caption>Public Methods</caption>
414 <th class="sig-header" colspan="2">Method</th>
415 <th class="msource-header">Defined By</th>
425 <tr class="method-row config-row-alt0 expandable notInherited">
426 <td class="micon"><a class="exi" href="#expand"> </a></td>
430 <a id="Roo-method-BoxComponent" name=".BoxComponent"></a>
431 <div class="fixedFont">
432 <span class="attributes">new <B>Roo.</B></span><b class="itemname">BoxComponent</b>
434 (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object <B><i>config</i></B>)
442 <div class="short">Create a new Roo.BoxComponent</div>
449 Create a new Roo.BoxComponent
452 <dl class="detailList">
453 <dt class="heading">Parameters:</dt>
456 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object</span> <b>config</b>
459 <dd>The configuration options.</dd>
483 <tr class="method-row config-row-alt1 expandable">
484 <td class="micon"><a class="exi" href="#expand"> </a></td>
488 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
489 <div class="fixedFont">
490 <span class="attributes"></span><b class="itemname">addEvents</b>
492 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
499 <div class="short">Used to define events on this Observable</div>
505 Used to define events on this Observable
512 <dl class="detailList">
513 <dt class="heading">Parameters:</dt>
516 <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>
519 <dd>The object with the events defined</dd>
539 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
545 <tr class="method-row config-row-alt0 expandable">
546 <td class="micon"><a class="exi" href="#expand"> </a></td>
550 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
551 <div class="fixedFont">
552 <span class="attributes"></span><b class="itemname">addListener</b>
554 (<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>)
561 <div class="short">Appends an event handler to this component</div>
567 Appends an event handler to this component
574 <dl class="detailList">
575 <dt class="heading">Parameters:</dt>
578 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
581 <dd>The type of event to listen for</dd>
584 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
587 <dd>The method the event invokes</dd>
590 <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>
593 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
596 <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>
599 <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>
619 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
625 <tr class="method-row config-row-alt1 expandable">
626 <td class="micon"><a class="exi" href="#expand"> </a></td>
630 <a id="Roo.Component-method-destroy" name=".destroy"></a>
631 <div class="fixedFont">
632 <span class="attributes"></span><b class="itemname">destroy</b>
641 <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>
647 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}.
670 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
676 <tr class="method-row config-row-alt0 expandable">
677 <td class="micon"><a class="exi" href="#expand"> </a></td>
681 <a id="Roo.Component-method-disable" name=".disable"></a>
682 <div class="fixedFont">
683 <span class="attributes"></span><b class="itemname">disable</b>
691 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
700 <div class="short">Disable this component.</div>
706 Disable this component.
717 <dl class="detailList">
718 <dt class="heading">Returns:</dt>
720 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
736 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
742 <tr class="method-row config-row-alt1 expandable">
743 <td class="micon"><a class="exi" href="#expand"> </a></td>
747 <a id="Roo.Component-method-enable" name=".enable"></a>
748 <div class="fixedFont">
749 <span class="attributes"></span><b class="itemname">enable</b>
757 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
766 <div class="short">Enable this component.</div>
772 Enable this component.
783 <dl class="detailList">
784 <dt class="heading">Returns:</dt>
786 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
802 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
808 <tr class="method-row config-row-alt0 expandable">
809 <td class="micon"><a class="exi" href="#expand"> </a></td>
813 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
814 <div class="fixedFont">
815 <span class="attributes"></span><b class="itemname">fireEvent</b>
817 (<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>)
823 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
832 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
838 Fires the specified event with the passed parameters (minus the event name).
845 <dl class="detailList">
846 <dt class="heading">Parameters:</dt>
849 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
855 <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>
858 <dd>Variable number of parameters are passed to handlers</dd>
866 <dl class="detailList">
867 <dt class="heading">Returns:</dt>
869 <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>
885 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
891 <tr class="method-row config-row-alt1 expandable">
892 <td class="micon"><a class="exi" href="#expand"> </a></td>
896 <a id="Roo.Component-method-focus" name=".focus"></a>
897 <div class="fixedFont">
898 <span class="attributes"></span><b class="itemname">focus</b>
900 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
906 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
915 <div class="short">Try to focus this component.</div>
921 Try to focus this component.
928 <dl class="detailList">
929 <dt class="heading">Parameters:</dt>
932 <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>
935 <dd>True to also select the text in this component (if applicable)</dd>
943 <dl class="detailList">
944 <dt class="heading">Returns:</dt>
946 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
962 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
968 <tr class="method-row config-row-alt0 expandable notInherited">
969 <td class="micon"><a class="exi" href="#expand"> </a></td>
973 <a id="Roo.BoxComponent-method-getBox" name=".getBox"></a>
974 <div class="fixedFont">
975 <span class="attributes"></span><b class="itemname">getBox</b>
977 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
984 <div class="short">Gets the current box measurements of the component's underlying element.</div>
990 Gets the current box measurements of the component's underlying element.
997 <dl class="detailList">
998 <dt class="heading">Parameters:</dt>
1001 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>local</b>
1004 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1022 <td class="msource">
1030 <tr class="method-row config-row-alt1 expandable">
1031 <td class="micon"><a class="exi" href="#expand"> </a></td>
1035 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1036 <div class="fixedFont">
1037 <span class="attributes"></span><b class="itemname">getEl</b>
1045 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1054 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1060 Returns the underlying {<b>link</b> Roo.Element}.
1071 <dl class="detailList">
1072 <dt class="heading">Returns:</dt>
1074 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1088 <td class="msource">
1090 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1096 <tr class="method-row config-row-alt0 expandable">
1097 <td class="micon"><a class="exi" href="#expand"> </a></td>
1101 <a id="Roo.Component-method-getId" name=".getId"></a>
1102 <div class="fixedFont">
1103 <span class="attributes"></span><b class="itemname">getId</b>
1111 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1120 <div class="short">Returns the id of this component.</div>
1126 Returns the id of this component.
1137 <dl class="detailList">
1138 <dt class="heading">Returns:</dt>
1140 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1154 <td class="msource">
1156 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1162 <tr class="method-row config-row-alt1 expandable notInherited">
1163 <td class="micon"><a class="exi" href="#expand"> </a></td>
1167 <a id="Roo.BoxComponent-method-getPosition" name=".getPosition"></a>
1168 <div class="fixedFont">
1169 <span class="attributes"></span><b class="itemname">getPosition</b>
1171 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1177 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1186 <div class="short">Gets the current XY position of the component's underlying element.</div>
1192 Gets the current XY position of the component's underlying element.
1199 <dl class="detailList">
1200 <dt class="heading">Parameters:</dt>
1203 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>local</b>
1206 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1214 <dl class="detailList">
1215 <dt class="heading">Returns:</dt>
1217 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> The XY position of the element (e.g., [100, 200])</dd>
1231 <td class="msource">
1239 <tr class="method-row config-row-alt0 expandable notInherited">
1240 <td class="micon"><a class="exi" href="#expand"> </a></td>
1244 <a id="Roo.BoxComponent-method-getSize" name=".getSize"></a>
1245 <div class="fixedFont">
1246 <span class="attributes"></span><b class="itemname">getSize</b>
1254 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1263 <div class="short">Gets the current size of the component's underlying element.</div>
1269 Gets the current size of the component's underlying element.
1280 <dl class="detailList">
1281 <dt class="heading">Returns:</dt>
1283 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> An object containing the element's size {width: (element width), height: (element height)}</dd>
1297 <td class="msource">
1305 <tr class="method-row config-row-alt1 expandable">
1306 <td class="micon"><a class="exi" href="#expand"> </a></td>
1310 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1311 <div class="fixedFont">
1312 <span class="attributes"></span><b class="itemname">hasListener</b>
1314 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1320 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1329 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1335 Checks to see if this object has any listeners for a specified event
1342 <dl class="detailList">
1343 <dt class="heading">Parameters:</dt>
1346 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1349 <dd>The name of the event to check for</dd>
1357 <dl class="detailList">
1358 <dt class="heading">Returns:</dt>
1360 <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>
1374 <td class="msource">
1376 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1382 <tr class="method-row config-row-alt0 expandable">
1383 <td class="micon"><a class="exi" href="#expand"> </a></td>
1387 <a id="Roo.Component-method-hide" name=".hide"></a>
1388 <div class="fixedFont">
1389 <span class="attributes"></span><b class="itemname">hide</b>
1397 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1406 <div class="short">Hide this component.</div>
1412 Hide this component.
1423 <dl class="detailList">
1424 <dt class="heading">Returns:</dt>
1426 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1440 <td class="msource">
1442 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1448 <tr class="method-row config-row-alt1 expandable">
1449 <td class="micon"><a class="exi" href="#expand"> </a></td>
1453 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1454 <div class="fixedFont">
1455 <span class="attributes"></span><b class="itemname">isVisible</b>
1464 <div class="short">Returns true if this component is visible.</div>
1470 Returns true if this component is visible.
1491 <td class="msource">
1493 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1499 <tr class="method-row config-row-alt0 expandable">
1500 <td class="micon"><a class="exi" href="#expand"> </a></td>
1504 <a id="Roo.util.Observable-method-on" name=".on"></a>
1505 <div class="fixedFont">
1506 <span class="attributes"></span><b class="itemname">on</b>
1508 (<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>)
1515 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1521 Appends an event handler to this element (shorthand for addListener)
1528 <dl class="detailList">
1529 <dt class="heading">Parameters:</dt>
1532 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1535 <dd>The type of event to listen for</dd>
1538 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1541 <dd>The method the event invokes</dd>
1544 <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>
1547 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1550 <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>
1571 <td class="msource">
1573 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1579 <tr class="method-row config-row-alt1 expandable notInherited">
1580 <td class="micon"><a class="exi" href="#expand"> </a></td>
1584 <a id="Roo.BoxComponent-method-onPosition" name=".onPosition"></a>
1585 <div class="fixedFont">
1586 <span class="attributes"></span><b class="itemname">onPosition</b>
1588 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
1595 <div class="short">Called after the component is moved, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a move occurs.</div>
1601 Called after the component is moved, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a move occurs.
1608 <dl class="detailList">
1609 <dt class="heading">Parameters:</dt>
1612 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
1615 <dd>The new x position</dd>
1618 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
1621 <dd>The new y position</dd>
1639 <td class="msource">
1647 <tr class="method-row config-row-alt0 expandable notInherited">
1648 <td class="micon"><a class="exi" href="#expand"> </a></td>
1652 <a id="Roo.BoxComponent-method-onResize" name=".onResize"></a>
1653 <div class="fixedFont">
1654 <span class="attributes"></span><b class="itemname">onResize</b>
1656 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjHeight</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawHeight</i></B>)
1663 <div class="short">Called after the component is resized, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a resize occurs.</div>
1669 Called after the component is resized, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a resize occurs.
1676 <dl class="detailList">
1677 <dt class="heading">Parameters:</dt>
1680 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
1683 <dd>The box-adjusted width that was set</dd>
1686 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
1689 <dd>The box-adjusted height that was set</dd>
1692 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
1695 <dd>The width that was originally specified</dd>
1698 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
1701 <dd>The height that was originally specified</dd>
1719 <td class="msource">
1727 <tr class="method-row config-row-alt1 expandable">
1728 <td class="micon"><a class="exi" href="#expand"> </a></td>
1732 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1733 <div class="fixedFont">
1734 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1743 <div class="short">Removes all listeners for this object</div>
1749 Removes all listeners for this object
1770 <td class="msource">
1772 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1778 <tr class="method-row config-row-alt0 expandable">
1779 <td class="micon"><a class="exi" href="#expand"> </a></td>
1783 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1784 <div class="fixedFont">
1785 <span class="attributes"></span><b class="itemname">removeListener</b>
1787 (<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>)
1794 <div class="short">Removes a listener</div>
1807 <dl class="detailList">
1808 <dt class="heading">Parameters:</dt>
1811 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1814 <dd>The type of event to listen for</dd>
1817 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1820 <dd>The handler to remove</dd>
1823 <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>
1826 <dd>(optional) The scope (this object) for the handler</dd>
1844 <td class="msource">
1846 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1852 <tr class="method-row config-row-alt1 expandable">
1853 <td class="micon"><a class="exi" href="#expand"> </a></td>
1857 <a id="Roo.Component-method-render" name=".render"></a>
1858 <div class="fixedFont">
1859 <span class="attributes"></span><b class="itemname">render</b>
1861 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1868 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1874 If this is a lazy rendering component, render it to its container element.
1881 <dl class="detailList">
1882 <dt class="heading">Parameters:</dt>
1885 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1888 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1906 <td class="msource">
1908 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1914 <tr class="method-row config-row-alt0 expandable">
1915 <td class="micon"><a class="exi" href="#expand"> </a></td>
1919 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1920 <div class="fixedFont">
1921 <span class="attributes"></span><b class="itemname">setDisabled</b>
1923 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1930 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1936 Convenience function for setting disabled/enabled by boolean.
1943 <dl class="detailList">
1944 <dt class="heading">Parameters:</dt>
1947 <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>
1968 <td class="msource">
1970 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1976 <tr class="method-row config-row-alt1 expandable notInherited">
1977 <td class="micon"><a class="exi" href="#expand"> </a></td>
1981 <a id="Roo.BoxComponent-method-setPagePosition" name=".setPagePosition"></a>
1982 <div class="fixedFont">
1983 <span class="attributes"></span><b class="itemname">setPagePosition</b>
1985 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
1992 <div class="short">Sets the page XY position of the component.</div>
1998 Sets the page XY position of the component. To set the left and top instead, use {<b>link</b> <b>setPosition</b>}.<br/>This method fires the move event.
2005 <dl class="detailList">
2006 <dt class="heading">Parameters:</dt>
2009 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
2012 <dd>The new x position</dd>
2015 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
2018 <dd>The new y position</dd>
2036 <td class="msource">
2044 <tr class="method-row config-row-alt0 expandable notInherited">
2045 <td class="micon"><a class="exi" href="#expand"> </a></td>
2049 <a id="Roo.BoxComponent-method-setPosition" name=".setPosition"></a>
2050 <div class="fixedFont">
2051 <span class="attributes"></span><b class="itemname">setPosition</b>
2053 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>left</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>top</i></B>)
2060 <div class="short">Sets the left and top of the component.</div>
2066 Sets the left and top of the component. To set the page XY position instead, use {<b>link</b> <b>setPagePosition</b>}.<br/>This method fires the move event.
2073 <dl class="detailList">
2074 <dt class="heading">Parameters:</dt>
2077 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>left</b>
2080 <dd>The new left</dd>
2083 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>top</b>
2086 <dd>The new top</dd>
2104 <td class="msource">
2112 <tr class="method-row config-row-alt1 expandable notInherited">
2113 <td class="micon"><a class="exi" href="#expand"> </a></td>
2117 <a id="Roo.BoxComponent-method-setSize" name=".setSize"></a>
2118 <div class="fixedFont">
2119 <span class="attributes"></span><b class="itemname">setSize</b>
2121 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>)
2127 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2136 <div class="short">Sets the width and height of the component.</div>
2142 Sets the width and height of the component. This method fires the resize event. This method can accept<br/>either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
2149 <dl class="detailList">
2150 <dt class="heading">Parameters:</dt>
2153 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object</span> <b>width</b>
2156 <dd>The new width to set, or a size object in the format {width, height}</dd>
2159 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
2162 <dd>The new height to set (not required if a size object is passed as the first arg)</dd>
2170 <dl class="detailList">
2171 <dt class="heading">Returns:</dt>
2173 <dd><span class="fixedFont"><a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a></span> this</dd>
2187 <td class="msource">
2195 <tr class="method-row config-row-alt0 expandable">
2196 <td class="micon"><a class="exi" href="#expand"> </a></td>
2200 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
2201 <div class="fixedFont">
2202 <span class="attributes"></span><b class="itemname">setVisible</b>
2204 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
2210 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2219 <div class="short">Convenience function to hide or show this component by boolean.</div>
2225 Convenience function to hide or show this component by boolean.
2232 <dl class="detailList">
2233 <dt class="heading">Parameters:</dt>
2236 <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>
2239 <dd>True to show, false to hide</dd>
2247 <dl class="detailList">
2248 <dt class="heading">Returns:</dt>
2250 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2264 <td class="msource">
2266 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2272 <tr class="method-row config-row-alt1 expandable">
2273 <td class="micon"><a class="exi" href="#expand"> </a></td>
2277 <a id="Roo.Component-method-show" name=".show"></a>
2278 <div class="fixedFont">
2279 <span class="attributes"></span><b class="itemname">show</b>
2287 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2296 <div class="short">Show this component.</div>
2302 Show this component.
2313 <dl class="detailList">
2314 <dt class="heading">Returns:</dt>
2316 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2330 <td class="msource">
2332 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2338 <tr class="method-row config-row-alt0 expandable notInherited">
2339 <td class="micon"><a class="exi" href="#expand"> </a></td>
2343 <a id="Roo.BoxComponent-method-syncSize" name=".syncSize"></a>
2344 <div class="fixedFont">
2345 <span class="attributes"></span><b class="itemname">syncSize</b>
2354 <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
2360 Force the component's size to recalculate based on the underlying element's current height and width.
2381 <td class="msource">
2389 <tr class="method-row config-row-alt1 expandable">
2390 <td class="micon"><a class="exi" href="#expand"> </a></td>
2394 <a id="Roo.util.Observable-method-un" name=".un"></a>
2395 <div class="fixedFont">
2396 <span class="attributes"></span><b class="itemname">un</b>
2398 (<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>)
2405 <div class="short">Removes a listener (shorthand for removeListener)</div>
2411 Removes a listener (shorthand for removeListener)
2418 <dl class="detailList">
2419 <dt class="heading">Parameters:</dt>
2422 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2425 <dd>The type of event to listen for</dd>
2428 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2431 <dd>The handler to remove</dd>
2434 <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>
2437 <dd>(optional) The scope (this object) for the handler</dd>
2455 <td class="msource">
2457 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2463 <tr class="method-row config-row-alt0 expandable notInherited">
2464 <td class="micon"><a class="exi" href="#expand"> </a></td>
2468 <a id="Roo.BoxComponent-method-updateBox" name=".updateBox"></a>
2469 <div class="fixedFont">
2470 <span class="attributes"></span><b class="itemname">updateBox</b>
2472 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>box</i></B>)
2479 <div class="short">Sets the current box measurements of the component's underlying element.</div>
2485 Sets the current box measurements of the component's underlying element.
2492 <dl class="detailList">
2493 <dt class="heading">Parameters:</dt>
2496 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>box</b>
2499 <dd>An object in the format {x, y, width, height}</dd>
2517 <td class="msource">
2528 <!-- ============================== events summary / details ======================== -->
2531 <a id="Roo.BoxComponent-events"></a>
2540 <table cellspacing="0" class="member-table">
2541 <caption>Events</caption>
2544 <th class="sig-header" colspan="2">Event</th>
2545 <th class="msource-header">Defined By</th>
2554 <tr class="method-row expandable config-row-alt0">
2555 <td class="micon"><a class="exi" href="#expand"> </a></td>
2558 <a id="Roo.Component-event-*beforedestroy"></a>
2560 <div class="fixedFont">
2561 <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>)
2567 <div class="short">Fires before the component is destroyed.
2573 Fires before the component is destroyed. Return false to stop the destroy.
2579 <dl class="detailList">
2580 <dt class="heading">Parameters:</dt>
2583 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2604 <td class="msource">
2605 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2609 <tr class="method-row expandable config-row-alt1">
2610 <td class="micon"><a class="exi" href="#expand"> </a></td>
2613 <a id="Roo.Component-event-*beforehide"></a>
2615 <div class="fixedFont">
2616 <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>)
2622 <div class="short">Fires before the component is hidden.
2628 Fires before the component is hidden. Return false to stop the hide.
2634 <dl class="detailList">
2635 <dt class="heading">Parameters:</dt>
2638 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2659 <td class="msource">
2660 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2664 <tr class="method-row expandable config-row-alt0">
2665 <td class="micon"><a class="exi" href="#expand"> </a></td>
2668 <a id="Roo.Component-event-*beforerender"></a>
2670 <div class="fixedFont">
2671 <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>)
2677 <div class="short">Fires before the component is rendered.
2683 Fires before the component is rendered. Return false to stop the render.
2689 <dl class="detailList">
2690 <dt class="heading">Parameters:</dt>
2693 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2714 <td class="msource">
2715 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2719 <tr class="method-row expandable config-row-alt1">
2720 <td class="micon"><a class="exi" href="#expand"> </a></td>
2723 <a id="Roo.Component-event-*beforeshow"></a>
2725 <div class="fixedFont">
2726 <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>)
2732 <div class="short">Fires before the component is shown.
2738 Fires before the component is shown. Return false to stop the show.
2744 <dl class="detailList">
2745 <dt class="heading">Parameters:</dt>
2748 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2769 <td class="msource">
2770 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2774 <tr class="method-row expandable config-row-alt0">
2775 <td class="micon"><a class="exi" href="#expand"> </a></td>
2778 <a id="Roo.Component-event-*destroy"></a>
2780 <div class="fixedFont">
2781 <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>)
2787 <div class="short">Fires after the component is destroyed.
2793 Fires after the component is destroyed.
2799 <dl class="detailList">
2800 <dt class="heading">Parameters:</dt>
2803 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2824 <td class="msource">
2825 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2829 <tr class="method-row expandable config-row-alt1">
2830 <td class="micon"><a class="exi" href="#expand"> </a></td>
2833 <a id="Roo.Component-event-*disable"></a>
2835 <div class="fixedFont">
2836 <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>)
2842 <div class="short">Fires after the component is disabled.
2848 Fires after the component is disabled.
2854 <dl class="detailList">
2855 <dt class="heading">Parameters:</dt>
2858 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2879 <td class="msource">
2880 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2884 <tr class="method-row expandable config-row-alt0">
2885 <td class="micon"><a class="exi" href="#expand"> </a></td>
2888 <a id="Roo.Component-event-*enable"></a>
2890 <div class="fixedFont">
2891 <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>)
2897 <div class="short">Fires after the component is enabled.
2903 Fires after the component is enabled.
2909 <dl class="detailList">
2910 <dt class="heading">Parameters:</dt>
2913 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2934 <td class="msource">
2935 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2939 <tr class="method-row expandable config-row-alt1">
2940 <td class="micon"><a class="exi" href="#expand"> </a></td>
2943 <a id="Roo.Component-event-*hide"></a>
2945 <div class="fixedFont">
2946 <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>)
2952 <div class="short">Fires after the component is hidden.
2958 Fires after the component is hidden.
2964 <dl class="detailList">
2965 <dt class="heading">Parameters:</dt>
2968 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2989 <td class="msource">
2990 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2994 <tr class="method-row expandable config-row-alt0 notInherited">
2995 <td class="micon"><a class="exi" href="#expand"> </a></td>
2998 <a id="Roo.BoxComponent-event-*move"></a>
3000 <div class="fixedFont">
3001 <b class="itemname">move</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
3007 <div class="short">Fires after the component is moved.
3013 Fires after the component is moved.
3019 <dl class="detailList">
3020 <dt class="heading">Parameters:</dt>
3023 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3029 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
3032 <dd>The new x position</dd>
3035 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
3038 <dd>The new y position</dd>
3056 <td class="msource">
3061 <tr class="method-row expandable config-row-alt1">
3062 <td class="micon"><a class="exi" href="#expand"> </a></td>
3065 <a id="Roo.Component-event-*render"></a>
3067 <div class="fixedFont">
3068 <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>)
3074 <div class="short">Fires after the component is rendered.
3080 Fires after the component is rendered.
3086 <dl class="detailList">
3087 <dt class="heading">Parameters:</dt>
3090 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3111 <td class="msource">
3112 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3116 <tr class="method-row expandable config-row-alt0 notInherited">
3117 <td class="micon"><a class="exi" href="#expand"> </a></td>
3120 <a id="Roo.BoxComponent-event-*resize"></a>
3122 <div class="fixedFont">
3123 <b class="itemname">resize</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjHeight</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawHeight</i></B>)
3129 <div class="short">Fires after the component is resized.
3135 Fires after the component is resized.
3141 <dl class="detailList">
3142 <dt class="heading">Parameters:</dt>
3145 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3151 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
3154 <dd>The box-adjusted width that was set</dd>
3157 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
3160 <dd>The box-adjusted height that was set</dd>
3163 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
3166 <dd>The width that was originally specified</dd>
3169 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
3172 <dd>The height that was originally specified</dd>
3190 <td class="msource">
3195 <tr class="method-row expandable config-row-alt1">
3196 <td class="micon"><a class="exi" href="#expand"> </a></td>
3199 <a id="Roo.Component-event-*show"></a>
3201 <div class="fixedFont">
3202 <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>)
3208 <div class="short">Fires after the component is shown.
3214 Fires after the component is shown.
3220 <dl class="detailList">
3221 <dt class="heading">Parameters:</dt>
3224 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3245 <td class="msource">
3246 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3257 <!-- ============================== footer ================================= -->
3258 <div class="fineprint" style="clear:both">
3260 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Nov 13 2015 13:15:52 GMT+0800 (HKT)
3262 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>