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.grid.GridEditor</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.grid.GridEditor-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.grid.GridEditor-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.grid.GridEditor-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.grid.GridEditor-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.grid.GridEditor
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
59 Class Roo.grid.GridEditor
62 <table cellspacing="0" class="class-summary-table">
64 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
66 <tr><td class="label">Defined In:</td><td class="hd-info">
68 <a href="./src/Roo_grid_GridEditor.js.html">Roo/grid/GridEditor.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">GridEditor</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 Class for creating and editable grid elements.
91 <!-- ============================== Class comment block... ========================== -->
93 <div class="comments">
94 <b>Class Comments / Notes</B> =>
95 <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.GridEditor';">[Add Your comment/notes about this class]</u>
97 <iframe frameborder="0" id="comments-Roo.grid" style="border: none;width:100%;"
98 src="/blog.php/GtkDjsComments/Roo.grid.GridEditor.html"></iframe>
103 <!-- ============================== config options ========================== -->
108 <div class="hr"></div>
109 <a id="Roo.grid.GridEditor-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">
163 <td class="micon"><a class="exi" href="#expand"> </a></td>
166 <a id="Roo.Editor-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 "c-c?").</div>
179 The position to align to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to "c-c?").
189 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
195 <tr class="config-row expandable config-row-alt0">
196 <td class="micon"><a class="exi" href="#expand"> </a></td>
199 <a id="Roo.Component-cfg-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">
295 <td class="micon"><a class="exi" href="#expand"> </a></td>
298 <a id="Roo.Editor-cfg-completeOnEnter" name=".completeOnEnter"></a>
299 <div class="fixedFont">
300 <b class="itemname">completeOnEnter</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
306 <div class="short">True to complete the edit when the enter key is pressed (defaults to false)</div>
311 True to complete the edit when the enter key is pressed (defaults to false)
321 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
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-constrain" name=".constrain"></a>
332 <div class="fixedFont">
333 <b class="itemname">constrain</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 constrain the editor to the viewport</div>
344 True to constrain the editor to the viewport
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.Component-cfg-disableClass" name=".disableClass"></a>
365 <div class="fixedFont">
366 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
372 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
377 CSS class added to the component when it is disabled (defaults to "x-item-disabled").
387 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
393 <tr class="config-row expandable config-row-alt0 notInherited">
394 <td class="micon"><a class="exi" href="#expand"> </a></td>
397 <a id="Roo.grid.GridEditor-cfg-field" name=".field"></a>
398 <div class="fixedFont">
399 <b class="itemname">field</b> : <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
405 <div class="short">Field to wrap (or xtyped)</div>
410 Field to wrap (or xtyped)
426 <tr class="config-row expandable config-row-alt1">
427 <td class="micon"><a class="exi" href="#expand"> </a></td>
430 <a id="Roo.Editor-cfg-hideEl" name=".hideEl"></a>
431 <div class="fixedFont">
432 <b class="itemname">hideEl</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
438 <div class="short">False to keep the bound element visible while the editor is displayed (defaults to true)</div>
443 False to keep the bound element visible while the editor is displayed (defaults to true)
453 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
459 <tr class="config-row expandable config-row-alt0">
460 <td class="micon"><a class="exi" href="#expand"> </a></td>
463 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
464 <div class="fixedFont">
465 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
471 <div class="short">How this component should hidden.</div>
476 How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".
477 <BR/>Possible Values: display, visibility
486 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
492 <tr class="config-row expandable config-row-alt1">
493 <td class="micon"><a class="exi" href="#expand"> </a></td>
496 <a id="Roo.Editor-cfg-ignoreNoChange" name=".ignoreNoChange"></a>
497 <div class="fixedFont">
498 <b class="itemname">ignoreNoChange</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
504 <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>
509 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.
519 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</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.util.Observable-cfg-listeners" name=".listeners"></a>
530 <div class="fixedFont">
531 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
537 <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>
542 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>
552 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</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.Editor-cfg-revertInvalid" name=".revertInvalid"></a>
563 <div class="fixedFont">
564 <b class="itemname">revertInvalid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
570 <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>
575 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)
585 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
591 <tr class="config-row expandable config-row-alt0">
592 <td class="micon"><a class="exi" href="#expand"> </a></td>
595 <a id="Roo.Editor-cfg-shadow" name=".shadow"></a>
596 <div class="fixedFont">
597 <b class="itemname">shadow</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String
603 <div class="short">"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"<br/>for bottom-right shadow (defaults to "frame")</div>
608 "sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"<br/>for bottom-right shadow (defaults to "frame")
618 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
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-updateEl" name=".updateEl"></a>
629 <div class="fixedFont">
630 <b class="itemname">updateEl</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 update the innerHTML of the bound element when the update completes (defaults to false)</div>
641 True to update the innerHTML of the bound element when the update completes (defaults to false)
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-value" name=".value"></a>
662 <div class="fixedFont">
663 <b class="itemname">value</b> : Mixed
669 <div class="short">The data value of the underlying field (defaults to "")</div>
674 The data value of the underlying field (defaults to "")
684 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
700 <!-- ============================== public properties ==================== -->
704 <a id="Roo.grid.GridEditor-props"></a>
710 <table cellspacing="0" class="member-table">
711 <caption class="Empty">Public Properties - Has None</caption>
717 <!-- ============================== methods summary / details ======================== -->
720 <a id="Roo.grid.GridEditor-methods"></a>
721 <!-- constructor?? -->
728 <!-- then dynamics first -->
735 <table cellspacing="0" class="member-table">
736 <caption>Public Methods</caption>
738 <th class="sig-header" colspan="2">Method</th>
739 <th class="msource-header">Defined By</th>
749 <tr class="method-row config-row-alt0 expandable notInherited">
750 <td class="micon"><a class="exi" href="#expand"> </a></td>
754 <a id="Roo.grid-method-GridEditor" name=".GridEditor"></a>
755 <div class="fixedFont">
756 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">GridEditor</b>
758 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
766 <div class="short">Create a new Roo.grid.GridEditor</div>
773 Create a new Roo.grid.GridEditor
776 <dl class="detailList">
777 <dt class="heading">Parameters:</dt>
780 <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>
783 <dd>any settings (must include field)</dd>
807 <tr class="method-row config-row-alt1 expandable">
808 <td class="micon"><a class="exi" href="#expand"> </a></td>
812 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
813 <div class="fixedFont">
814 <span class="attributes"></span><b class="itemname">addEvents</b>
816 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
823 <div class="short">Used to define events on this Observable</div>
829 Used to define events on this Observable
836 <dl class="detailList">
837 <dt class="heading">Parameters:</dt>
840 <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>
843 <dd>The object with the events defined</dd>
863 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
869 <tr class="method-row config-row-alt0 expandable">
870 <td class="micon"><a class="exi" href="#expand"> </a></td>
874 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
875 <div class="fixedFont">
876 <span class="attributes"></span><b class="itemname">addListener</b>
878 (<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>)
885 <div class="short">Appends an event handler to this component</div>
891 Appends an event handler to this component
898 <dl class="detailList">
899 <dt class="heading">Parameters:</dt>
902 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
905 <dd>The type of event to listen for</dd>
908 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
911 <dd>The method the event invokes</dd>
914 <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>
917 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
920 <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>
923 <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>
943 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
949 <tr class="method-row config-row-alt1 expandable">
950 <td class="micon"><a class="exi" href="#expand"> </a></td>
954 <a id="Roo.Editor-method-cancelEdit" name=".cancelEdit"></a>
955 <div class="fixedFont">
956 <span class="attributes"></span><b class="itemname">cancelEdit</b>
958 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>remainVisible</i></B>)
965 <div class="short">Cancels the editing process and hides the editor without persisting any changes.</div>
971 Cancels the editing process and hides the editor without persisting any changes. The field value will be<br/>reverted to the original starting value.
978 <dl class="detailList">
979 <dt class="heading">Parameters:</dt>
982 <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>
985 <dd>Override the default behavior and keep the editor visible after<br/>cancel (defaults to false)</dd>
1003 <td class="msource">
1005 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
1011 <tr class="method-row config-row-alt0 expandable">
1012 <td class="micon"><a class="exi" href="#expand"> </a></td>
1016 <a id="Roo.Editor-method-completeEdit" name=".completeEdit"></a>
1017 <div class="fixedFont">
1018 <span class="attributes"></span><b class="itemname">completeEdit</b>
1020 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>remainVisible</i></B>)
1027 <div class="short">Ends the editing process, persists the changed value to the underlying field, and hides the editor.</div>
1033 Ends the editing process, persists the changed value to the underlying field, and hides the editor.
1040 <dl class="detailList">
1041 <dt class="heading">Parameters:</dt>
1044 <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>
1047 <dd>Override the default behavior and keep the editor visible after edit (defaults to false)</dd>
1065 <td class="msource">
1067 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
1073 <tr class="method-row config-row-alt1 expandable">
1074 <td class="micon"><a class="exi" href="#expand"> </a></td>
1078 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1079 <div class="fixedFont">
1080 <span class="attributes"></span><b class="itemname">destroy</b>
1089 <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>
1095 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}.
1116 <td class="msource">
1118 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1124 <tr class="method-row config-row-alt0 expandable">
1125 <td class="micon"><a class="exi" href="#expand"> </a></td>
1129 <a id="Roo.Component-method-disable" name=".disable"></a>
1130 <div class="fixedFont">
1131 <span class="attributes"></span><b class="itemname">disable</b>
1139 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1148 <div class="short">Disable this component.</div>
1154 Disable this component.
1165 <dl class="detailList">
1166 <dt class="heading">Returns:</dt>
1168 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1182 <td class="msource">
1184 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1190 <tr class="method-row config-row-alt1 expandable">
1191 <td class="micon"><a class="exi" href="#expand"> </a></td>
1195 <a id="Roo.Component-method-enable" name=".enable"></a>
1196 <div class="fixedFont">
1197 <span class="attributes"></span><b class="itemname">enable</b>
1205 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1214 <div class="short">Enable this component.</div>
1220 Enable this component.
1231 <dl class="detailList">
1232 <dt class="heading">Returns:</dt>
1234 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1248 <td class="msource">
1250 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1256 <tr class="method-row config-row-alt0 expandable">
1257 <td class="micon"><a class="exi" href="#expand"> </a></td>
1261 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1262 <div class="fixedFont">
1263 <span class="attributes"></span><b class="itemname">fireEvent</b>
1265 (<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>)
1271 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1280 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1286 Fires the specified event with the passed parameters (minus the event name).
1293 <dl class="detailList">
1294 <dt class="heading">Parameters:</dt>
1297 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1303 <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>
1306 <dd>Variable number of parameters are passed to handlers</dd>
1314 <dl class="detailList">
1315 <dt class="heading">Returns:</dt>
1317 <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>
1331 <td class="msource">
1333 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1339 <tr class="method-row config-row-alt1 expandable">
1340 <td class="micon"><a class="exi" href="#expand"> </a></td>
1344 <a id="Roo.Component-method-focus" name=".focus"></a>
1345 <div class="fixedFont">
1346 <span class="attributes"></span><b class="itemname">focus</b>
1348 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1354 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1363 <div class="short">Try to focus this component.</div>
1369 Try to focus this component.
1376 <dl class="detailList">
1377 <dt class="heading">Parameters:</dt>
1380 <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>
1383 <dd>True to also select the text in this component (if applicable)</dd>
1391 <dl class="detailList">
1392 <dt class="heading">Returns:</dt>
1394 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1408 <td class="msource">
1410 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1416 <tr class="method-row config-row-alt0 expandable">
1417 <td class="micon"><a class="exi" href="#expand"> </a></td>
1421 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1422 <div class="fixedFont">
1423 <span class="attributes"></span><b class="itemname">getEl</b>
1431 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1440 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1446 Returns the underlying {<b>link</b> Roo.Element}.
1457 <dl class="detailList">
1458 <dt class="heading">Returns:</dt>
1460 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1474 <td class="msource">
1476 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1482 <tr class="method-row config-row-alt1 expandable">
1483 <td class="micon"><a class="exi" href="#expand"> </a></td>
1487 <a id="Roo.Component-method-getId" name=".getId"></a>
1488 <div class="fixedFont">
1489 <span class="attributes"></span><b class="itemname">getId</b>
1497 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1506 <div class="short">Returns the id of this component.</div>
1512 Returns the id of this component.
1523 <dl class="detailList">
1524 <dt class="heading">Returns:</dt>
1526 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1540 <td class="msource">
1542 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1548 <tr class="method-row config-row-alt0 expandable">
1549 <td class="micon"><a class="exi" href="#expand"> </a></td>
1553 <a id="Roo.Editor-method-getValue" name=".getValue"></a>
1554 <div class="fixedFont">
1555 <span class="attributes"></span><b class="itemname">getValue</b>
1572 <div class="short">Gets the data value of the editor</div>
1578 Gets the data value of the editor
1589 <dl class="detailList">
1590 <dt class="heading">Returns:</dt>
1592 <dd><span class="fixedFont">Mixed</span> The data value</dd>
1606 <td class="msource">
1608 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
1614 <tr class="method-row config-row-alt1 expandable">
1615 <td class="micon"><a class="exi" href="#expand"> </a></td>
1619 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1620 <div class="fixedFont">
1621 <span class="attributes"></span><b class="itemname">hasListener</b>
1623 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1629 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1638 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1644 Checks to see if this object has any listeners for a specified event
1651 <dl class="detailList">
1652 <dt class="heading">Parameters:</dt>
1655 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1658 <dd>The name of the event to check for</dd>
1666 <dl class="detailList">
1667 <dt class="heading">Returns:</dt>
1669 <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>
1683 <td class="msource">
1685 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1691 <tr class="method-row config-row-alt0 expandable">
1692 <td class="micon"><a class="exi" href="#expand"> </a></td>
1696 <a id="Roo.Component-method-hide" name=".hide"></a>
1697 <div class="fixedFont">
1698 <span class="attributes"></span><b class="itemname">hide</b>
1706 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1715 <div class="short">Hide this component.</div>
1721 Hide this component.
1732 <dl class="detailList">
1733 <dt class="heading">Returns:</dt>
1735 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1749 <td class="msource">
1751 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1757 <tr class="method-row config-row-alt1 expandable">
1758 <td class="micon"><a class="exi" href="#expand"> </a></td>
1762 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1763 <div class="fixedFont">
1764 <span class="attributes"></span><b class="itemname">isVisible</b>
1773 <div class="short">Returns true if this component is visible.</div>
1779 Returns true if this component is visible.
1800 <td class="msource">
1802 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1808 <tr class="method-row config-row-alt0 expandable">
1809 <td class="micon"><a class="exi" href="#expand"> </a></td>
1813 <a id="Roo.util.Observable-method-on" name=".on"></a>
1814 <div class="fixedFont">
1815 <span class="attributes"></span><b class="itemname">on</b>
1817 (<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>)
1824 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1830 Appends an event handler to this element (shorthand for addListener)
1837 <dl class="detailList">
1838 <dt class="heading">Parameters:</dt>
1841 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1844 <dd>The type of event to listen for</dd>
1847 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1850 <dd>The method the event invokes</dd>
1853 <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>
1856 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1859 <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>
1880 <td class="msource">
1882 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1888 <tr class="method-row config-row-alt1 expandable">
1889 <td class="micon"><a class="exi" href="#expand"> </a></td>
1893 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1894 <div class="fixedFont">
1895 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1904 <div class="short">Removes all listeners for this object</div>
1910 Removes all listeners for this object
1931 <td class="msource">
1933 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1939 <tr class="method-row config-row-alt0 expandable">
1940 <td class="micon"><a class="exi" href="#expand"> </a></td>
1944 <a id="Roo.Editor-method-realign" name=".realign"></a>
1945 <div class="fixedFont">
1946 <span class="attributes"></span><b class="itemname">realign</b>
1955 <div class="short">Realigns the editor to the bound field based on the current alignment config value.</div>
1961 Realigns the editor to the bound field based on the current alignment config value.
1982 <td class="msource">
1984 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
1990 <tr class="method-row config-row-alt1 expandable">
1991 <td class="micon"><a class="exi" href="#expand"> </a></td>
1995 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1996 <div class="fixedFont">
1997 <span class="attributes"></span><b class="itemname">removeListener</b>
1999 (<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>)
2006 <div class="short">Removes a listener</div>
2019 <dl class="detailList">
2020 <dt class="heading">Parameters:</dt>
2023 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2026 <dd>The type of event to listen for</dd>
2029 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2032 <dd>The handler to remove</dd>
2035 <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>
2038 <dd>(optional) The scope (this object) for the handler</dd>
2056 <td class="msource">
2058 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2064 <tr class="method-row config-row-alt0 expandable">
2065 <td class="micon"><a class="exi" href="#expand"> </a></td>
2069 <a id="Roo.Component-method-render" name=".render"></a>
2070 <div class="fixedFont">
2071 <span class="attributes"></span><b class="itemname">render</b>
2073 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
2080 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
2086 If this is a lazy rendering component, render it to its container element.
2093 <dl class="detailList">
2094 <dt class="heading">Parameters:</dt>
2097 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
2100 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
2118 <td class="msource">
2120 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2126 <tr class="method-row config-row-alt1 expandable">
2127 <td class="micon"><a class="exi" href="#expand"> </a></td>
2131 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
2132 <div class="fixedFont">
2133 <span class="attributes"></span><b class="itemname">setDisabled</b>
2135 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
2142 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
2148 Convenience function for setting disabled/enabled by boolean.
2155 <dl class="detailList">
2156 <dt class="heading">Parameters:</dt>
2159 <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>
2180 <td class="msource">
2182 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2188 <tr class="method-row config-row-alt0 expandable">
2189 <td class="micon"><a class="exi" href="#expand"> </a></td>
2193 <a id="Roo.Editor-method-setSize" name=".setSize"></a>
2194 <div class="fixedFont">
2195 <span class="attributes"></span><b class="itemname">setSize</b>
2197 (<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>)
2204 <div class="short">Sets the height and width of this editor.</div>
2210 Sets the height and width of this editor.
2217 <dl class="detailList">
2218 <dt class="heading">Parameters:</dt>
2221 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
2224 <dd>The new width</dd>
2227 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
2230 <dd>The new height</dd>
2248 <td class="msource">
2250 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2256 <tr class="method-row config-row-alt1 expandable">
2257 <td class="micon"><a class="exi" href="#expand"> </a></td>
2261 <a id="Roo.Editor-method-setValue" name=".setValue"></a>
2262 <div class="fixedFont">
2263 <span class="attributes"></span><b class="itemname">setValue</b>
2265 (Mixed <B><i>value</i></B>)
2272 <div class="short">Sets the data value of the editor</div>
2278 Sets the data value of the editor
2285 <dl class="detailList">
2286 <dt class="heading">Parameters:</dt>
2289 <span class="fixedFont">Mixed</span> <b>value</b>
2292 <dd>Any valid value supported by the underlying field</dd>
2310 <td class="msource">
2312 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2318 <tr class="method-row config-row-alt0 expandable">
2319 <td class="micon"><a class="exi" href="#expand"> </a></td>
2323 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
2324 <div class="fixedFont">
2325 <span class="attributes"></span><b class="itemname">setVisible</b>
2327 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
2333 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2342 <div class="short">Convenience function to hide or show this component by boolean.</div>
2348 Convenience function to hide or show this component by boolean.
2355 <dl class="detailList">
2356 <dt class="heading">Parameters:</dt>
2359 <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>
2362 <dd>True to show, false to hide</dd>
2370 <dl class="detailList">
2371 <dt class="heading">Returns:</dt>
2373 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2387 <td class="msource">
2389 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2395 <tr class="method-row config-row-alt1 expandable">
2396 <td class="micon"><a class="exi" href="#expand"> </a></td>
2400 <a id="Roo.Component-method-show" name=".show"></a>
2401 <div class="fixedFont">
2402 <span class="attributes"></span><b class="itemname">show</b>
2410 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2419 <div class="short">Show this component.</div>
2425 Show this component.
2436 <dl class="detailList">
2437 <dt class="heading">Returns:</dt>
2439 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2453 <td class="msource">
2455 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2461 <tr class="method-row config-row-alt0 expandable">
2462 <td class="micon"><a class="exi" href="#expand"> </a></td>
2466 <a id="Roo.Editor-method-startEdit" name=".startEdit"></a>
2467 <div class="fixedFont">
2468 <span class="attributes"></span><b class="itemname">startEdit</b>
2470 (<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>)
2477 <div class="short">Starts the editing process and shows the editor.</div>
2483 Starts the editing process and shows the editor.
2490 <dl class="detailList">
2491 <dt class="heading">Parameters:</dt>
2494 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
2497 <dd>The element to edit</dd>
2500 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
2503 <dd>(optional) A value to initialize the editor with. If a value is not provided, it defaults<br/>to the innerHTML of el.</dd>
2521 <td class="msource">
2523 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2529 <tr class="method-row config-row-alt1 expandable">
2530 <td class="micon"><a class="exi" href="#expand"> </a></td>
2534 <a id="Roo.util.Observable-method-un" name=".un"></a>
2535 <div class="fixedFont">
2536 <span class="attributes"></span><b class="itemname">un</b>
2538 (<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>)
2545 <div class="short">Removes a listener (shorthand for removeListener)</div>
2551 Removes a listener (shorthand for removeListener)
2558 <dl class="detailList">
2559 <dt class="heading">Parameters:</dt>
2562 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2565 <dd>The type of event to listen for</dd>
2568 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2571 <dd>The handler to remove</dd>
2574 <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>
2577 <dd>(optional) The scope (this object) for the handler</dd>
2595 <td class="msource">
2597 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2606 <!-- ============================== events summary / details ======================== -->
2609 <a id="Roo.grid.GridEditor-events"></a>
2618 <table cellspacing="0" class="member-table">
2619 <caption>Events</caption>
2622 <th class="sig-header" colspan="2">Event</th>
2623 <th class="msource-header">Defined By</th>
2632 <tr class="method-row expandable config-row-alt0">
2633 <td class="micon"><a class="exi" href="#expand"> </a></td>
2636 <a id="Roo.Editor-event-*beforecomplete"></a>
2638 <div class="fixedFont">
2639 <b class="itemname">beforecomplete</b> (Editor <B><i>this</i></B>, Mixed <B><i>value</i></B>, Mixed <B><i>startValue</i></B>)
2645 <div class="short">Fires after a change has been made to the field, but before the change is reflected in the underlying<br/>field.
2651 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.
2657 <dl class="detailList">
2658 <dt class="heading">Parameters:</dt>
2661 <span class="fixedFont">Editor</span> <b>this</b>
2667 <span class="fixedFont">Mixed</span> <b>value</b>
2670 <dd>The current field value</dd>
2673 <span class="fixedFont">Mixed</span> <b>startValue</b>
2676 <dd>The original field value</dd>
2694 <td class="msource">
2695 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2699 <tr class="method-row expandable config-row-alt1">
2700 <td class="micon"><a class="exi" href="#expand"> </a></td>
2703 <a id="Roo.Component-event-*beforedestroy"></a>
2705 <div class="fixedFont">
2706 <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>)
2712 <div class="short">Fires before the component is destroyed.
2718 Fires before the component is destroyed. Return false to stop the destroy.
2724 <dl class="detailList">
2725 <dt class="heading">Parameters:</dt>
2728 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2749 <td class="msource">
2750 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2754 <tr class="method-row expandable config-row-alt0">
2755 <td class="micon"><a class="exi" href="#expand"> </a></td>
2758 <a id="Roo.Component-event-*beforehide"></a>
2760 <div class="fixedFont">
2761 <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>)
2767 <div class="short">Fires before the component is hidden.
2773 Fires before the component is hidden. Return false to stop the hide.
2779 <dl class="detailList">
2780 <dt class="heading">Parameters:</dt>
2783 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2804 <td class="msource">
2805 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2809 <tr class="method-row expandable config-row-alt1">
2810 <td class="micon"><a class="exi" href="#expand"> </a></td>
2813 <a id="Roo.Component-event-*beforerender"></a>
2815 <div class="fixedFont">
2816 <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>)
2822 <div class="short">Fires before the component is rendered.
2828 Fires before the component is rendered. Return false to stop the render.
2834 <dl class="detailList">
2835 <dt class="heading">Parameters:</dt>
2838 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2859 <td class="msource">
2860 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2864 <tr class="method-row expandable config-row-alt0">
2865 <td class="micon"><a class="exi" href="#expand"> </a></td>
2868 <a id="Roo.Component-event-*beforeshow"></a>
2870 <div class="fixedFont">
2871 <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>)
2877 <div class="short">Fires before the component is shown.
2883 Fires before the component is shown. Return false to stop the show.
2889 <dl class="detailList">
2890 <dt class="heading">Parameters:</dt>
2893 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2914 <td class="msource">
2915 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2919 <tr class="method-row expandable config-row-alt1">
2920 <td class="micon"><a class="exi" href="#expand"> </a></td>
2923 <a id="Roo.Editor-event-*beforestartedit"></a>
2925 <div class="fixedFont">
2926 <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>)
2932 <div class="short">Fires when editing is initiated, but before the value changes.
2938 Fires when editing is initiated, but before the value changes. Editing can be canceled by returning<br/>false from the handler of this event.
2944 <dl class="detailList">
2945 <dt class="heading">Parameters:</dt>
2948 <span class="fixedFont">Editor</span> <b>this</b>
2954 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>boundEl</b>
2957 <dd>The underlying element bound to this editor</dd>
2960 <span class="fixedFont">Mixed</span> <b>value</b>
2963 <dd>The field value being set</dd>
2981 <td class="msource">
2982 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
2986 <tr class="method-row expandable config-row-alt0">
2987 <td class="micon"><a class="exi" href="#expand"> </a></td>
2990 <a id="Roo.Editor-event-*complete"></a>
2992 <div class="fixedFont">
2993 <b class="itemname">complete</b> (Editor <B><i>this</i></B>, Mixed <B><i>value</i></B>, Mixed <B><i>startValue</i></B>)
2999 <div class="short">Fires after editing is complete and any changed value has been written to the underlying field.
3005 Fires after editing is complete and any changed value has been written to the underlying field.
3011 <dl class="detailList">
3012 <dt class="heading">Parameters:</dt>
3015 <span class="fixedFont">Editor</span> <b>this</b>
3021 <span class="fixedFont">Mixed</span> <b>value</b>
3024 <dd>The current field value</dd>
3027 <span class="fixedFont">Mixed</span> <b>startValue</b>
3030 <dd>The original field value</dd>
3048 <td class="msource">
3049 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
3053 <tr class="method-row expandable config-row-alt1">
3054 <td class="micon"><a class="exi" href="#expand"> </a></td>
3057 <a id="Roo.Component-event-*destroy"></a>
3059 <div class="fixedFont">
3060 <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>)
3066 <div class="short">Fires after the component is destroyed.
3072 Fires after the component is destroyed.
3078 <dl class="detailList">
3079 <dt class="heading">Parameters:</dt>
3082 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3103 <td class="msource">
3104 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3108 <tr class="method-row expandable config-row-alt0">
3109 <td class="micon"><a class="exi" href="#expand"> </a></td>
3112 <a id="Roo.Component-event-*disable"></a>
3114 <div class="fixedFont">
3115 <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>)
3121 <div class="short">Fires after the component is disabled.
3127 Fires after the component is disabled.
3133 <dl class="detailList">
3134 <dt class="heading">Parameters:</dt>
3137 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3158 <td class="msource">
3159 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3163 <tr class="method-row expandable config-row-alt1">
3164 <td class="micon"><a class="exi" href="#expand"> </a></td>
3167 <a id="Roo.Component-event-*enable"></a>
3169 <div class="fixedFont">
3170 <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>)
3176 <div class="short">Fires after the component is enabled.
3182 Fires after the component is enabled.
3188 <dl class="detailList">
3189 <dt class="heading">Parameters:</dt>
3192 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3213 <td class="msource">
3214 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3218 <tr class="method-row expandable config-row-alt0">
3219 <td class="micon"><a class="exi" href="#expand"> </a></td>
3222 <a id="Roo.Component-event-*hide"></a>
3224 <div class="fixedFont">
3225 <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>)
3231 <div class="short">Fires after the component is hidden.
3237 Fires after the component is hidden.
3243 <dl class="detailList">
3244 <dt class="heading">Parameters:</dt>
3247 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3268 <td class="msource">
3269 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3273 <tr class="method-row expandable config-row-alt1">
3274 <td class="micon"><a class="exi" href="#expand"> </a></td>
3277 <a id="Roo.Component-event-*render"></a>
3279 <div class="fixedFont">
3280 <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>)
3286 <div class="short">Fires after the component is rendered.
3292 Fires after the component is rendered.
3298 <dl class="detailList">
3299 <dt class="heading">Parameters:</dt>
3302 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3323 <td class="msource">
3324 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3328 <tr class="method-row expandable config-row-alt0">
3329 <td class="micon"><a class="exi" href="#expand"> </a></td>
3332 <a id="Roo.Component-event-*show"></a>
3334 <div class="fixedFont">
3335 <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>)
3341 <div class="short">Fires after the component is shown.
3347 Fires after the component is shown.
3353 <dl class="detailList">
3354 <dt class="heading">Parameters:</dt>
3357 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3378 <td class="msource">
3379 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3383 <tr class="method-row expandable config-row-alt1">
3384 <td class="micon"><a class="exi" href="#expand"> </a></td>
3387 <a id="Roo.Editor-event-*specialkey"></a>
3389 <div class="fixedFont">
3390 <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>)
3396 <div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.
3402 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.
3408 <dl class="detailList">
3409 <dt class="heading">Parameters:</dt>
3412 <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>
3418 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3421 <dd>The event object</dd>
3439 <td class="msource">
3440 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
3444 <tr class="method-row expandable config-row-alt0">
3445 <td class="micon"><a class="exi" href="#expand"> </a></td>
3448 <a id="Roo.Editor-event-*startedit"></a>
3450 <div class="fixedFont">
3451 <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>)
3457 <div class="short">Fires when this editor is displayed
3463 Fires when this editor is displayed
3469 <dl class="detailList">
3470 <dt class="heading">Parameters:</dt>
3473 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>boundEl</b>
3476 <dd>The underlying element bound to this editor</dd>
3479 <span class="fixedFont">Mixed</span> <b>value</b>
3482 <dd>The starting field value</dd>
3500 <td class="msource">
3501 <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>
3512 <!-- ============================== footer ================================= -->
3513 <div class="fineprint" style="clear:both">
3515 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Apr 15 2016 17:40:05 GMT+0800 (HKT)
3517 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>