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.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.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.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.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>
151 <div class="long">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
159 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
165 <tr class="config-row expandable config-row-alt1">
166 <td class="micon"><a class="exi" href="#expand"> </a></td>
169 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
170 <div class="fixedFont">
171 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
177 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
181 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
189 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
195 <tr class="config-row expandable config-row-alt0">
196 <td class="micon"><a class="exi" href="#expand"> </a></td>
199 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
200 <div class="fixedFont">
201 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
207 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
211 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
219 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
225 <tr class="config-row expandable config-row-alt1 notInherited">
226 <td class="micon"><a class="exi" href="#expand"> </a></td>
229 <a id="Roo.BoxComponent-cfg-height" name=".height"></a>
230 <div class="fixedFont">
231 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
237 <div class="short">height (optional) size of component</div>
241 <div class="long">height (optional) size of component</div>
255 <tr class="config-row expandable config-row-alt0">
256 <td class="micon"><a class="exi" href="#expand"> </a></td>
259 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
260 <div class="fixedFont">
261 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
267 <div class="short">How this component should hidden.</div>
271 <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>
279 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
285 <tr class="config-row expandable config-row-alt1">
286 <td class="micon"><a class="exi" href="#expand"> </a></td>
289 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
290 <div class="fixedFont">
291 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
297 <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>
301 <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>
309 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
315 <tr class="config-row expandable config-row-alt0 notInherited">
316 <td class="micon"><a class="exi" href="#expand"> </a></td>
319 <a id="Roo.BoxComponent-cfg-width" name=".width"></a>
320 <div class="fixedFont">
321 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
327 <div class="short">width (optional) size of component</div>
331 <div class="long">width (optional) size of component</div>
355 <!-- ============================== public properties ==================== -->
359 <a id="Roo.BoxComponent-props"></a>
365 <table cellspacing="0" class="member-table">
366 <caption class="Empty">Public Properties - Has None</caption>
372 <!-- ============================== methods summary / details ======================== -->
375 <a id="Roo.BoxComponent-methods"></a>
376 <!-- constructor?? -->
383 <!-- then dynamics first -->
390 <table cellspacing="0" class="member-table">
391 <caption>Public Methods</caption>
393 <th class="sig-header" colspan="2">Method</th>
394 <th class="msource-header">Defined By</th>
404 <tr class="method-row config-row-alt0 expandable notInherited">
405 <td class="micon"><a class="exi" href="#expand"> </a></td>
409 <a id="Roo-method-BoxComponent" name=".BoxComponent"></a>
410 <div class="fixedFont">
411 <span class="attributes">new <B>Roo.</B></span><b class="itemname">BoxComponent</b>
413 (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object <B><i>config</i></B>)
421 <div class="short">Create a new Roo.BoxComponent</div>
428 Create a new Roo.BoxComponent
431 <dl class="detailList">
432 <dt class="heading">Parameters:</dt>
435 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object</span> <b>config</b>
438 <dd>The configuration options.</dd>
462 <tr class="method-row config-row-alt1 expandable">
463 <td class="micon"><a class="exi" href="#expand"> </a></td>
467 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
468 <div class="fixedFont">
469 <span class="attributes"></span><b class="itemname">addEvents</b>
471 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
478 <div class="short">Used to define events on this Observable</div>
484 Used to define events on this Observable
491 <dl class="detailList">
492 <dt class="heading">Parameters:</dt>
495 <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>
498 <dd>The object with the events defined</dd>
518 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
524 <tr class="method-row config-row-alt0 expandable">
525 <td class="micon"><a class="exi" href="#expand"> </a></td>
529 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
530 <div class="fixedFont">
531 <span class="attributes"></span><b class="itemname">addListener</b>
533 (<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>)
540 <div class="short">Appends an event handler to this component</div>
546 Appends an event handler to this component
553 <dl class="detailList">
554 <dt class="heading">Parameters:</dt>
557 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
560 <dd>The type of event to listen for</dd>
563 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
566 <dd>The method the event invokes</dd>
569 <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>
572 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
575 <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>
578 <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>
598 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
604 <tr class="method-row config-row-alt1 expandable">
605 <td class="micon"><a class="exi" href="#expand"> </a></td>
609 <a id="Roo.Component-method-destroy" name=".destroy"></a>
610 <div class="fixedFont">
611 <span class="attributes"></span><b class="itemname">destroy</b>
620 <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>
626 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}.
649 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
655 <tr class="method-row config-row-alt0 expandable">
656 <td class="micon"><a class="exi" href="#expand"> </a></td>
660 <a id="Roo.Component-method-disable" name=".disable"></a>
661 <div class="fixedFont">
662 <span class="attributes"></span><b class="itemname">disable</b>
670 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
679 <div class="short">Disable this component.</div>
685 Disable this component.
696 <dl class="detailList">
697 <dt class="heading">Returns:</dt>
699 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
715 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
721 <tr class="method-row config-row-alt1 expandable">
722 <td class="micon"><a class="exi" href="#expand"> </a></td>
726 <a id="Roo.Component-method-enable" name=".enable"></a>
727 <div class="fixedFont">
728 <span class="attributes"></span><b class="itemname">enable</b>
736 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
745 <div class="short">Enable this component.</div>
751 Enable this component.
762 <dl class="detailList">
763 <dt class="heading">Returns:</dt>
765 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
781 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
787 <tr class="method-row config-row-alt0 expandable">
788 <td class="micon"><a class="exi" href="#expand"> </a></td>
792 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
793 <div class="fixedFont">
794 <span class="attributes"></span><b class="itemname">fireEvent</b>
796 (<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>)
802 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
811 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
817 Fires the specified event with the passed parameters (minus the event name).
824 <dl class="detailList">
825 <dt class="heading">Parameters:</dt>
828 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
834 <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>
837 <dd>Variable number of parameters are passed to handlers</dd>
845 <dl class="detailList">
846 <dt class="heading">Returns:</dt>
848 <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>
864 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
870 <tr class="method-row config-row-alt1 expandable">
871 <td class="micon"><a class="exi" href="#expand"> </a></td>
875 <a id="Roo.Component-method-focus" name=".focus"></a>
876 <div class="fixedFont">
877 <span class="attributes"></span><b class="itemname">focus</b>
879 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
885 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
894 <div class="short">Try to focus this component.</div>
900 Try to focus this component.
907 <dl class="detailList">
908 <dt class="heading">Parameters:</dt>
911 <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>
914 <dd>True to also select the text in this component (if applicable)</dd>
922 <dl class="detailList">
923 <dt class="heading">Returns:</dt>
925 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
941 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
947 <tr class="method-row config-row-alt0 expandable notInherited">
948 <td class="micon"><a class="exi" href="#expand"> </a></td>
952 <a id="Roo.BoxComponent-method-getBox" name=".getBox"></a>
953 <div class="fixedFont">
954 <span class="attributes"></span><b class="itemname">getBox</b>
956 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
963 <div class="short">Gets the current box measurements of the component's underlying element.</div>
969 Gets the current box measurements of the component's underlying element.
976 <dl class="detailList">
977 <dt class="heading">Parameters:</dt>
980 <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>
983 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1001 <td class="msource">
1009 <tr class="method-row config-row-alt1 expandable">
1010 <td class="micon"><a class="exi" href="#expand"> </a></td>
1014 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1015 <div class="fixedFont">
1016 <span class="attributes"></span><b class="itemname">getEl</b>
1024 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1033 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1039 Returns the underlying {<b>link</b> Roo.Element}.
1050 <dl class="detailList">
1051 <dt class="heading">Returns:</dt>
1053 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1067 <td class="msource">
1069 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1075 <tr class="method-row config-row-alt0 expandable">
1076 <td class="micon"><a class="exi" href="#expand"> </a></td>
1080 <a id="Roo.Component-method-getId" name=".getId"></a>
1081 <div class="fixedFont">
1082 <span class="attributes"></span><b class="itemname">getId</b>
1090 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1099 <div class="short">Returns the id of this component.</div>
1105 Returns the id of this component.
1116 <dl class="detailList">
1117 <dt class="heading">Returns:</dt>
1119 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1133 <td class="msource">
1135 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1141 <tr class="method-row config-row-alt1 expandable notInherited">
1142 <td class="micon"><a class="exi" href="#expand"> </a></td>
1146 <a id="Roo.BoxComponent-method-getPosition" name=".getPosition"></a>
1147 <div class="fixedFont">
1148 <span class="attributes"></span><b class="itemname">getPosition</b>
1150 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1156 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1165 <div class="short">Gets the current XY position of the component's underlying element.</div>
1171 Gets the current XY position of the component's underlying element.
1178 <dl class="detailList">
1179 <dt class="heading">Parameters:</dt>
1182 <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>
1185 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1193 <dl class="detailList">
1194 <dt class="heading">Returns:</dt>
1196 <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>
1210 <td class="msource">
1218 <tr class="method-row config-row-alt0 expandable notInherited">
1219 <td class="micon"><a class="exi" href="#expand"> </a></td>
1223 <a id="Roo.BoxComponent-method-getSize" name=".getSize"></a>
1224 <div class="fixedFont">
1225 <span class="attributes"></span><b class="itemname">getSize</b>
1233 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1242 <div class="short">Gets the current size of the component's underlying element.</div>
1248 Gets the current size of the component's underlying element.
1259 <dl class="detailList">
1260 <dt class="heading">Returns:</dt>
1262 <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>
1276 <td class="msource">
1284 <tr class="method-row config-row-alt1 expandable">
1285 <td class="micon"><a class="exi" href="#expand"> </a></td>
1289 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1290 <div class="fixedFont">
1291 <span class="attributes"></span><b class="itemname">hasListener</b>
1293 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1299 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1308 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1314 Checks to see if this object has any listeners for a specified event
1321 <dl class="detailList">
1322 <dt class="heading">Parameters:</dt>
1325 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1328 <dd>The name of the event to check for</dd>
1336 <dl class="detailList">
1337 <dt class="heading">Returns:</dt>
1339 <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>
1353 <td class="msource">
1355 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1361 <tr class="method-row config-row-alt0 expandable">
1362 <td class="micon"><a class="exi" href="#expand"> </a></td>
1366 <a id="Roo.Component-method-hide" name=".hide"></a>
1367 <div class="fixedFont">
1368 <span class="attributes"></span><b class="itemname">hide</b>
1376 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1385 <div class="short">Hide this component.</div>
1391 Hide this component.
1402 <dl class="detailList">
1403 <dt class="heading">Returns:</dt>
1405 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1419 <td class="msource">
1421 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1427 <tr class="method-row config-row-alt1 expandable">
1428 <td class="micon"><a class="exi" href="#expand"> </a></td>
1432 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1433 <div class="fixedFont">
1434 <span class="attributes"></span><b class="itemname">isVisible</b>
1443 <div class="short">Returns true if this component is visible.</div>
1449 Returns true if this component is visible.
1470 <td class="msource">
1472 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1478 <tr class="method-row config-row-alt0 expandable">
1479 <td class="micon"><a class="exi" href="#expand"> </a></td>
1483 <a id="Roo.util.Observable-method-on" name=".on"></a>
1484 <div class="fixedFont">
1485 <span class="attributes"></span><b class="itemname">on</b>
1487 (<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>)
1494 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1500 Appends an event handler to this element (shorthand for addListener)
1507 <dl class="detailList">
1508 <dt class="heading">Parameters:</dt>
1511 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1514 <dd>The type of event to listen for</dd>
1517 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1520 <dd>The method the event invokes</dd>
1523 <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>
1526 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1529 <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>
1550 <td class="msource">
1552 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1558 <tr class="method-row config-row-alt1 expandable notInherited">
1559 <td class="micon"><a class="exi" href="#expand"> </a></td>
1563 <a id="Roo.BoxComponent-method-onPosition" name=".onPosition"></a>
1564 <div class="fixedFont">
1565 <span class="attributes"></span><b class="itemname">onPosition</b>
1567 (<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>)
1574 <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>
1580 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.
1587 <dl class="detailList">
1588 <dt class="heading">Parameters:</dt>
1591 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
1594 <dd>The new x position</dd>
1597 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
1600 <dd>The new y position</dd>
1618 <td class="msource">
1626 <tr class="method-row config-row-alt0 expandable notInherited">
1627 <td class="micon"><a class="exi" href="#expand"> </a></td>
1631 <a id="Roo.BoxComponent-method-onResize" name=".onResize"></a>
1632 <div class="fixedFont">
1633 <span class="attributes"></span><b class="itemname">onResize</b>
1635 (<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>)
1642 <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>
1648 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.
1655 <dl class="detailList">
1656 <dt class="heading">Parameters:</dt>
1659 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
1662 <dd>The box-adjusted width that was set</dd>
1665 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
1668 <dd>The box-adjusted height that was set</dd>
1671 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
1674 <dd>The width that was originally specified</dd>
1677 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
1680 <dd>The height that was originally specified</dd>
1698 <td class="msource">
1706 <tr class="method-row config-row-alt1 expandable">
1707 <td class="micon"><a class="exi" href="#expand"> </a></td>
1711 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1712 <div class="fixedFont">
1713 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1722 <div class="short">Removes all listeners for this object</div>
1728 Removes all listeners for this object
1749 <td class="msource">
1751 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1757 <tr class="method-row config-row-alt0 expandable">
1758 <td class="micon"><a class="exi" href="#expand"> </a></td>
1762 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1763 <div class="fixedFont">
1764 <span class="attributes"></span><b class="itemname">removeListener</b>
1766 (<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>)
1773 <div class="short">Removes a listener</div>
1786 <dl class="detailList">
1787 <dt class="heading">Parameters:</dt>
1790 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1793 <dd>The type of event to listen for</dd>
1796 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1799 <dd>The handler to remove</dd>
1802 <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>
1805 <dd>(optional) The scope (this object) for the handler</dd>
1823 <td class="msource">
1825 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1831 <tr class="method-row config-row-alt1 expandable">
1832 <td class="micon"><a class="exi" href="#expand"> </a></td>
1836 <a id="Roo.Component-method-render" name=".render"></a>
1837 <div class="fixedFont">
1838 <span class="attributes"></span><b class="itemname">render</b>
1840 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1847 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1853 If this is a lazy rendering component, render it to its container element.
1860 <dl class="detailList">
1861 <dt class="heading">Parameters:</dt>
1864 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1867 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1885 <td class="msource">
1887 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1893 <tr class="method-row config-row-alt0 expandable">
1894 <td class="micon"><a class="exi" href="#expand"> </a></td>
1898 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1899 <div class="fixedFont">
1900 <span class="attributes"></span><b class="itemname">setDisabled</b>
1902 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1909 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1915 Convenience function for setting disabled/enabled by boolean.
1922 <dl class="detailList">
1923 <dt class="heading">Parameters:</dt>
1926 <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>
1947 <td class="msource">
1949 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1955 <tr class="method-row config-row-alt1 expandable notInherited">
1956 <td class="micon"><a class="exi" href="#expand"> </a></td>
1960 <a id="Roo.BoxComponent-method-setPagePosition" name=".setPagePosition"></a>
1961 <div class="fixedFont">
1962 <span class="attributes"></span><b class="itemname">setPagePosition</b>
1964 (<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>)
1971 <div class="short">Sets the page XY position of the component.</div>
1977 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.
1984 <dl class="detailList">
1985 <dt class="heading">Parameters:</dt>
1988 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
1991 <dd>The new x position</dd>
1994 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
1997 <dd>The new y position</dd>
2015 <td class="msource">
2023 <tr class="method-row config-row-alt0 expandable notInherited">
2024 <td class="micon"><a class="exi" href="#expand"> </a></td>
2028 <a id="Roo.BoxComponent-method-setPosition" name=".setPosition"></a>
2029 <div class="fixedFont">
2030 <span class="attributes"></span><b class="itemname">setPosition</b>
2032 (<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>)
2039 <div class="short">Sets the left and top of the component.</div>
2045 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.
2052 <dl class="detailList">
2053 <dt class="heading">Parameters:</dt>
2056 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>left</b>
2059 <dd>The new left</dd>
2062 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>top</b>
2065 <dd>The new top</dd>
2083 <td class="msource">
2091 <tr class="method-row config-row-alt1 expandable notInherited">
2092 <td class="micon"><a class="exi" href="#expand"> </a></td>
2096 <a id="Roo.BoxComponent-method-setSize" name=".setSize"></a>
2097 <div class="fixedFont">
2098 <span class="attributes"></span><b class="itemname">setSize</b>
2100 (<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>)
2106 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2115 <div class="short">Sets the width and height of the component.</div>
2121 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}.
2128 <dl class="detailList">
2129 <dt class="heading">Parameters:</dt>
2132 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object</span> <b>width</b>
2135 <dd>The new width to set, or a size object in the format {width, height}</dd>
2138 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
2141 <dd>The new height to set (not required if a size object is passed as the first arg)</dd>
2149 <dl class="detailList">
2150 <dt class="heading">Returns:</dt>
2152 <dd><span class="fixedFont"><a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a></span> this</dd>
2166 <td class="msource">
2174 <tr class="method-row config-row-alt0 expandable">
2175 <td class="micon"><a class="exi" href="#expand"> </a></td>
2179 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
2180 <div class="fixedFont">
2181 <span class="attributes"></span><b class="itemname">setVisible</b>
2183 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
2189 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2198 <div class="short">Convenience function to hide or show this component by boolean.</div>
2204 Convenience function to hide or show this component by boolean.
2211 <dl class="detailList">
2212 <dt class="heading">Parameters:</dt>
2215 <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>
2218 <dd>True to show, false to hide</dd>
2226 <dl class="detailList">
2227 <dt class="heading">Returns:</dt>
2229 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2243 <td class="msource">
2245 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2251 <tr class="method-row config-row-alt1 expandable">
2252 <td class="micon"><a class="exi" href="#expand"> </a></td>
2256 <a id="Roo.Component-method-show" name=".show"></a>
2257 <div class="fixedFont">
2258 <span class="attributes"></span><b class="itemname">show</b>
2266 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2275 <div class="short">Show this component.</div>
2281 Show this component.
2292 <dl class="detailList">
2293 <dt class="heading">Returns:</dt>
2295 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2309 <td class="msource">
2311 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2317 <tr class="method-row config-row-alt0 expandable notInherited">
2318 <td class="micon"><a class="exi" href="#expand"> </a></td>
2322 <a id="Roo.BoxComponent-method-syncSize" name=".syncSize"></a>
2323 <div class="fixedFont">
2324 <span class="attributes"></span><b class="itemname">syncSize</b>
2333 <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
2339 Force the component's size to recalculate based on the underlying element's current height and width.
2360 <td class="msource">
2368 <tr class="method-row config-row-alt1 expandable">
2369 <td class="micon"><a class="exi" href="#expand"> </a></td>
2373 <a id="Roo.util.Observable-method-un" name=".un"></a>
2374 <div class="fixedFont">
2375 <span class="attributes"></span><b class="itemname">un</b>
2377 (<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>)
2384 <div class="short">Removes a listener (shorthand for removeListener)</div>
2390 Removes a listener (shorthand for removeListener)
2397 <dl class="detailList">
2398 <dt class="heading">Parameters:</dt>
2401 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2404 <dd>The type of event to listen for</dd>
2407 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2410 <dd>The handler to remove</dd>
2413 <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>
2416 <dd>(optional) The scope (this object) for the handler</dd>
2434 <td class="msource">
2436 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2442 <tr class="method-row config-row-alt0 expandable notInherited">
2443 <td class="micon"><a class="exi" href="#expand"> </a></td>
2447 <a id="Roo.BoxComponent-method-updateBox" name=".updateBox"></a>
2448 <div class="fixedFont">
2449 <span class="attributes"></span><b class="itemname">updateBox</b>
2451 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>box</i></B>)
2458 <div class="short">Sets the current box measurements of the component's underlying element.</div>
2464 Sets the current box measurements of the component's underlying element.
2471 <dl class="detailList">
2472 <dt class="heading">Parameters:</dt>
2475 <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>
2478 <dd>An object in the format {x, y, width, height}</dd>
2496 <td class="msource">
2507 <!-- ============================== events summary / details ======================== -->
2510 <a id="Roo.BoxComponent-events"></a>
2519 <table cellspacing="0" class="member-table">
2520 <caption>Events</caption>
2523 <th class="sig-header" colspan="2">Event</th>
2524 <th class="msource-header">Defined By</th>
2533 <tr class="method-row expandable config-row-alt0">
2534 <td class="micon"><a class="exi" href="#expand"> </a></td>
2537 <a id="Roo.Component-event-*beforedestroy"></a>
2539 <div class="fixedFont">
2540 <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>)
2546 <div class="short">Fires before the component is destroyed.
2552 Fires before the component is destroyed. Return false to stop the destroy.
2558 <dl class="detailList">
2559 <dt class="heading">Parameters:</dt>
2562 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2583 <td class="msource">
2584 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2588 <tr class="method-row expandable config-row-alt1">
2589 <td class="micon"><a class="exi" href="#expand"> </a></td>
2592 <a id="Roo.Component-event-*beforehide"></a>
2594 <div class="fixedFont">
2595 <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>)
2601 <div class="short">Fires before the component is hidden.
2607 Fires before the component is hidden. Return false to stop the hide.
2613 <dl class="detailList">
2614 <dt class="heading">Parameters:</dt>
2617 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2638 <td class="msource">
2639 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2643 <tr class="method-row expandable config-row-alt0">
2644 <td class="micon"><a class="exi" href="#expand"> </a></td>
2647 <a id="Roo.Component-event-*beforerender"></a>
2649 <div class="fixedFont">
2650 <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>)
2656 <div class="short">Fires before the component is rendered.
2662 Fires before the component is rendered. Return false to stop the render.
2668 <dl class="detailList">
2669 <dt class="heading">Parameters:</dt>
2672 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2693 <td class="msource">
2694 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2698 <tr class="method-row expandable config-row-alt1">
2699 <td class="micon"><a class="exi" href="#expand"> </a></td>
2702 <a id="Roo.Component-event-*beforeshow"></a>
2704 <div class="fixedFont">
2705 <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>)
2711 <div class="short">Fires before the component is shown.
2717 Fires before the component is shown. Return false to stop the show.
2723 <dl class="detailList">
2724 <dt class="heading">Parameters:</dt>
2727 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2748 <td class="msource">
2749 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2753 <tr class="method-row expandable config-row-alt0">
2754 <td class="micon"><a class="exi" href="#expand"> </a></td>
2757 <a id="Roo.Component-event-*destroy"></a>
2759 <div class="fixedFont">
2760 <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>)
2766 <div class="short">Fires after the component is destroyed.
2772 Fires after the component is destroyed.
2778 <dl class="detailList">
2779 <dt class="heading">Parameters:</dt>
2782 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2803 <td class="msource">
2804 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2808 <tr class="method-row expandable config-row-alt1">
2809 <td class="micon"><a class="exi" href="#expand"> </a></td>
2812 <a id="Roo.Component-event-*disable"></a>
2814 <div class="fixedFont">
2815 <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>)
2821 <div class="short">Fires after the component is disabled.
2827 Fires after the component is disabled.
2833 <dl class="detailList">
2834 <dt class="heading">Parameters:</dt>
2837 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2858 <td class="msource">
2859 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2863 <tr class="method-row expandable config-row-alt0">
2864 <td class="micon"><a class="exi" href="#expand"> </a></td>
2867 <a id="Roo.Component-event-*enable"></a>
2869 <div class="fixedFont">
2870 <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>)
2876 <div class="short">Fires after the component is enabled.
2882 Fires after the component is enabled.
2888 <dl class="detailList">
2889 <dt class="heading">Parameters:</dt>
2892 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2913 <td class="msource">
2914 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2918 <tr class="method-row expandable config-row-alt1">
2919 <td class="micon"><a class="exi" href="#expand"> </a></td>
2922 <a id="Roo.Component-event-*hide"></a>
2924 <div class="fixedFont">
2925 <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>)
2931 <div class="short">Fires after the component is hidden.
2937 Fires after the component is hidden.
2943 <dl class="detailList">
2944 <dt class="heading">Parameters:</dt>
2947 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2968 <td class="msource">
2969 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2973 <tr class="method-row expandable config-row-alt0 notInherited">
2974 <td class="micon"><a class="exi" href="#expand"> </a></td>
2977 <a id="Roo.BoxComponent-event-*move"></a>
2979 <div class="fixedFont">
2980 <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>)
2986 <div class="short">Fires after the component is moved.
2992 Fires after the component is moved.
2998 <dl class="detailList">
2999 <dt class="heading">Parameters:</dt>
3002 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3008 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
3011 <dd>The new x position</dd>
3014 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
3017 <dd>The new y position</dd>
3035 <td class="msource">
3040 <tr class="method-row expandable config-row-alt1">
3041 <td class="micon"><a class="exi" href="#expand"> </a></td>
3044 <a id="Roo.Component-event-*render"></a>
3046 <div class="fixedFont">
3047 <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>)
3053 <div class="short">Fires after the component is rendered.
3059 Fires after the component is rendered.
3065 <dl class="detailList">
3066 <dt class="heading">Parameters:</dt>
3069 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3090 <td class="msource">
3091 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3095 <tr class="method-row expandable config-row-alt0 notInherited">
3096 <td class="micon"><a class="exi" href="#expand"> </a></td>
3099 <a id="Roo.BoxComponent-event-*resize"></a>
3101 <div class="fixedFont">
3102 <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>)
3108 <div class="short">Fires after the component is resized.
3114 Fires after the component is resized.
3120 <dl class="detailList">
3121 <dt class="heading">Parameters:</dt>
3124 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3130 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
3133 <dd>The box-adjusted width that was set</dd>
3136 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
3139 <dd>The box-adjusted height that was set</dd>
3142 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
3145 <dd>The width that was originally specified</dd>
3148 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
3151 <dd>The height that was originally specified</dd>
3169 <td class="msource">
3174 <tr class="method-row expandable config-row-alt1">
3175 <td class="micon"><a class="exi" href="#expand"> </a></td>
3178 <a id="Roo.Component-event-*show"></a>
3180 <div class="fixedFont">
3181 <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>)
3187 <div class="short">Fires after the component is shown.
3193 Fires after the component is shown.
3199 <dl class="detailList">
3200 <dt class="heading">Parameters:</dt>
3203 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3224 <td class="msource">
3225 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3236 <!-- ============================== footer ================================= -->
3237 <div class="fineprint" style="clear:both">
3239 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Sat Jul 31 2010 18:30:03 GMT+0800 (HKT)
3241 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>