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.ContentPanel</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.ContentPanel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.ContentPanel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.ContentPanel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.ContentPanel-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.ContentPanel
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.ContentPanel
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_ContentPanel.js.html">Roo/ContentPanel.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">ContentPanel</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.GridPanel.html#constructor" roo:cls="Roo.GridPanel.html#constructor">Roo.GridPanel</a>, <a href="./Roo.NestedLayoutPanel.html#constructor" roo:cls="Roo.NestedLayoutPanel.html#constructor">Roo.NestedLayoutPanel</a>, <a href="./Roo.TreePanel.html#constructor" roo:cls="Roo.TreePanel.html#constructor">Roo.TreePanel</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 A basic ContentPanel element.
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.ContentPanel';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.ContentPanel.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.ContentPanel-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0 notInherited">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.ContentPanel-cfg-adjustments" name=".adjustments"></a>
139 <div class="fixedFont">
140 <b class="itemname">adjustments</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
146 <div class="short">Values to <b>add</b> to the width/height when doing a {<b>link</b> <b>fitToFrame</b>} (default is [0, 0])</div>
150 <div class="long">Values to <b>add</b> to the width/height when doing a {<b>link</b> <b>fitToFrame</b>} (default is [0, 0])</div>
164 <tr class="config-row expandable config-row-alt1 notInherited">
165 <td class="micon"><a class="exi" href="#expand"> </a></td>
168 <a id="Roo.ContentPanel-cfg-autoCreate" name=".autoCreate"></a>
169 <div class="fixedFont">
170 <b class="itemname">autoCreate</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/Object
176 <div class="short">True to auto generate the DOM element for this panel, or a {<b>link</b> Roo.DomHelper} config of the element to create</div>
180 <div class="long">True to auto generate the DOM element for this panel, or a {<b>link</b> Roo.DomHelper} config of the element to create</div>
194 <tr class="config-row expandable config-row-alt0 notInherited">
195 <td class="micon"><a class="exi" href="#expand"> </a></td>
198 <a id="Roo.ContentPanel-cfg-autoScroll" name=".autoScroll"></a>
199 <div class="fixedFont">
200 <b class="itemname">autoScroll</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
206 <div class="short">True to scroll overflow in this panel (use with {<b>link</b> <b>fitToFrame</b>})</div>
210 <div class="long">True to scroll overflow in this panel (use with {<b>link</b> <b>fitToFrame</b>})</div>
224 <tr class="config-row expandable config-row-alt1 notInherited">
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo.ContentPanel-cfg-background" name=".background"></a>
229 <div class="fixedFont">
230 <b class="itemname">background</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
236 <div class="short">True if the panel should not be activated when it is added (defaults to false)</div>
240 <div class="long">True if the panel should not be activated when it is added (defaults to false)</div>
254 <tr class="config-row expandable config-row-alt0 notInherited">
255 <td class="micon"><a class="exi" href="#expand"> </a></td>
258 <a id="Roo.ContentPanel-cfg-closable" name=".closable"></a>
259 <div class="fixedFont">
260 <b class="itemname">closable</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
266 <div class="short">True if the panel can be closed/removed</div>
270 <div class="long">True if the panel can be closed/removed</div>
284 <tr class="config-row expandable config-row-alt1 notInherited">
285 <td class="micon"><a class="exi" href="#expand"> </a></td>
288 <a id="Roo.ContentPanel-cfg-fitContainer" name=".fitContainer"></a>
289 <div class="fixedFont">
290 <b class="itemname">fitContainer</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
296 <div class="short">When using {<b>link</b> <b>fitToFrame</b>} and {<b>link</b> <b>resizeEl</b>}, you can also fit the parent container (defaults to false)</div>
300 <div class="long">When using {<b>link</b> <b>fitToFrame</b>} and {<b>link</b> <b>resizeEl</b>}, you can also fit the parent container (defaults to false)</div>
314 <tr class="config-row expandable config-row-alt0 notInherited">
315 <td class="micon"><a class="exi" href="#expand"> </a></td>
318 <a id="Roo.ContentPanel-cfg-fitToFrame" name=".fitToFrame"></a>
319 <div class="fixedFont">
320 <b class="itemname">fitToFrame</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
326 <div class="short">True for this panel to adjust its size to fit when the region resizes (defaults to false)</div>
330 <div class="long">True for this panel to adjust its size to fit when the region resizes (defaults to false)</div>
344 <tr class="config-row expandable config-row-alt1">
345 <td class="micon"><a class="exi" href="#expand"> </a></td>
348 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
349 <div class="fixedFont">
350 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
356 <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>
360 <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>
368 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
374 <tr class="config-row expandable config-row-alt0 notInherited">
375 <td class="micon"><a class="exi" href="#expand"> </a></td>
378 <a id="Roo.ContentPanel-cfg-loadOnce" name=".loadOnce"></a>
379 <div class="fixedFont">
380 <b class="itemname">loadOnce</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
386 <div class="short">When used with {<b>link</b> <b>url</b>}, calls {<b>link</b> <b>setUrl</b>} with this value</div>
390 <div class="long">When used with {<b>link</b> <b>url</b>}, calls {<b>link</b> <b>setUrl</b>} with this value</div>
404 <tr class="config-row expandable config-row-alt1 notInherited">
405 <td class="micon"><a class="exi" href="#expand"> </a></td>
408 <a id="Roo.ContentPanel-cfg-params" name=".params"></a>
409 <div class="fixedFont">
410 <b class="itemname">params</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object
416 <div class="short">When used with {<b>link</b> <b>url</b>}, calls {<b>link</b> <b>setUrl</b>} with this value</div>
420 <div class="long">When used with {<b>link</b> <b>url</b>}, calls {<b>link</b> <b>setUrl</b>} with this value</div>
434 <tr class="config-row expandable config-row-alt0 notInherited">
435 <td class="micon"><a class="exi" href="#expand"> </a></td>
438 <a id="Roo.ContentPanel-cfg-resizeEl" name=".resizeEl"></a>
439 <div class="fixedFont">
440 <b class="itemname">resizeEl</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element
446 <div class="short">An element to resize if {<b>link</b> <b>fitToFrame</b>} is true (instead of this panel's element)</div>
450 <div class="long">An element to resize if {<b>link</b> <b>fitToFrame</b>} is true (instead of this panel's element)</div>
464 <tr class="config-row expandable config-row-alt1 notInherited">
465 <td class="micon"><a class="exi" href="#expand"> </a></td>
468 <a id="Roo.ContentPanel-cfg-title" name=".title"></a>
469 <div class="fixedFont">
470 <b class="itemname">title</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
476 <div class="short">The title for this panel</div>
480 <div class="long">The title for this panel</div>
494 <tr class="config-row expandable config-row-alt0 notInherited">
495 <td class="micon"><a class="exi" href="#expand"> </a></td>
498 <a id="Roo.ContentPanel-cfg-toolbar" name=".toolbar"></a>
499 <div class="fixedFont">
500 <b class="itemname">toolbar</b> : Toolbar
506 <div class="short">A toolbar for this panel</div>
510 <div class="long">A toolbar for this panel</div>
524 <tr class="config-row expandable config-row-alt1 notInherited">
525 <td class="micon"><a class="exi" href="#expand"> </a></td>
528 <a id="Roo.ContentPanel-cfg-url" name=".url"></a>
529 <div class="fixedFont">
530 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
536 <div class="short">Calls {<b>link</b> <b>setUrl</b>} with this value</div>
540 <div class="long">Calls {<b>link</b> <b>setUrl</b>} with this value</div>
564 <!-- ============================== public properties ==================== -->
568 <a id="Roo.ContentPanel-props"></a>
574 <table cellspacing="0" class="member-table">
575 <caption class="Empty">Public Properties - Has None</caption>
581 <!-- ============================== methods summary / details ======================== -->
584 <a id="Roo.ContentPanel-methods"></a>
585 <!-- constructor?? -->
592 <!-- then dynamics first -->
599 <table cellspacing="0" class="member-table">
600 <caption>Public Methods</caption>
602 <th class="sig-header" colspan="2">Method</th>
603 <th class="msource-header">Defined By</th>
613 <tr class="method-row config-row-alt0 expandable notInherited">
614 <td class="micon"><a class="exi" href="#expand"> </a></td>
618 <a id="Roo-method-ContentPanel" name=".ContentPanel"></a>
619 <div class="fixedFont">
620 <span class="attributes">new <B>Roo.</B></span><b class="itemname">ContentPanel</b>
622 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>config</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>content</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>region</i></B>)
630 <div class="short">Create a new Roo.ContentPanel</div>
637 Create a new Roo.ContentPanel
640 <dl class="detailList">
641 <dt class="heading">Parameters:</dt>
644 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>el</b>
647 <dd>The container element for this panel</dd>
650 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>config</b>
653 <dd>A string to set only the title or a config object</dd>
656 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>content</b>
659 <dd>(optional) Set the HTML content for this panel</dd>
662 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>region</b>
665 <dd>(optional) Used by xtype constructors to add to regions. (values center,east,west,south,north)</dd>
689 <tr class="method-row config-row-alt1 expandable">
690 <td class="micon"><a class="exi" href="#expand"> </a></td>
694 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
695 <div class="fixedFont">
696 <span class="attributes"></span><b class="itemname">addEvents</b>
698 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
705 <div class="short">Used to define events on this Observable</div>
711 Used to define events on this Observable
718 <dl class="detailList">
719 <dt class="heading">Parameters:</dt>
722 <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>
725 <dd>The object with the events defined</dd>
745 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
751 <tr class="method-row config-row-alt0 expandable">
752 <td class="micon"><a class="exi" href="#expand"> </a></td>
756 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
757 <div class="fixedFont">
758 <span class="attributes"></span><b class="itemname">addListener</b>
760 (<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>)
767 <div class="short">Appends an event handler to this component</div>
773 Appends an event handler to this component
780 <dl class="detailList">
781 <dt class="heading">Parameters:</dt>
784 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
787 <dd>The type of event to listen for</dd>
790 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
793 <dd>The method the event invokes</dd>
796 <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>
799 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
802 <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>
805 <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>
825 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
831 <tr class="method-row config-row-alt1 expandable notInherited">
832 <td class="micon"><a class="exi" href="#expand"> </a></td>
836 <a id="Roo.ContentPanel-method-addxtype" name=".addxtype"></a>
837 <div class="fixedFont">
838 <span class="attributes"></span><b class="itemname">addxtype</b>
840 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
847 <div class="short">Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.</div>
853 Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.<br/><pre><code><br/><br/>layout.addxtype({<br/> xtype : 'Form',<br/> items: [ .... ]<br/> }<br/>);<br/><br/></code></pre>
860 <dl class="detailList">
861 <dt class="heading">Parameters:</dt>
864 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>cfg</b>
867 <dd>Xtype definition of item to add.</dd>
893 <tr class="method-row config-row-alt0 expandable notInherited">
894 <td class="micon"><a class="exi" href="#expand"> </a></td>
898 <a id="Roo.ContentPanel-method-destroy" name=".destroy"></a>
899 <div class="fixedFont">
900 <span class="attributes"></span><b class="itemname">destroy</b>
909 <div class="short">Destroys this panel</div>
944 <tr class="method-row config-row-alt1 expandable">
945 <td class="micon"><a class="exi" href="#expand"> </a></td>
949 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
950 <div class="fixedFont">
951 <span class="attributes"></span><b class="itemname">fireEvent</b>
953 (<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>)
959 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
968 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
974 Fires the specified event with the passed parameters (minus the event name).
981 <dl class="detailList">
982 <dt class="heading">Parameters:</dt>
985 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
991 <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>
994 <dd>Variable number of parameters are passed to handlers</dd>
1002 <dl class="detailList">
1003 <dt class="heading">Returns:</dt>
1005 <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>
1019 <td class="msource">
1021 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1027 <tr class="method-row config-row-alt0 expandable notInherited">
1028 <td class="micon"><a class="exi" href="#expand"> </a></td>
1032 <a id="Roo.ContentPanel-method-getEl" name=".getEl"></a>
1033 <div class="fixedFont">
1034 <span class="attributes"></span><b class="itemname">getEl</b>
1042 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1051 <div class="short">Returns this panel's element - used by regiosn to add.</div>
1057 Returns this panel's element - used by regiosn to add.
1068 <dl class="detailList">
1069 <dt class="heading">Returns:</dt>
1071 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> </dd>
1085 <td class="msource">
1093 <tr class="method-row config-row-alt1 expandable notInherited">
1094 <td class="micon"><a class="exi" href="#expand"> </a></td>
1098 <a id="Roo.ContentPanel-method-getId" name=".getId"></a>
1099 <div class="fixedFont">
1100 <span class="attributes"></span><b class="itemname">getId</b>
1108 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1117 <div class="short">Returns this panel's id</div>
1123 Returns this panel's id
1134 <dl class="detailList">
1135 <dt class="heading">Returns:</dt>
1137 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1151 <td class="msource">
1159 <tr class="method-row config-row-alt0 expandable notInherited">
1160 <td class="micon"><a class="exi" href="#expand"> </a></td>
1164 <a id="Roo.ContentPanel-method-getTitle" name=".getTitle"></a>
1165 <div class="fixedFont">
1166 <span class="attributes"></span><b class="itemname">getTitle</b>
1174 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1183 <div class="short">Returns this panel's title</div>
1189 Returns this panel's title
1200 <dl class="detailList">
1201 <dt class="heading">Returns:</dt>
1203 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1217 <td class="msource">
1225 <tr class="method-row config-row-alt1 expandable notInherited">
1226 <td class="micon"><a class="exi" href="#expand"> </a></td>
1230 <a id="Roo.ContentPanel-method-getToolbar" name=".getToolbar"></a>
1231 <div class="fixedFont">
1232 <span class="attributes"></span><b class="itemname">getToolbar</b>
1240 <a href="./Roo.Toolbar.html#constructor" roo:cls="Roo.Toolbar.html#constructor">Roo.Toolbar</a>
1249 <div class="short">Returns the toolbar for this Panel if one was configured.</div>
1255 Returns the toolbar for this Panel if one was configured.
1266 <dl class="detailList">
1267 <dt class="heading">Returns:</dt>
1269 <dd><span class="fixedFont"><a href="./Roo.Toolbar.html#constructor" roo:cls="Roo.Toolbar.html#constructor">Roo.Toolbar</a></span> </dd>
1283 <td class="msource">
1291 <tr class="method-row config-row-alt0 expandable notInherited">
1292 <td class="micon"><a class="exi" href="#expand"> </a></td>
1296 <a id="Roo.ContentPanel-method-getUpdateManager" name=".getUpdateManager"></a>
1297 <div class="fixedFont">
1298 <span class="attributes"></span><b class="itemname">getUpdateManager</b>
1306 <a href="./Roo.UpdateManager.html#constructor" roo:cls="Roo.UpdateManager.html#constructor">Roo.UpdateManager</a>
1315 <div class="short">Get the {<b>link</b> Roo.UpdateManager} for this panel.</div>
1321 Get the {<b>link</b> Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.
1332 <dl class="detailList">
1333 <dt class="heading">Returns:</dt>
1335 <dd><span class="fixedFont"><a href="./Roo.UpdateManager.html#constructor" roo:cls="Roo.UpdateManager.html#constructor">Roo.UpdateManager</a></span> The UpdateManager</dd>
1349 <td class="msource">
1357 <tr class="method-row config-row-alt1 expandable">
1358 <td class="micon"><a class="exi" href="#expand"> </a></td>
1362 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1363 <div class="fixedFont">
1364 <span class="attributes"></span><b class="itemname">hasListener</b>
1366 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1372 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1381 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1387 Checks to see if this object has any listeners for a specified event
1394 <dl class="detailList">
1395 <dt class="heading">Parameters:</dt>
1398 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1401 <dd>The name of the event to check for</dd>
1409 <dl class="detailList">
1410 <dt class="heading">Returns:</dt>
1412 <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>
1426 <td class="msource">
1428 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1434 <tr class="method-row config-row-alt0 expandable notInherited">
1435 <td class="micon"><a class="exi" href="#expand"> </a></td>
1439 <a id="Roo.ContentPanel-method-isClosable" name=".isClosable"></a>
1440 <div class="fixedFont">
1441 <span class="attributes"></span><b class="itemname">isClosable</b>
1449 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1458 <div class="short">Returns true is this panel was configured to be closable</div>
1464 Returns true is this panel was configured to be closable
1475 <dl class="detailList">
1476 <dt class="heading">Returns:</dt>
1478 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
1492 <td class="msource">
1500 <tr class="method-row config-row-alt1 expandable notInherited">
1501 <td class="micon"><a class="exi" href="#expand"> </a></td>
1505 <a id="Roo.ContentPanel-method-load" name=".load"></a>
1506 <div class="fixedFont">
1507 <span class="attributes"></span><b class="itemname">load</b>
1509 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/String/Function <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>discardUrl</i></B>)
1515 <a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a>
1524 <div class="short">Loads this content panel immediately with content from XHR.</div>
1530 Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {<b>link</b> <b>setUrl</b>}.
1537 <dl class="detailList">
1538 <dt class="heading">Parameters:</dt>
1541 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/String/Function</span> <b>url</b>
1544 <dd>The url for this request or a function to call to get the url or a config object containing any of the following options:<br/><pre><code><br/>panel.load({<br/> url: "your-url.php",<br/> params: {param1: "foo", param2: "bar"}, // or a URL encoded string<br/> callback: yourFunction,<br/> scope: yourObject, //(optional scope)<br/> discardUrl: false,<br/> nocache: false,<br/> text: "Loading...",<br/> timeout: 30,<br/> scripts: false<br/>});<br/></code></pre><br/>The only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i><br/>are shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.</dd>
1547 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
1550 <dd>(optional) The parameters to pass as either a URL encoded string "param1=1&param2=2" or an object {param1: 1, param2: 2}</dd>
1553 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
1556 <dd>(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)</dd>
1559 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>discardUrl</b>
1562 <dd>(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.</dd>
1570 <dl class="detailList">
1571 <dt class="heading">Returns:</dt>
1573 <dd><span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> this</dd>
1587 <td class="msource">
1595 <tr class="method-row config-row-alt0 expandable">
1596 <td class="micon"><a class="exi" href="#expand"> </a></td>
1600 <a id="Roo.util.Observable-method-on" name=".on"></a>
1601 <div class="fixedFont">
1602 <span class="attributes"></span><b class="itemname">on</b>
1604 (<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>)
1611 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1617 Appends an event handler to this element (shorthand for addListener)
1624 <dl class="detailList">
1625 <dt class="heading">Parameters:</dt>
1628 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1631 <dd>The type of event to listen for</dd>
1634 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1637 <dd>The method the event invokes</dd>
1640 <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>
1643 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1646 <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>
1667 <td class="msource">
1669 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1675 <tr class="method-row config-row-alt1 expandable">
1676 <td class="micon"><a class="exi" href="#expand"> </a></td>
1680 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1681 <div class="fixedFont">
1682 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1691 <div class="short">Removes all listeners for this object</div>
1697 Removes all listeners for this object
1718 <td class="msource">
1720 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1726 <tr class="method-row config-row-alt0 expandable notInherited">
1727 <td class="micon"><a class="exi" href="#expand"> </a></td>
1731 <a id="Roo.ContentPanel-method-refresh" name=".refresh"></a>
1732 <div class="fixedFont">
1733 <span class="attributes"></span><b class="itemname">refresh</b>
1742 <div class="short">Force a content refresh from the URL specified in the {<b>link</b> <b>setUrl</b>} method.</div>
1748 Force a content refresh from the URL specified in the {<b>link</b> <b>setUrl</b>} method.<br/> Will fail silently if the {<b>link</b> <b>setUrl</b>} method has not been called.<br/> This does not activate the panel, just updates its content.
1769 <td class="msource">
1777 <tr class="method-row config-row-alt1 expandable">
1778 <td class="micon"><a class="exi" href="#expand"> </a></td>
1782 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1783 <div class="fixedFont">
1784 <span class="attributes"></span><b class="itemname">removeListener</b>
1786 (<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>)
1793 <div class="short">Removes a listener</div>
1806 <dl class="detailList">
1807 <dt class="heading">Parameters:</dt>
1810 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1813 <dd>The type of event to listen for</dd>
1816 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1819 <dd>The handler to remove</dd>
1822 <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>
1825 <dd>(optional) The scope (this object) for the handler</dd>
1843 <td class="msource">
1845 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1851 <tr class="method-row config-row-alt0 expandable notInherited">
1852 <td class="micon"><a class="exi" href="#expand"> </a></td>
1856 <a id="Roo.ContentPanel-method-setContent" name=".setContent"></a>
1857 <div class="fixedFont">
1858 <span class="attributes"></span><b class="itemname">setContent</b>
1860 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>content</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>loadScripts</i></B>)
1867 <div class="short">Updates this panel's element</div>
1873 Updates this panel's element
1880 <dl class="detailList">
1881 <dt class="heading">Parameters:</dt>
1884 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>content</b>
1887 <dd>The new content</dd>
1890 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>loadScripts</b>
1893 <dd>(optional) true to look for and process scripts</dd>
1911 <td class="msource">
1919 <tr class="method-row config-row-alt1 expandable notInherited">
1920 <td class="micon"><a class="exi" href="#expand"> </a></td>
1924 <a id="Roo.ContentPanel-method-setTitle" name=".setTitle"></a>
1925 <div class="fixedFont">
1926 <span class="attributes"></span><b class="itemname">setTitle</b>
1928 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>title</i></B>)
1935 <div class="short">Set this panel's title</div>
1941 Set this panel's title
1948 <dl class="detailList">
1949 <dt class="heading">Parameters:</dt>
1952 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>title</b>
1973 <td class="msource">
1981 <tr class="method-row config-row-alt0 expandable notInherited">
1982 <td class="micon"><a class="exi" href="#expand"> </a></td>
1986 <a id="Roo.ContentPanel-method-setUrl" name=".setUrl"></a>
1987 <div class="fixedFont">
1988 <span class="attributes"></span><b class="itemname">setUrl</b>
1990 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>loadOnce</i></B>)
1996 <a href="./Roo.UpdateManager.html#constructor" roo:cls="Roo.UpdateManager.html#constructor">Roo.UpdateManager</a>
2005 <div class="short">Set a URL to be used to load the content for this panel.</div>
2011 Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.
2018 <dl class="detailList">
2019 <dt class="heading">Parameters:</dt>
2022 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span> <b>url</b>
2025 <dd>The URL to load the content from or a function to call to get the URL</dd>
2028 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
2031 <dd>(optional) The string params for the update call or an object of the params. See {<b>link</b> Roo.UpdateManager<b>update</b>} for more details. (Defaults to null)</dd>
2034 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>loadOnce</b>
2037 <dd>(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)</dd>
2045 <dl class="detailList">
2046 <dt class="heading">Returns:</dt>
2048 <dd><span class="fixedFont"><a href="./Roo.UpdateManager.html#constructor" roo:cls="Roo.UpdateManager.html#constructor">Roo.UpdateManager</a></span> The UpdateManager</dd>
2062 <td class="msource">
2070 <tr class="method-row config-row-alt1 expandable">
2071 <td class="micon"><a class="exi" href="#expand"> </a></td>
2075 <a id="Roo.util.Observable-method-un" name=".un"></a>
2076 <div class="fixedFont">
2077 <span class="attributes"></span><b class="itemname">un</b>
2079 (<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>)
2086 <div class="short">Removes a listener (shorthand for removeListener)</div>
2092 Removes a listener (shorthand for removeListener)
2099 <dl class="detailList">
2100 <dt class="heading">Parameters:</dt>
2103 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2106 <dd>The type of event to listen for</dd>
2109 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2112 <dd>The handler to remove</dd>
2115 <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>
2118 <dd>(optional) The scope (this object) for the handler</dd>
2136 <td class="msource">
2138 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2147 <!-- ============================== events summary / details ======================== -->
2150 <a id="Roo.ContentPanel-events"></a>
2159 <table cellspacing="0" class="member-table">
2160 <caption>Events</caption>
2163 <th class="sig-header" colspan="2">Event</th>
2164 <th class="msource-header">Defined By</th>
2173 <tr class="method-row expandable config-row-alt0 notInherited">
2174 <td class="micon"><a class="exi" href="#expand"> </a></td>
2177 <a id="Roo.ContentPanel-event-*activate"></a>
2179 <div class="fixedFont">
2180 <b class="itemname">activate</b> (<a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>this</i></B>)
2186 <div class="short">Fires when this panel is activated.
2192 Fires when this panel is activated.
2198 <dl class="detailList">
2199 <dt class="heading">Parameters:</dt>
2202 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>this</b>
2223 <td class="msource">
2228 <tr class="method-row expandable config-row-alt1 notInherited">
2229 <td class="micon"><a class="exi" href="#expand"> </a></td>
2232 <a id="Roo.ContentPanel-event-*deactivate"></a>
2234 <div class="fixedFont">
2235 <b class="itemname">deactivate</b> (<a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>this</i></B>)
2241 <div class="short">Fires when this panel is activated.
2247 Fires when this panel is activated.
2253 <dl class="detailList">
2254 <dt class="heading">Parameters:</dt>
2257 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>this</b>
2278 <td class="msource">
2283 <tr class="method-row expandable config-row-alt0 notInherited">
2284 <td class="micon"><a class="exi" href="#expand"> </a></td>
2287 <a id="Roo.ContentPanel-event-*resize"></a>
2289 <div class="fixedFont">
2290 <b class="itemname">resize</b> (<a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>)
2296 <div class="short">Fires when this panel is resized if fitToFrame is true.
2302 Fires when this panel is resized if fitToFrame is true.
2308 <dl class="detailList">
2309 <dt class="heading">Parameters:</dt>
2312 <span class="fixedFont"><a href="./Roo.ContentPanel.html#constructor" roo:cls="Roo.ContentPanel.html#constructor">Roo.ContentPanel</a></span> <b>this</b>
2318 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
2321 <dd>The width after any component adjustments</dd>
2324 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
2327 <dd>The height after any component adjustments</dd>
2345 <td class="msource">
2357 <!-- ============================== footer ================================= -->
2358 <div class="fineprint" style="clear:both">
2360 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Jul 26 2010 16:07:49 GMT+0800 (HKT)
2362 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>