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.tree.TreeEditor</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.tree.TreeEditor-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.tree.TreeEditor-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.tree.TreeEditor-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.tree.TreeEditor-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
49 <img src="../../images/default/s.gif" height="1" width="60"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.tree.TreeEditor
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
59 Class Roo.tree.TreeEditor
62 <table cellspacing="0" class="class-summary-table">
64 <tr><td class="label">Package:</td><td class="hd-info">Roo.tree</td></tr>
66 <tr><td class="label">Defined In:</td><td class="hd-info">
68 <a href="./src/Roo_tree_TreeEditor.js.html">Roo/tree/TreeEditor.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">TreeEditor</td></tr>
76 <tr><td class="label">Extends:</td><td class="hd-info">
77 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
85 <!-- ============================== class summary ========================== -->
86 <div class="description">
87 Provides editor functionality for inline tree node editing. Any valid {<b>link</b> Roo.form.Field} can be used<br/>as the editor field.
91 <!-- ============================== Class comment block... ========================== -->
93 <div class="comments">
94 <b>Class Comments / Notes</B> =>
95 <u onclick="parent.CommentDialog.showCommentId = 'Roo.tree.TreeEditor';">[Add Your comment/notes about this class]</u>
97 <iframe frameborder="0" id="comments-Roo.tree" style="border: none;width:100%;"
98 src="/blog.php/GtkDjsComments/Roo.tree.TreeEditor.html"></iframe>
103 <!-- ============================== config options ========================== -->
108 <div class="hr"></div>
109 <a id="Roo.tree.TreeEditor-configs"></a>
115 <table cellspacing="0" class="member-table">
116 <caption>Config Options (Usually are also Properties)</caption>
120 <th class="sig-header" colspan="2">Options</th>
122 <th class="msource-header">Defined By</th>
129 <tr class="config-row expandable config-row-alt0">
130 <td class="micon"><a class="exi" href="#expand"> </a></td>
133 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
134 <div class="fixedFont">
135 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
141 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
146 which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'
156 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
162 <tr class="config-row expandable config-row-alt1 notInherited">
163 <td class="micon"><a class="exi" href="#expand"> </a></td>
166 <a id="Roo.tree.TreeEditor-cfg-alignment" name=".alignment"></a>
167 <div class="fixedFont">
168 <b class="itemname">alignment</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
174 <div class="short">The position to align to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to "l-l").</div>
179 The position to align to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to "l-l").
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-allowDomMove" name=".allowDomMove"></a>
200 <div class="fixedFont">
201 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
207 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
212 Whether the component can move the Dom node when rendering (defaults to true).
222 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
228 <tr class="config-row expandable config-row-alt1">
229 <td class="micon"><a class="exi" href="#expand"> </a></td>
232 <a id="Roo.Editor-cfg-autosize" name=".autosize"></a>
233 <div class="fixedFont">
234 <b class="itemname">autosize</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String
240 <div class="short">True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,<br/>or "height" to adopt the height only (defaults to false)</div>
245 True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only,<br/>or "height" to adopt the height only (defaults to false)
255 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
261 <tr class="config-row expandable config-row-alt0">
262 <td class="micon"><a class="exi" href="#expand"> </a></td>
265 <a id="Roo.Editor-cfg-cancelOnEsc" name=".cancelOnEsc"></a>
266 <div class="fixedFont">
267 <b class="itemname">cancelOnEsc</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
273 <div class="short">True to cancel the edit when the escape key is pressed (defaults to false)</div>
278 True to cancel the edit when the escape key is pressed (defaults to false)
288 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
294 <tr class="config-row expandable config-row-alt1 notInherited">
295 <td class="micon"><a class="exi" href="#expand"> </a></td>
298 <a id="Roo.tree.TreeEditor-cfg-cls" name=".cls"></a>
299 <div class="fixedFont">
300 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
306 <div class="short">CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor")</div>
311 CSS class to apply to the editor (defaults to "x-small-editor x-tree-editor")
327 <tr class="config-row expandable config-row-alt0">
328 <td class="micon"><a class="exi" href="#expand"> </a></td>
331 <a id="Roo.Editor-cfg-completeOnEnter" name=".completeOnEnter"></a>
332 <div class="fixedFont">
333 <b class="itemname">completeOnEnter</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
339 <div class="short">True to complete the edit when the enter key is pressed (defaults to false)</div>
344 True to complete the edit when the enter key is pressed (defaults to false)
354 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
360 <tr class="config-row expandable config-row-alt1">
361 <td class="micon"><a class="exi" href="#expand"> </a></td>
364 <a id="Roo.Editor-cfg-constrain" name=".constrain"></a>
365 <div class="fixedFont">
366 <b class="itemname">constrain</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
372 <div class="short">True to constrain the editor to the viewport</div>
377 True to constrain the editor to the viewport
387 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
393 <tr class="config-row expandable config-row-alt0">
394 <td class="micon"><a class="exi" href="#expand"> </a></td>
397 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
398 <div class="fixedFont">
399 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
405 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
410 CSS class added to the component when it is disabled (defaults to "x-item-disabled").
420 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
426 <tr class="config-row expandable config-row-alt1 notInherited">
427 <td class="micon"><a class="exi" href="#expand"> </a></td>
430 <a id="Roo.tree.TreeEditor-cfg-field" name=".field"></a>
431 <div class="fixedFont">
432 <b class="itemname">field</b> : <a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>|<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
438 <div class="short">The field configuration</div>
443 The field configuration
459 <tr class="config-row expandable config-row-alt0 notInherited">
460 <td class="micon"><a class="exi" href="#expand"> </a></td>
463 <a id="Roo.tree.TreeEditor-cfg-hideEl" name=".hideEl"></a>
464 <div class="fixedFont">
465 <b class="itemname">hideEl</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
471 <div class="short">True to hide the bound element while the editor is displayed (defaults to false)</div>
476 True to hide the bound element while the editor is displayed (defaults to false)
492 <tr class="config-row expandable config-row-alt1">
493 <td class="micon"><a class="exi" href="#expand"> </a></td>
496 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
497 <div class="fixedFont">
498 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
504 <div class="short">How this component should hidden.</div>
509 How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".
510 <BR/>Possible Values: display, visibility
519 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
525 <tr class="config-row expandable config-row-alt0">
526 <td class="micon"><a class="exi" href="#expand"> </a></td>
529 <a id="Roo.Editor-cfg-ignoreNoChange" name=".ignoreNoChange"></a>
530 <div class="fixedFont">
531 <b class="itemname">ignoreNoChange</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
537 <div class="short">True to skip the the edit completion process (no save, no events fired) if the user completes an edit and<br/>the value has not changed (defaults to false).</div>
542 True to skip the the edit completion process (no save, no events fired) if the user completes an edit and<br/>the value has not changed (defaults to false). Applies only to string values - edits for other data types<br/>will never be ignored.
552 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
558 <tr class="config-row expandable config-row-alt1">
559 <td class="micon"><a class="exi" href="#expand"> </a></td>
562 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
563 <div class="fixedFont">
564 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
570 <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>
575 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>
585 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
591 <tr class="config-row expandable config-row-alt0 notInherited">
592 <td class="micon"><a class="exi" href="#expand"> </a></td>
595 <a id="Roo.tree.TreeEditor-cfg-maxWidth" name=".maxWidth"></a>
596 <div class="fixedFont">
597 <b class="itemname">maxWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
603 <div class="short">The maximum width in pixels of the editor field (defaults to 250).</div>
608 The maximum width in pixels of the editor field (defaults to 250). Note that if the maxWidth would exceed<br/>the containing tree element's size, it will be automatically limited for you to the container width, taking<br/>scroll and client offsets into account prior to each edit.
624 <tr class="config-row expandable config-row-alt1">
625 <td class="micon"><a class="exi" href="#expand"> </a></td>
628 <a id="Roo.Editor-cfg-revertInvalid" name=".revertInvalid"></a>
629 <div class="fixedFont">
630 <b class="itemname">revertInvalid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
636 <div class="short">True to automatically revert the field value and cancel the edit when the user completes an edit and the field<br/>validation fails (defaults to true)</div>
641 True to automatically revert the field value and cancel the edit when the user completes an edit and the field<br/>validation fails (defaults to true)
651 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
657 <tr class="config-row expandable config-row-alt0">
658 <td class="micon"><a class="exi" href="#expand"> </a></td>
661 <a id="Roo.Editor-cfg-shadow" name=".shadow"></a>
662 <div class="fixedFont">
663 <b class="itemname">shadow</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String
669 <div class="short">"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"<br/>for bottom-right shadow (defaults to "frame")</div>
674 "sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"<br/>for bottom-right shadow (defaults to "frame")
684 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
690 <tr class="config-row expandable config-row-alt1 notInherited">
691 <td class="micon"><a class="exi" href="#expand"> </a></td>
694 <a id="Roo.tree.TreeEditor-cfg-shim" name=".shim"></a>
695 <div class="fixedFont">
696 <b class="itemname">shim</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
702 <div class="short">True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)</div>
707 True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)
723 <tr class="config-row expandable config-row-alt0 notInherited">
724 <td class="micon"><a class="exi" href="#expand"> </a></td>
727 <a id="Roo.tree.TreeEditor-cfg-tree" name=".tree"></a>
728 <div class="fixedFont">
729 <b class="itemname">tree</b> : <a href="./Roo.tree.TreePanel.html#constructor" roo:cls="Roo.tree.TreePanel.html#constructor">Roo.tree.TreePanel</a>
735 <div class="short">The tree to bind to.</div>
756 <tr class="config-row expandable config-row-alt1">
757 <td class="micon"><a class="exi" href="#expand"> </a></td>
760 <a id="Roo.Editor-cfg-updateEl" name=".updateEl"></a>
761 <div class="fixedFont">
762 <b class="itemname">updateEl</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
768 <div class="short">True to update the innerHTML of the bound element when the update completes (defaults to false)</div>
773 True to update the innerHTML of the bound element when the update completes (defaults to false)
783 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
789 <tr class="config-row expandable config-row-alt0">
790 <td class="micon"><a class="exi" href="#expand"> </a></td>
793 <a id="Roo.Editor-cfg-value" name=".value"></a>
794 <div class="fixedFont">
795 <b class="itemname">value</b> : Mixed
801 <div class="short">The data value of the underlying field (defaults to "")</div>
806 The data value of the underlying field (defaults to "")
816 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
832 <!-- ============================== public properties ==================== -->
836 <a id="Roo.tree.TreeEditor-props"></a>
842 <table cellspacing="0" class="member-table">
843 <caption class="Empty">Public Properties - Has None</caption>
849 <!-- ============================== methods summary / details ======================== -->
852 <a id="Roo.tree.TreeEditor-methods"></a>
853 <!-- constructor?? -->
860 <!-- then dynamics first -->
867 <table cellspacing="0" class="member-table">
868 <caption>Public Methods</caption>
870 <th class="sig-header" colspan="2">Method</th>
871 <th class="msource-header">Defined By</th>
881 <tr class="method-row config-row-alt0 expandable notInherited">
882 <td class="micon"><a class="exi" href="#expand"> </a></td>
886 <a id="Roo.tree-method-TreeEditor" name=".TreeEditor"></a>
887 <div class="fixedFont">
888 <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">TreeEditor</b>
890 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>oldconfig</i></B>)
898 <div class="short">Create a new Roo.tree.TreeEditor</div>
905 Create a new Roo.tree.TreeEditor
908 <dl class="detailList">
909 <dt class="heading">Parameters:</dt>
912 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
915 <dd>(used to be the tree panel.)</dd>
918 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>oldconfig</b>
921 <dd>DEPRECIATED Either a prebuilt {<b>link</b> Roo.form.Field} instance or a Field config object</dd>
945 <tr class="method-row config-row-alt1 expandable">
946 <td class="micon"><a class="exi" href="#expand"> </a></td>
950 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
951 <div class="fixedFont">
952 <span class="attributes"></span><b class="itemname">addEvents</b>
954 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
961 <div class="short">Used to define events on this Observable</div>
967 Used to define events on this Observable
974 <dl class="detailList">
975 <dt class="heading">Parameters:</dt>
978 <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>
981 <dd>The object with the events defined</dd>
1001 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1007 <tr class="method-row config-row-alt0 expandable">
1008 <td class="micon"><a class="exi" href="#expand"> </a></td>
1012 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1013 <div class="fixedFont">
1014 <span class="attributes"></span><b class="itemname">addListener</b>
1016 (<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>)
1023 <div class="short">Appends an event handler to this component</div>
1029 Appends an event handler to this component
1036 <dl class="detailList">
1037 <dt class="heading">Parameters:</dt>
1040 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1043 <dd>The type of event to listen for</dd>
1046 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1049 <dd>The method the event invokes</dd>
1052 <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>
1055 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1058 <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>
1061 <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>
1079 <td class="msource">
1081 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1087 <tr class="method-row config-row-alt1 expandable">
1088 <td class="micon"><a class="exi" href="#expand"> </a></td>
1092 <a id="Roo.Editor-method-cancelEdit" name=".cancelEdit"></a>
1093 <div class="fixedFont">
1094 <span class="attributes"></span><b class="itemname">cancelEdit</b>
1096 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>remainVisible</i></B>)
1103 <div class="short">Cancels the editing process and hides the editor without persisting any changes.</div>
1109 Cancels the editing process and hides the editor without persisting any changes. The field value will be<br/>reverted to the original starting value.
1116 <dl class="detailList">
1117 <dt class="heading">Parameters:</dt>
1120 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>remainVisible</b>
1123 <dd>Override the default behavior and keep the editor visible after<br/>cancel (defaults to false)</dd>
1141 <td class="msource">
1143 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
1149 <tr class="method-row config-row-alt0 expandable">
1150 <td class="micon"><a class="exi" href="#expand"> </a></td>
1154 <a id="Roo.Editor-method-completeEdit" name=".completeEdit"></a>
1155 <div class="fixedFont">
1156 <span class="attributes"></span><b class="itemname">completeEdit</b>
1158 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>remainVisible</i></B>)
1165 <div class="short">Ends the editing process, persists the changed value to the underlying field, and hides the editor.</div>
1171 Ends the editing process, persists the changed value to the underlying field, and hides the editor.
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>remainVisible</b>
1185 <dd>Override the default behavior and keep the editor visible after edit (defaults to false)</dd>
1203 <td class="msource">
1205 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
1211 <tr class="method-row config-row-alt1 expandable">
1212 <td class="micon"><a class="exi" href="#expand"> </a></td>
1216 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1217 <div class="fixedFont">
1218 <span class="attributes"></span><b class="itemname">destroy</b>
1227 <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>
1233 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}.
1254 <td class="msource">
1256 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1262 <tr class="method-row config-row-alt0 expandable">
1263 <td class="micon"><a class="exi" href="#expand"> </a></td>
1267 <a id="Roo.Component-method-disable" name=".disable"></a>
1268 <div class="fixedFont">
1269 <span class="attributes"></span><b class="itemname">disable</b>
1277 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1286 <div class="short">Disable this component.</div>
1292 Disable this component.
1303 <dl class="detailList">
1304 <dt class="heading">Returns:</dt>
1306 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1320 <td class="msource">
1322 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1328 <tr class="method-row config-row-alt1 expandable">
1329 <td class="micon"><a class="exi" href="#expand"> </a></td>
1333 <a id="Roo.Component-method-enable" name=".enable"></a>
1334 <div class="fixedFont">
1335 <span class="attributes"></span><b class="itemname">enable</b>
1343 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1352 <div class="short">Enable this component.</div>
1358 Enable this component.
1369 <dl class="detailList">
1370 <dt class="heading">Returns:</dt>
1372 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1386 <td class="msource">
1388 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1394 <tr class="method-row config-row-alt0 expandable">
1395 <td class="micon"><a class="exi" href="#expand"> </a></td>
1399 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1400 <div class="fixedFont">
1401 <span class="attributes"></span><b class="itemname">fireEvent</b>
1403 (<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>)
1409 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1418 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1424 Fires the specified event with the passed parameters (minus the event name).
1431 <dl class="detailList">
1432 <dt class="heading">Parameters:</dt>
1435 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1441 <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>
1444 <dd>Variable number of parameters are passed to handlers</dd>
1452 <dl class="detailList">
1453 <dt class="heading">Returns:</dt>
1455 <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>
1469 <td class="msource">
1471 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1477 <tr class="method-row config-row-alt1 expandable">
1478 <td class="micon"><a class="exi" href="#expand"> </a></td>
1482 <a id="Roo.Component-method-focus" name=".focus"></a>
1483 <div class="fixedFont">
1484 <span class="attributes"></span><b class="itemname">focus</b>
1486 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1492 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1501 <div class="short">Try to focus this component.</div>
1507 Try to focus this component.
1514 <dl class="detailList">
1515 <dt class="heading">Parameters:</dt>
1518 <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>
1521 <dd>True to also select the text in this component (if applicable)</dd>
1529 <dl class="detailList">
1530 <dt class="heading">Returns:</dt>
1532 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1546 <td class="msource">
1548 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1554 <tr class="method-row config-row-alt0 expandable">
1555 <td class="micon"><a class="exi" href="#expand"> </a></td>
1559 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1560 <div class="fixedFont">
1561 <span class="attributes"></span><b class="itemname">getEl</b>
1569 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1578 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1584 Returns the underlying {<b>link</b> Roo.Element}.
1595 <dl class="detailList">
1596 <dt class="heading">Returns:</dt>
1598 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1612 <td class="msource">
1614 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1620 <tr class="method-row config-row-alt1 expandable">
1621 <td class="micon"><a class="exi" href="#expand"> </a></td>
1625 <a id="Roo.Component-method-getId" name=".getId"></a>
1626 <div class="fixedFont">
1627 <span class="attributes"></span><b class="itemname">getId</b>
1635 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1644 <div class="short">Returns the id of this component.</div>
1650 Returns the id of this component.
1661 <dl class="detailList">
1662 <dt class="heading">Returns:</dt>
1664 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1678 <td class="msource">
1680 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1686 <tr class="method-row config-row-alt0 expandable">
1687 <td class="micon"><a class="exi" href="#expand"> </a></td>
1691 <a id="Roo.Editor-method-getValue" name=".getValue"></a>
1692 <div class="fixedFont">
1693 <span class="attributes"></span><b class="itemname">getValue</b>
1710 <div class="short">Gets the data value of the editor</div>
1716 Gets the data value of the editor
1727 <dl class="detailList">
1728 <dt class="heading">Returns:</dt>
1730 <dd><span class="fixedFont">Mixed</span> The data value</dd>
1744 <td class="msource">
1746 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
1752 <tr class="method-row config-row-alt1 expandable">
1753 <td class="micon"><a class="exi" href="#expand"> </a></td>
1757 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1758 <div class="fixedFont">
1759 <span class="attributes"></span><b class="itemname">hasListener</b>
1761 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1767 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1776 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1782 Checks to see if this object has any listeners for a specified event
1789 <dl class="detailList">
1790 <dt class="heading">Parameters:</dt>
1793 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1796 <dd>The name of the event to check for</dd>
1804 <dl class="detailList">
1805 <dt class="heading">Returns:</dt>
1807 <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>
1821 <td class="msource">
1823 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1829 <tr class="method-row config-row-alt0 expandable">
1830 <td class="micon"><a class="exi" href="#expand"> </a></td>
1834 <a id="Roo.Component-method-hide" name=".hide"></a>
1835 <div class="fixedFont">
1836 <span class="attributes"></span><b class="itemname">hide</b>
1844 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1853 <div class="short">Hide this component.</div>
1859 Hide this component.
1870 <dl class="detailList">
1871 <dt class="heading">Returns:</dt>
1873 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1887 <td class="msource">
1889 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1895 <tr class="method-row config-row-alt1 expandable">
1896 <td class="micon"><a class="exi" href="#expand"> </a></td>
1900 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1901 <div class="fixedFont">
1902 <span class="attributes"></span><b class="itemname">isVisible</b>
1911 <div class="short">Returns true if this component is visible.</div>
1917 Returns true if this component is visible.
1938 <td class="msource">
1940 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1946 <tr class="method-row config-row-alt0 expandable">
1947 <td class="micon"><a class="exi" href="#expand"> </a></td>
1951 <a id="Roo.util.Observable-method-on" name=".on"></a>
1952 <div class="fixedFont">
1953 <span class="attributes"></span><b class="itemname">on</b>
1955 (<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>)
1962 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1968 Appends an event handler to this element (shorthand for addListener)
1975 <dl class="detailList">
1976 <dt class="heading">Parameters:</dt>
1979 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1982 <dd>The type of event to listen for</dd>
1985 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1988 <dd>The method the event invokes</dd>
1991 <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>
1994 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1997 <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>
2018 <td class="msource">
2020 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2026 <tr class="method-row config-row-alt1 expandable">
2027 <td class="micon"><a class="exi" href="#expand"> </a></td>
2031 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2032 <div class="fixedFont">
2033 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2042 <div class="short">Removes all listeners for this object</div>
2048 Removes all listeners for this object
2069 <td class="msource">
2071 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2077 <tr class="method-row config-row-alt0 expandable">
2078 <td class="micon"><a class="exi" href="#expand"> </a></td>
2082 <a id="Roo.Editor-method-realign" name=".realign"></a>
2083 <div class="fixedFont">
2084 <span class="attributes"></span><b class="itemname">realign</b>
2093 <div class="short">Realigns the editor to the bound field based on the current alignment config value.</div>
2099 Realigns the editor to the bound field based on the current alignment config value.
2120 <td class="msource">
2122 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2128 <tr class="method-row config-row-alt1 expandable">
2129 <td class="micon"><a class="exi" href="#expand"> </a></td>
2133 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2134 <div class="fixedFont">
2135 <span class="attributes"></span><b class="itemname">removeListener</b>
2137 (<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>)
2144 <div class="short">Removes a listener</div>
2157 <dl class="detailList">
2158 <dt class="heading">Parameters:</dt>
2161 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2164 <dd>The type of event to listen for</dd>
2167 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2170 <dd>The handler to remove</dd>
2173 <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>
2176 <dd>(optional) The scope (this object) for the handler</dd>
2194 <td class="msource">
2196 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2202 <tr class="method-row config-row-alt0 expandable">
2203 <td class="micon"><a class="exi" href="#expand"> </a></td>
2207 <a id="Roo.Component-method-render" name=".render"></a>
2208 <div class="fixedFont">
2209 <span class="attributes"></span><b class="itemname">render</b>
2211 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
2218 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
2224 If this is a lazy rendering component, render it to its container element.
2231 <dl class="detailList">
2232 <dt class="heading">Parameters:</dt>
2235 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
2238 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
2256 <td class="msource">
2258 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2264 <tr class="method-row config-row-alt1 expandable">
2265 <td class="micon"><a class="exi" href="#expand"> </a></td>
2269 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
2270 <div class="fixedFont">
2271 <span class="attributes"></span><b class="itemname">setDisabled</b>
2273 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
2280 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
2286 Convenience function for setting disabled/enabled by boolean.
2293 <dl class="detailList">
2294 <dt class="heading">Parameters:</dt>
2297 <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>
2318 <td class="msource">
2320 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2326 <tr class="method-row config-row-alt0 expandable">
2327 <td class="micon"><a class="exi" href="#expand"> </a></td>
2331 <a id="Roo.Editor-method-setSize" name=".setSize"></a>
2332 <div class="fixedFont">
2333 <span class="attributes"></span><b class="itemname">setSize</b>
2335 (<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>)
2342 <div class="short">Sets the height and width of this editor.</div>
2348 Sets the height and width of this editor.
2355 <dl class="detailList">
2356 <dt class="heading">Parameters:</dt>
2359 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
2362 <dd>The new width</dd>
2365 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
2368 <dd>The new height</dd>
2386 <td class="msource">
2388 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2394 <tr class="method-row config-row-alt1 expandable">
2395 <td class="micon"><a class="exi" href="#expand"> </a></td>
2399 <a id="Roo.Editor-method-setValue" name=".setValue"></a>
2400 <div class="fixedFont">
2401 <span class="attributes"></span><b class="itemname">setValue</b>
2403 (Mixed <B><i>value</i></B>)
2410 <div class="short">Sets the data value of the editor</div>
2416 Sets the data value of the editor
2423 <dl class="detailList">
2424 <dt class="heading">Parameters:</dt>
2427 <span class="fixedFont">Mixed</span> <b>value</b>
2430 <dd>Any valid value supported by the underlying field</dd>
2448 <td class="msource">
2450 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2456 <tr class="method-row config-row-alt0 expandable">
2457 <td class="micon"><a class="exi" href="#expand"> </a></td>
2461 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
2462 <div class="fixedFont">
2463 <span class="attributes"></span><b class="itemname">setVisible</b>
2465 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
2471 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2480 <div class="short">Convenience function to hide or show this component by boolean.</div>
2486 Convenience function to hide or show this component by boolean.
2493 <dl class="detailList">
2494 <dt class="heading">Parameters:</dt>
2497 <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>
2500 <dd>True to show, false to hide</dd>
2508 <dl class="detailList">
2509 <dt class="heading">Returns:</dt>
2511 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2525 <td class="msource">
2527 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2533 <tr class="method-row config-row-alt1 expandable">
2534 <td class="micon"><a class="exi" href="#expand"> </a></td>
2538 <a id="Roo.Component-method-show" name=".show"></a>
2539 <div class="fixedFont">
2540 <span class="attributes"></span><b class="itemname">show</b>
2548 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2557 <div class="short">Show this component.</div>
2563 Show this component.
2574 <dl class="detailList">
2575 <dt class="heading">Returns:</dt>
2577 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2591 <td class="msource">
2593 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2599 <tr class="method-row config-row-alt0 expandable">
2600 <td class="micon"><a class="exi" href="#expand"> </a></td>
2604 <a id="Roo.Editor-method-startEdit" name=".startEdit"></a>
2605 <div class="fixedFont">
2606 <span class="attributes"></span><b class="itemname">startEdit</b>
2608 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>value</i></B>)
2615 <div class="short">Starts the editing process and shows the editor.</div>
2621 Starts the editing process and shows the editor.
2628 <dl class="detailList">
2629 <dt class="heading">Parameters:</dt>
2632 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
2635 <dd>The element to edit</dd>
2638 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
2641 <dd>(optional) A value to initialize the editor with. If a value is not provided, it defaults<br/>to the innerHTML of el.</dd>
2659 <td class="msource">
2661 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2667 <tr class="method-row config-row-alt1 expandable">
2668 <td class="micon"><a class="exi" href="#expand"> </a></td>
2672 <a id="Roo.util.Observable-method-un" name=".un"></a>
2673 <div class="fixedFont">
2674 <span class="attributes"></span><b class="itemname">un</b>
2676 (<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>)
2683 <div class="short">Removes a listener (shorthand for removeListener)</div>
2689 Removes a listener (shorthand for removeListener)
2696 <dl class="detailList">
2697 <dt class="heading">Parameters:</dt>
2700 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2703 <dd>The type of event to listen for</dd>
2706 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2709 <dd>The handler to remove</dd>
2712 <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>
2715 <dd>(optional) The scope (this object) for the handler</dd>
2733 <td class="msource">
2735 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2744 <!-- ============================== events summary / details ======================== -->
2747 <a id="Roo.tree.TreeEditor-events"></a>
2756 <table cellspacing="0" class="member-table">
2757 <caption>Events</caption>
2760 <th class="sig-header" colspan="2">Event</th>
2761 <th class="msource-header">Defined By</th>
2770 <tr class="method-row expandable config-row-alt0">
2771 <td class="micon"><a class="exi" href="#expand"> </a></td>
2774 <a id="Roo.Editor-event-*beforecomplete"></a>
2776 <div class="fixedFont">
2777 <b class="itemname">beforecomplete</b> (Editor <B><i>this</i></B>, Mixed <B><i>value</i></B>, Mixed <B><i>startValue</i></B>)
2783 <div class="short">Fires after a change has been made to the field, but before the change is reflected in the underlying<br/>field.
2789 Fires after a change has been made to the field, but before the change is reflected in the underlying<br/>field. Saving the change to the field can be canceled by returning false from the handler of this event.<br/>Note that if the value has not changed and ignoreNoChange = true, the editing will still end but this<br/>event will not fire since no edit actually occurred.
2795 <dl class="detailList">
2796 <dt class="heading">Parameters:</dt>
2799 <span class="fixedFont">Editor</span> <b>this</b>
2805 <span class="fixedFont">Mixed</span> <b>value</b>
2808 <dd>The current field value</dd>
2811 <span class="fixedFont">Mixed</span> <b>startValue</b>
2814 <dd>The original field value</dd>
2832 <td class="msource">
2833 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2837 <tr class="method-row expandable config-row-alt1">
2838 <td class="micon"><a class="exi" href="#expand"> </a></td>
2841 <a id="Roo.Component-event-*beforedestroy"></a>
2843 <div class="fixedFont">
2844 <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>)
2850 <div class="short">Fires before the component is destroyed.
2856 Fires before the component is destroyed. Return false to stop the destroy.
2862 <dl class="detailList">
2863 <dt class="heading">Parameters:</dt>
2866 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2887 <td class="msource">
2888 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2892 <tr class="method-row expandable config-row-alt0">
2893 <td class="micon"><a class="exi" href="#expand"> </a></td>
2896 <a id="Roo.Component-event-*beforehide"></a>
2898 <div class="fixedFont">
2899 <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>)
2905 <div class="short">Fires before the component is hidden.
2911 Fires before the component is hidden. Return false to stop the hide.
2917 <dl class="detailList">
2918 <dt class="heading">Parameters:</dt>
2921 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2942 <td class="msource">
2943 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2947 <tr class="method-row expandable config-row-alt1 notInherited">
2948 <td class="micon"><a class="exi" href="#expand"> </a></td>
2951 <a id="Roo.tree.TreeEditor-event-*beforenodeedit"></a>
2953 <div class="fixedFont">
2954 <b class="itemname">beforenodeedit</b> (Editor <B><i>this</i></B>, Roo.tree.Node <B><i>node</i></B>)
2960 <div class="short">Fires when editing is initiated, but before the value changes.
2966 Fires when editing is initiated, but before the value changes. Editing can be canceled by returning<br/>false from the handler of this event.
2972 <dl class="detailList">
2973 <dt class="heading">Parameters:</dt>
2976 <span class="fixedFont">Editor</span> <b>this</b>
2982 <span class="fixedFont">Roo.tree.Node</span> <b>node</b>
3003 <td class="msource">
3008 <tr class="method-row expandable config-row-alt0">
3009 <td class="micon"><a class="exi" href="#expand"> </a></td>
3012 <a id="Roo.Component-event-*beforerender"></a>
3014 <div class="fixedFont">
3015 <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>)
3021 <div class="short">Fires before the component is rendered.
3027 Fires before the component is rendered. Return false to stop the render.
3033 <dl class="detailList">
3034 <dt class="heading">Parameters:</dt>
3037 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3058 <td class="msource">
3059 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3063 <tr class="method-row expandable config-row-alt1">
3064 <td class="micon"><a class="exi" href="#expand"> </a></td>
3067 <a id="Roo.Component-event-*beforeshow"></a>
3069 <div class="fixedFont">
3070 <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>)
3076 <div class="short">Fires before the component is shown.
3082 Fires before the component is shown. Return false to stop the show.
3088 <dl class="detailList">
3089 <dt class="heading">Parameters:</dt>
3092 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3113 <td class="msource">
3114 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3118 <tr class="method-row expandable config-row-alt0">
3119 <td class="micon"><a class="exi" href="#expand"> </a></td>
3122 <a id="Roo.Editor-event-*beforestartedit"></a>
3124 <div class="fixedFont">
3125 <b class="itemname">beforestartedit</b> (Editor <B><i>this</i></B>, <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>boundEl</i></B>, Mixed <B><i>value</i></B>)
3131 <div class="short">Fires when editing is initiated, but before the value changes.
3137 Fires when editing is initiated, but before the value changes. Editing can be canceled by returning<br/>false from the handler of this event.
3143 <dl class="detailList">
3144 <dt class="heading">Parameters:</dt>
3147 <span class="fixedFont">Editor</span> <b>this</b>
3153 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>boundEl</b>
3156 <dd>The underlying element bound to this editor</dd>
3159 <span class="fixedFont">Mixed</span> <b>value</b>
3162 <dd>The field value being set</dd>
3180 <td class="msource">
3181 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
3185 <tr class="method-row expandable config-row-alt1">
3186 <td class="micon"><a class="exi" href="#expand"> </a></td>
3189 <a id="Roo.Editor-event-*complete"></a>
3191 <div class="fixedFont">
3192 <b class="itemname">complete</b> (Editor <B><i>this</i></B>, Mixed <B><i>value</i></B>, Mixed <B><i>startValue</i></B>)
3198 <div class="short">Fires after editing is complete and any changed value has been written to the underlying field.
3204 Fires after editing is complete and any changed value has been written to the underlying field.
3210 <dl class="detailList">
3211 <dt class="heading">Parameters:</dt>
3214 <span class="fixedFont">Editor</span> <b>this</b>
3220 <span class="fixedFont">Mixed</span> <b>value</b>
3223 <dd>The current field value</dd>
3226 <span class="fixedFont">Mixed</span> <b>startValue</b>
3229 <dd>The original field value</dd>
3247 <td class="msource">
3248 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
3252 <tr class="method-row expandable config-row-alt0">
3253 <td class="micon"><a class="exi" href="#expand"> </a></td>
3256 <a id="Roo.Component-event-*destroy"></a>
3258 <div class="fixedFont">
3259 <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>)
3265 <div class="short">Fires after the component is destroyed.
3271 Fires after the component is destroyed.
3277 <dl class="detailList">
3278 <dt class="heading">Parameters:</dt>
3281 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3302 <td class="msource">
3303 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3307 <tr class="method-row expandable config-row-alt1">
3308 <td class="micon"><a class="exi" href="#expand"> </a></td>
3311 <a id="Roo.Component-event-*disable"></a>
3313 <div class="fixedFont">
3314 <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>)
3320 <div class="short">Fires after the component is disabled.
3326 Fires after the component is disabled.
3332 <dl class="detailList">
3333 <dt class="heading">Parameters:</dt>
3336 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3357 <td class="msource">
3358 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3362 <tr class="method-row expandable config-row-alt0">
3363 <td class="micon"><a class="exi" href="#expand"> </a></td>
3366 <a id="Roo.Component-event-*enable"></a>
3368 <div class="fixedFont">
3369 <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>)
3375 <div class="short">Fires after the component is enabled.
3381 Fires after the component is enabled.
3387 <dl class="detailList">
3388 <dt class="heading">Parameters:</dt>
3391 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3412 <td class="msource">
3413 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3417 <tr class="method-row expandable config-row-alt1">
3418 <td class="micon"><a class="exi" href="#expand"> </a></td>
3421 <a id="Roo.Component-event-*hide"></a>
3423 <div class="fixedFont">
3424 <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>)
3430 <div class="short">Fires after the component is hidden.
3436 Fires after the component is hidden.
3442 <dl class="detailList">
3443 <dt class="heading">Parameters:</dt>
3446 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3467 <td class="msource">
3468 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3472 <tr class="method-row expandable config-row-alt0">
3473 <td class="micon"><a class="exi" href="#expand"> </a></td>
3476 <a id="Roo.Component-event-*render"></a>
3478 <div class="fixedFont">
3479 <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>)
3485 <div class="short">Fires after the component is rendered.
3491 Fires after the component is rendered.
3497 <dl class="detailList">
3498 <dt class="heading">Parameters:</dt>
3501 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3522 <td class="msource">
3523 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3527 <tr class="method-row expandable config-row-alt1">
3528 <td class="micon"><a class="exi" href="#expand"> </a></td>
3531 <a id="Roo.Component-event-*show"></a>
3533 <div class="fixedFont">
3534 <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>)
3540 <div class="short">Fires after the component is shown.
3546 Fires after the component is shown.
3552 <dl class="detailList">
3553 <dt class="heading">Parameters:</dt>
3556 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3577 <td class="msource">
3578 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3582 <tr class="method-row expandable config-row-alt0">
3583 <td class="micon"><a class="exi" href="#expand"> </a></td>
3586 <a id="Roo.Editor-event-*specialkey"></a>
3588 <div class="fixedFont">
3589 <b class="itemname">specialkey</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3595 <div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.
3601 Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check<br/>{<b>link</b> Roo.EventObject<b>getKey</b>} to determine which key was pressed.
3607 <dl class="detailList">
3608 <dt class="heading">Parameters:</dt>
3611 <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>this</b>
3617 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3620 <dd>The event object</dd>
3638 <td class="msource">
3639 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
3643 <tr class="method-row expandable config-row-alt1">
3644 <td class="micon"><a class="exi" href="#expand"> </a></td>
3647 <a id="Roo.Editor-event-*startedit"></a>
3649 <div class="fixedFont">
3650 <b class="itemname">startedit</b> (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>boundEl</i></B>, Mixed <B><i>value</i></B>)
3656 <div class="short">Fires when this editor is displayed
3662 Fires when this editor is displayed
3668 <dl class="detailList">
3669 <dt class="heading">Parameters:</dt>
3672 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>boundEl</b>
3675 <dd>The underlying element bound to this editor</dd>
3678 <span class="fixedFont">Mixed</span> <b>value</b>
3681 <dd>The starting field value</dd>
3699 <td class="msource">
3700 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
3711 <!-- ============================== footer ================================= -->
3712 <div class="fineprint" style="clear:both">
3714 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Sep 09 2016 14:29:46 GMT+0800 (HKT)
3716 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>