--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=undefined" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+
+ <title>JsDoc Reference - Roo.Editor</title>
+
+
+ <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
+ <link rel="stylesheet" type="text/css" href="../default.css" />
+
+
+ <script type="text/javascript" src="../page.js">
+
+ </script>
+
+
+ </head>
+
+ <body onload="RooDocsPage.onload();">
+
+
+<div class="body-wrap">
+
+ <!-- ============================== links to methods. ================================= -->
+
+ <div class="top-tools">
+ <!--
+ <a class="inner-link" href="#Roo.Editor-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+ <a class="inner-link" href="#Roo.Editor-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+ <a class="inner-link" href="#Roo.Editor-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+ <a class="inner-link" href="#Roo.Editor-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+ <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+ -->
+ </div>
+
+
+<!-- ============================== inheritance Block. ================================= -->
+
+ <div class="inheritance res-block">
+ <pre class="res-block-inner"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
+<img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.Editor
+
+ </pre>
+ </div>
+
+<!-- ============================== class title / details ============================ -->
+
+
+ <h1 class="classTitle">
+
+ Class Roo.Editor
+ </h1>
+
+ <table cellspacing="0" class="class-summary-table">
+
+ <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
+
+ <tr><td class="label">Defined In:</td><td class="hd-info">
+
+ <a href="./src/Roo_Editor.js.html">Roo/Editor.js</a>.
+
+ </td></tr>
+ <tr><td class="label">Class:</td><td class="hd-info">Editor</td></tr>
+
+
+
+
+ <tr><td class="label">Extends:</td><td class="hd-info">
+ <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
+
+ </td></tr>
+
+
+ </table>
+
+
+<!-- ============================== class summary ========================== -->
+ <div class="description">
+ A base editor field that handles displaying/hiding on demand and has some built-in sizing and event handling logic.
+ </div>
+
+
+<!-- ============================== Class comment block... ========================== -->
+
+<div class="comments">
+ <b>Class Comments / Notes</B> =>
+ <u onclick="parent.CommentDialog.showCommentId = 'Roo.Editor';">[Add Your comment/notes about this class]</u>
+ <br/>
+ <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
+ src="/blog.php/GtkDjsComments/Roo.Editor.html"></iframe>
+</div>
+
+
+
+<!-- ============================== config options ========================== -->
+
+
+
+
+ <div class="hr"></div>
+ <a id="Roo.Editor-configs"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Config Options (Usually are also Properties)</caption>
+
+
+ <tr>
+ <th class="sig-header" colspan="2">Options</th>
+
+ <th class="msource-header">Defined By</th>
+ </tr>
+
+
+
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-alignment" name=".alignment"></a>
+ <div class="fixedFont">
+ <b class="itemname">alignment</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The position to align to (see {<b>link</b> Roo.Element<b>alignTo</b>} for more details, defaults to "c-c?").</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-autosize" name=".autosize"></a>
+ <div class="fixedFont">
+ <b class="itemname">autosize</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String
+
+
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">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>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-cancelOnEsc" name=".cancelOnEsc"></a>
+ <div class="fixedFont">
+ <b class="itemname">cancelOnEsc</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to cancel the edit when the escape key is pressed (defaults to false)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">True to cancel the edit when the escape key is pressed (defaults to false)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-completeOnEnter" name=".completeOnEnter"></a>
+ <div class="fixedFont">
+ <b class="itemname">completeOnEnter</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to complete the edit when the enter key is pressed (defaults to false)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">True to complete the edit when the enter key is pressed (defaults to false)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-constrain" name=".constrain"></a>
+ <div class="fixedFont">
+ <b class="itemname">constrain</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to constrain the editor to the viewport</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">True to constrain the editor to the viewport</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-hideEl" name=".hideEl"></a>
+ <div class="fixedFont">
+ <b class="itemname">hideEl</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">False to keep the bound element visible while the editor is displayed (defaults to true)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">False to keep the bound element visible while the editor is displayed (defaults to true)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-ignoreNoChange" name=".ignoreNoChange"></a>
+ <div class="fixedFont">
+ <b class="itemname">ignoreNoChange</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">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.</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-revertInvalid" name=".revertInvalid"></a>
+ <div class="fixedFont">
+ <b class="itemname">revertInvalid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <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>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">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>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-shadow" name=".shadow"></a>
+ <div class="fixedFont">
+ <b class="itemname">shadow</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>/String
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"<br/>for bottom-right shadow (defaults to "frame")</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop"<br/>for bottom-right shadow (defaults to "frame")</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-updateEl" name=".updateEl"></a>
+ <div class="fixedFont">
+ <b class="itemname">updateEl</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">True to update the innerHTML of the bound element when the update completes (defaults to false)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">True to update the innerHTML of the bound element when the update completes (defaults to false)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.Editor-cfg-value" name=".value"></a>
+ <div class="fixedFont">
+ <b class="itemname">value</b> : Mixed
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The data value of the underlying field (defaults to "")</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The data value of the underlying field (defaults to "")</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+
+
+
+
+ <!-- ============================== public properties ==================== -->
+
+
+
+ <a id="Roo.Editor-props"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Public Properties - Has None</caption>
+ </table>
+
+
+
+
+ <!-- ============================== methods summary / details ======================== -->
+
+
+ <a id="Roo.Editor-methods"></a>
+ <!-- constructor?? -->
+
+ <!-- static's first
+
+
+ -->
+
+ <!-- then dynamics first -->
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Public Methods</caption>
+ <tr>
+ <th class="sig-header" colspan="2">Method</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+
+
+
+
+
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo-method-Editor" name=".Editor"></a>
+ <div class="fixedFont">
+ <span class="attributes">new <B>Roo.</B></span><b class="itemname">Editor</b>
+
+ (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>field</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+
+ <div class="short">Create a new Roo.Editor</div>
+
+
+ <div class="long">
+
+
+
+ Create a new Roo.Editor
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> <b>field</b>
+
+ </dt>
+ <dd>The Field object (or descendant)</dd>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>The config object</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Editor-method-cancelEdit" name=".cancelEdit"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">cancelEdit</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>remainVisible</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Cancels the editing process and hides the editor without persisting any changes.</div>
+
+
+
+ <div class="long">
+
+ Cancels the editing process and hides the editor without persisting any changes. The field value will be<br/>reverted to the original starting value.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>Override the default behavior and keep the editor visible after<br/>cancel (defaults to false)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Editor-method-completeEdit" name=".completeEdit"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">completeEdit</b>
+
+ (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>remainVisible</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Ends the editing process, persists the changed value to the underlying field, and hides the editor.</div>
+
+
+
+ <div class="long">
+
+ Ends the editing process, persists the changed value to the underlying field, and hides the editor.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd>Override the default behavior and keep the editor visible after edit (defaults to false)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Editor-method-getValue" name=".getValue"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">getValue</b>
+
+ ()
+
+
+ :
+
+
+ Mixed
+
+
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Gets the data value of the editor</div>
+
+
+
+ <div class="long">
+
+ Gets the data value of the editor
+
+
+
+
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Returns:</dt>
+
+ <dd><span class="fixedFont">Mixed</span> The data value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Editor-method-realign" name=".realign"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">realign</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Realigns the editor to the bound field based on the current alignment config value.</div>
+
+
+
+ <div class="long">
+
+ Realigns the editor to the bound field based on the current alignment config value.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Editor-method-setSize" name=".setSize"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">setSize</b>
+
+ (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Sets the height and width of this editor.</div>
+
+
+
+ <div class="long">
+
+ Sets the height and width of this editor.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>width</b>
+
+ </dt>
+ <dd>The new width</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
+
+ </dt>
+ <dd>The new height</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Editor-method-setValue" name=".setValue"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">setValue</b>
+
+ (Mixed <B><i>value</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Sets the data value of the editor</div>
+
+
+
+ <div class="long">
+
+ Sets the data value of the editor
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>Any valid value supported by the underlying field</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.Editor-method-startEdit" name=".startEdit"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">startEdit</b>
+
+ (<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>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Starts the editing process and shows the editor.</div>
+
+
+
+ <div class="long">
+
+ Starts the editing process and shows the editor.
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
+
+ </dt>
+ <dd>The element to edit</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>value</b>
+
+ </dt>
+ <dd>(optional) A value to initialize the editor with. If a value is not provided, it defaults<br/>to the innerHTML of el.</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.Editor
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+ <!-- ============================== events summary / details ======================== -->
+
+
+ <a id="Roo.Editor-events"></a>
+
+
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Events</caption>
+ <thead>
+ <tr>
+ <th class="sig-header" colspan="2">Event</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+ </thead>
+
+
+
+
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Editor-event-*beforecomplete"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">beforecomplete</b> (Editor <B><i>this</i></B>, Mixed <B><i>value</i></B>, Mixed <B><i>startValue</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires after a change has been made to the field, but before the change is reflected in the underlying<br/>field.
+
+ </div>
+
+ <div class="long">
+
+ 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.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Editor</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>The current field value</dd>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>startValue</b>
+
+ </dt>
+ <dd>The original field value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Editor
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Editor-event-*beforestartedit"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when editing is initiated, but before the value changes.
+
+ </div>
+
+ <div class="long">
+
+ Fires when editing is initiated, but before the value changes. Editing can be canceled by returning<br/>false from the handler of this event.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Editor</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>boundEl</b>
+
+ </dt>
+ <dd>The underlying element bound to this editor</dd>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>The field value being set</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Editor
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Editor-event-*complete"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">complete</b> (Editor <B><i>this</i></B>, Mixed <B><i>value</i></B>, Mixed <B><i>startValue</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires after editing is complete and any changed value has been written to the underlying field.
+
+ </div>
+
+ <div class="long">
+
+ Fires after editing is complete and any changed value has been written to the underlying field.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont">Editor</span> <b>this</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>The current field value</dd>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>startValue</b>
+
+ </dt>
+ <dd>The original field value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Editor
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Editor-event-*specialkey"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when any key related to navigation (arrows, tab, enter, esc, etc.
+
+ </div>
+
+ <div class="long">
+
+ 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.
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <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>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
+
+ </dt>
+ <dd>The event object</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Editor
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.Editor-event-*startedit"></a>
+
+ <div class="fixedFont">
+ <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>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires when this editor is displayed
+
+ </div>
+
+ <div class="long">
+
+ Fires when this editor is displayed
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>boundEl</b>
+
+ </dt>
+ <dd>The underlying element bound to this editor</dd>
+
+ <dt>
+ <span class="fixedFont">Mixed</span> <b>value</b>
+
+ </dt>
+ <dd>The starting field value</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.Editor
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 15:55:22 GMT+0800 (HKT)
+ Based on
+ <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
+ </div>
+ </body>
+</html>
projects / roojs1 / commitdiff