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.form.HtmlEditor</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.form.HtmlEditor-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.form.HtmlEditor-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.form.HtmlEditor-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.form.HtmlEditor-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.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
49 <img src="../../images/default/s.gif" height="1" width="60"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
50 <img src="../../images/default/s.gif" height="1" width="80"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.form.HtmlEditor
55 <!-- ============================== class title / details ============================ -->
58 <h1 class="classTitle">
60 Class Roo.form.HtmlEditor
63 <table cellspacing="0" class="class-summary-table">
65 <tr><td class="label">Package:</td><td class="hd-info">Roo.form</td></tr>
67 <tr><td class="label">Defined In:</td><td class="hd-info">
69 <a href="./src/Roo_form_HtmlEditor.js.html">Roo/form/HtmlEditor.js</a>.
72 <tr><td class="label">Class:</td><td class="hd-info">HtmlEditor</td></tr>
77 <tr><td class="label">Extends:</td><td class="hd-info">
78 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
86 <!-- ============================== class summary ========================== -->
87 <div class="description">
88 Provides a lightweight HTML Editor component.<br/><br/>This has been tested on Fireforx / Chrome.. IE may not be so great..<br/><br/><br><br><b>Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT<br/>supported by this editor.</b><br/><br/><br/>An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within<br/>any element that has display set to 'none' can cause problems in Safari and Firefox.<br/><br/>
92 <!-- ============================== Class comment block... ========================== -->
94 <div class="comments">
95 <b>Class Comments / Notes</B> =>
96 <u onclick="parent.CommentDialog.showCommentId = 'Roo.form.HtmlEditor';">[Add Your comment/notes about this class]</u>
98 <iframe frameborder="0" id="comments-Roo.form" style="border: none;width:100%;"
99 src="/blog.php/GtkDjsComments/Roo.form.HtmlEditor.html"></iframe>
104 <!-- ============================== config options ========================== -->
109 <div class="hr"></div>
110 <a id="Roo.form.HtmlEditor-configs"></a>
116 <table cellspacing="0" class="member-table">
117 <caption>Config Options (Usually are also Properties)</caption>
121 <th class="sig-header" colspan="2">Options</th>
123 <th class="msource-header">Defined By</th>
130 <tr class="config-row expandable config-row-alt0">
131 <td class="micon"><a class="exi" href="#expand"> </a></td>
134 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
135 <div class="fixedFont">
136 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
142 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
147 which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'
157 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
163 <tr class="config-row expandable config-row-alt1">
164 <td class="micon"><a class="exi" href="#expand"> </a></td>
167 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
168 <div class="fixedFont">
169 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
175 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
180 Whether the component can move the Dom node when rendering (defaults to true).
190 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
196 <tr class="config-row expandable config-row-alt0 notInherited">
197 <td class="micon"><a class="exi" href="#expand"> </a></td>
200 <a id="Roo.form.HtmlEditor-cfg-blacklist" name=".blacklist"></a>
201 <div class="fixedFont">
202 <b class="itemname">blacklist</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
208 <div class="short">of css styles style attributes (blacklist overrides whitelist)</div>
213 of css styles style attributes (blacklist overrides whitelist)
229 <tr class="config-row expandable config-row-alt1 notInherited">
230 <td class="micon"><a class="exi" href="#expand"> </a></td>
233 <a id="Roo.form.HtmlEditor-cfg-clearUp" name=".clearUp"></a>
234 <div class="fixedFont">
235 <b class="itemname">clearUp</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
241 <div class="short"></div>
262 <tr class="config-row expandable config-row-alt0">
263 <td class="micon"><a class="exi" href="#expand"> </a></td>
266 <a id="Roo.form.Field-cfg-cls" name=".cls"></a>
267 <div class="fixedFont">
268 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
274 <div class="short">A CSS class to apply to the field's underlying element.</div>
279 A CSS class to apply to the field's underlying element.
289 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
295 <tr class="config-row expandable config-row-alt1">
296 <td class="micon"><a class="exi" href="#expand"> </a></td>
299 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
300 <div class="fixedFont">
301 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
307 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
312 CSS class added to the component when it is disabled (defaults to "x-item-disabled").
322 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
328 <tr class="config-row expandable config-row-alt0">
329 <td class="micon"><a class="exi" href="#expand"> </a></td>
332 <a id="Roo.form.Field-cfg-disabled" name=".disabled"></a>
333 <div class="fixedFont">
334 <b class="itemname">disabled</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
340 <div class="short">True to disable the field (defaults to false).</div>
345 True to disable the field (defaults to false).
355 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
361 <tr class="config-row expandable config-row-alt1">
362 <td class="micon"><a class="exi" href="#expand"> </a></td>
365 <a id="Roo.form.Field-cfg-fieldLabel" name=".fieldLabel"></a>
366 <div class="fixedFont">
367 <b class="itemname">fieldLabel</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
373 <div class="short">Label to use when rendering a form.</div>
378 Label to use when rendering a form.
388 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
394 <tr class="config-row expandable config-row-alt0 notInherited">
395 <td class="micon"><a class="exi" href="#expand"> </a></td>
398 <a id="Roo.form.HtmlEditor-cfg-height" name=".height"></a>
399 <div class="fixedFont">
400 <b class="itemname">height</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
406 <div class="short">(in pixels)</div>
427 <tr class="config-row expandable config-row-alt1">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
432 <div class="fixedFont">
433 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
439 <div class="short">How this component should hidden.</div>
444 How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".
445 <BR/>Possible Values: display, visibility
454 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
460 <tr class="config-row expandable config-row-alt0">
461 <td class="micon"><a class="exi" href="#expand"> </a></td>
464 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
465 <div class="fixedFont">
466 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
472 <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>
477 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>
487 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
493 <tr class="config-row expandable config-row-alt1">
494 <td class="micon"><a class="exi" href="#expand"> </a></td>
497 <a id="Roo.form.Field-cfg-msgTarget" name=".msgTarget"></a>
498 <div class="fixedFont">
499 <b class="itemname">msgTarget</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
505 <div class="short">The location where error text should display.</div>
510 The location where error text should display. Should be one of the following values (defaults to 'qtip'):<br/><pre><br/>Value Description<br/>----------- ----------------------------------------------------------------------<br/>qtip Display a quick tip when the user hovers over the field<br/>title Display a default browser title attribute popup<br/>under Add a block div beneath the field containing the error text<br/>side Add an error icon to the right of the field with a popup on hover<br/>[element id] Add the error text directly to the innerHTML of the specified element<br/></pre>
520 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
526 <tr class="config-row expandable config-row-alt0">
527 <td class="micon"><a class="exi" href="#expand"> </a></td>
530 <a id="Roo.form.Field-cfg-name" name=".name"></a>
531 <div class="fixedFont">
532 <b class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
538 <div class="short">The field's HTML name attribute.</div>
543 The field's HTML name attribute.
553 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
559 <tr class="config-row expandable config-row-alt1">
560 <td class="micon"><a class="exi" href="#expand"> </a></td>
563 <a id="Roo.form.Field-cfg-qtip" name=".qtip"></a>
564 <div class="fixedFont">
565 <b class="itemname">qtip</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
571 <div class="short">Mouse over tip</div>
586 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
592 <tr class="config-row expandable config-row-alt0">
593 <td class="micon"><a class="exi" href="#expand"> </a></td>
596 <a id="Roo.form.Field-cfg-readOnly" name=".readOnly"></a>
597 <div class="fixedFont">
598 <b class="itemname">readOnly</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
604 <div class="short">True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.</div>
609 True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
619 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
625 <tr class="config-row expandable config-row-alt1 notInherited">
626 <td class="micon"><a class="exi" href="#expand"> </a></td>
629 <a id="Roo.form.HtmlEditor-cfg-resizable" name=".resizable"></a>
630 <div class="fixedFont">
631 <b class="itemname">resizable</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
637 <div class="short">'s' or 'se' or 'e' - wrapps the element in a<br/> Roo.resizable.</div>
642 's' or 'se' or 'e' - wrapps the element in a<br/> Roo.resizable.
658 <tr class="config-row expandable config-row-alt0 notInherited">
659 <td class="micon"><a class="exi" href="#expand"> </a></td>
662 <a id="Roo.form.HtmlEditor-cfg-stylesheets" name=".stylesheets"></a>
663 <div class="fixedFont">
664 <b class="itemname">stylesheets</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
670 <div class="short">url of stylesheets.</div>
675 url of stylesheets. set to [] to disable stylesheets.
691 <tr class="config-row expandable config-row-alt1">
692 <td class="micon"><a class="exi" href="#expand"> </a></td>
695 <a id="Roo.form.Field-cfg-tabIndex" name=".tabIndex"></a>
696 <div class="fixedFont">
697 <b class="itemname">tabIndex</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
703 <div class="short">The tabIndex for this field.</div>
708 The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
718 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
724 <tr class="config-row expandable config-row-alt0 notInherited">
725 <td class="micon"><a class="exi" href="#expand"> </a></td>
728 <a id="Roo.form.HtmlEditor-cfg-toolbars" name=".toolbars"></a>
729 <div class="fixedFont">
730 <b class="itemname">toolbars</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
736 <div class="short">Array of toolbars.</div>
741 Array of toolbars. - defaults to just the Standard one
757 <tr class="config-row expandable config-row-alt1">
758 <td class="micon"><a class="exi" href="#expand"> </a></td>
761 <a id="Roo.form.Field-cfg-validationDelay" name=".validationDelay"></a>
762 <div class="fixedFont">
763 <b class="itemname">validationDelay</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
769 <div class="short">The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)</div>
774 The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
784 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
790 <tr class="config-row expandable config-row-alt0">
791 <td class="micon"><a class="exi" href="#expand"> </a></td>
794 <a id="Roo.form.Field-cfg-validationEvent" name=".validationEvent"></a>
795 <div class="fixedFont">
796 <b class="itemname">validationEvent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Boolean
802 <div class="short">The event that should initiate field validation.</div>
807 The event that should initiate field validation. Set to false to disable<br/> automatic validation (defaults to "keyup").
817 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
823 <tr class="config-row expandable config-row-alt1">
824 <td class="micon"><a class="exi" href="#expand"> </a></td>
827 <a id="Roo.form.Field-cfg-value" name=".value"></a>
828 <div class="fixedFont">
829 <b class="itemname">value</b> : Mixed
835 <div class="short">A value to initialize this field with.</div>
840 A value to initialize this field with.
850 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
856 <tr class="config-row expandable config-row-alt0 notInherited">
857 <td class="micon"><a class="exi" href="#expand"> </a></td>
860 <a id="Roo.form.HtmlEditor-cfg-whitelist" name=".whitelist"></a>
861 <div class="fixedFont">
862 <b class="itemname">whitelist</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
868 <div class="short">of css styles style attributes (blacklist overrides whitelist)</div>
873 of css styles style attributes (blacklist overrides whitelist)
889 <tr class="config-row expandable config-row-alt1 notInherited">
890 <td class="micon"><a class="exi" href="#expand"> </a></td>
893 <a id="Roo.form.HtmlEditor-cfg-width" name=".width"></a>
894 <div class="fixedFont">
895 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
901 <div class="short">(in pixels)</div>
932 <!-- ============================== public properties ==================== -->
936 <a id="Roo.form.HtmlEditor-props"></a>
942 <table cellspacing="0" class="member-table">
943 <caption class="Empty">Public Properties - Has None</caption>
949 <!-- ============================== methods summary / details ======================== -->
952 <a id="Roo.form.HtmlEditor-methods"></a>
953 <!-- constructor?? -->
960 <!-- then dynamics first -->
967 <table cellspacing="0" class="member-table">
968 <caption>Public Methods</caption>
970 <th class="sig-header" colspan="2">Method</th>
971 <th class="msource-header">Defined By</th>
981 <tr class="method-row config-row-alt0 notInherited">
982 <td class="micon"><a class="exi" href="#expand"> </a></td>
986 <a id="Roo.form-method-HtmlEditor" name=".HtmlEditor"></a>
987 <div class="fixedFont">
988 <span class="attributes">new <B>Roo.form.</B></span><b class="itemname">HtmlEditor</b>
998 <div class="short">Create a new Roo.form.HtmlEditor</div>
1005 Create a new Roo.form.HtmlEditor
1022 <td class="msource">
1028 <tr class="method-row config-row-alt1 expandable">
1029 <td class="micon"><a class="exi" href="#expand"> </a></td>
1033 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1034 <div class="fixedFont">
1035 <span class="attributes"></span><b class="itemname">addEvents</b>
1037 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1044 <div class="short">Used to define events on this Observable</div>
1050 Used to define events on this Observable
1057 <dl class="detailList">
1058 <dt class="heading">Parameters:</dt>
1061 <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>
1064 <dd>The object with the events defined</dd>
1082 <td class="msource">
1084 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1090 <tr class="method-row config-row-alt0 expandable">
1091 <td class="micon"><a class="exi" href="#expand"> </a></td>
1095 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1096 <div class="fixedFont">
1097 <span class="attributes"></span><b class="itemname">addListener</b>
1099 (<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>)
1106 <div class="short">Appends an event handler to this component</div>
1112 Appends an event handler to this component
1119 <dl class="detailList">
1120 <dt class="heading">Parameters:</dt>
1123 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1126 <dd>The type of event to listen for</dd>
1129 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1132 <dd>The method the event invokes</dd>
1135 <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>
1138 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1141 <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>
1144 <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>
1162 <td class="msource">
1164 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1170 <tr class="method-row config-row-alt1 expandable">
1171 <td class="micon"><a class="exi" href="#expand"> </a></td>
1175 <a id="Roo.form.Field-method-applyTo" name=".applyTo"></a>
1176 <div class="fixedFont">
1177 <span class="attributes"></span><b class="itemname">applyTo</b>
1179 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>)
1185 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1194 <div class="short">Apply the behaviors of this component to an existing element.</div>
1200 Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>
1207 <dl class="detailList">
1208 <dt class="heading">Parameters:</dt>
1211 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>el</b>
1214 <dd>The id of the node, a DOM node or an existing Element</dd>
1222 <dl class="detailList">
1223 <dt class="heading">Returns:</dt>
1225 <dd><span class="fixedFont"><a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a></span> this</dd>
1239 <td class="msource">
1241 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1247 <tr class="method-row config-row-alt0 expandable notInherited">
1248 <td class="micon"><a class="exi" href="#expand"> </a></td>
1252 <a id="Roo.form.HtmlEditor-method-createToolbar" name=".createToolbar"></a>
1253 <div class="fixedFont">
1254 <span class="attributes"></span><b class="itemname">createToolbar</b>
1256 (HtmlEditor <B><i>editor</i></B>)
1263 <div class="short">Protected method that will not generally be called directly.</div>
1269 Protected method that will not generally be called directly. It<br/>is called when the editor creates its toolbar. Override this method if you need to<br/>add custom toolbar buttons.
1276 <dl class="detailList">
1277 <dt class="heading">Parameters:</dt>
1280 <span class="fixedFont">HtmlEditor</span> <b>editor</b>
1301 <td class="msource">
1309 <tr class="method-row config-row-alt1 expandable">
1310 <td class="micon"><a class="exi" href="#expand"> </a></td>
1314 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1315 <div class="fixedFont">
1316 <span class="attributes"></span><b class="itemname">destroy</b>
1325 <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>
1331 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}.
1352 <td class="msource">
1354 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1360 <tr class="method-row config-row-alt0 expandable">
1361 <td class="micon"><a class="exi" href="#expand"> </a></td>
1365 <a id="Roo.Component-method-disable" name=".disable"></a>
1366 <div class="fixedFont">
1367 <span class="attributes"></span><b class="itemname">disable</b>
1375 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1384 <div class="short">Disable this component.</div>
1390 Disable this component.
1401 <dl class="detailList">
1402 <dt class="heading">Returns:</dt>
1404 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1418 <td class="msource">
1420 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1426 <tr class="method-row config-row-alt1 expandable">
1427 <td class="micon"><a class="exi" href="#expand"> </a></td>
1431 <a id="Roo.Component-method-enable" name=".enable"></a>
1432 <div class="fixedFont">
1433 <span class="attributes"></span><b class="itemname">enable</b>
1441 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1450 <div class="short">Enable this component.</div>
1456 Enable this component.
1467 <dl class="detailList">
1468 <dt class="heading">Returns:</dt>
1470 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1484 <td class="msource">
1486 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1492 <tr class="method-row config-row-alt0 expandable">
1493 <td class="micon"><a class="exi" href="#expand"> </a></td>
1497 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1498 <div class="fixedFont">
1499 <span class="attributes"></span><b class="itemname">fireEvent</b>
1501 (<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>)
1507 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1516 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1522 Fires the specified event with the passed parameters (minus the event name).
1529 <dl class="detailList">
1530 <dt class="heading">Parameters:</dt>
1533 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1539 <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>
1542 <dd>Variable number of parameters are passed to handlers</dd>
1550 <dl class="detailList">
1551 <dt class="heading">Returns:</dt>
1553 <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>
1567 <td class="msource">
1569 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1575 <tr class="method-row config-row-alt1 expandable">
1576 <td class="micon"><a class="exi" href="#expand"> </a></td>
1580 <a id="Roo.Component-method-focus" name=".focus"></a>
1581 <div class="fixedFont">
1582 <span class="attributes"></span><b class="itemname">focus</b>
1584 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1590 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1599 <div class="short">Try to focus this component.</div>
1605 Try to focus this component.
1612 <dl class="detailList">
1613 <dt class="heading">Parameters:</dt>
1616 <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>
1619 <dd>True to also select the text in this component (if applicable)</dd>
1627 <dl class="detailList">
1628 <dt class="heading">Returns:</dt>
1630 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1644 <td class="msource">
1646 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1652 <tr class="method-row config-row-alt0 expandable">
1653 <td class="micon"><a class="exi" href="#expand"> </a></td>
1657 <a id="Roo.BoxComponent-method-getBox" name=".getBox"></a>
1658 <div class="fixedFont">
1659 <span class="attributes"></span><b class="itemname">getBox</b>
1661 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1668 <div class="short">Gets the current box measurements of the component's underlying element.</div>
1674 Gets the current box measurements of the component's underlying element.
1681 <dl class="detailList">
1682 <dt class="heading">Parameters:</dt>
1685 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>local</b>
1688 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1706 <td class="msource">
1708 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
1714 <tr class="method-row config-row-alt1 expandable">
1715 <td class="micon"><a class="exi" href="#expand"> </a></td>
1719 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1720 <div class="fixedFont">
1721 <span class="attributes"></span><b class="itemname">getEl</b>
1729 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1738 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1744 Returns the underlying {<b>link</b> Roo.Element}.
1755 <dl class="detailList">
1756 <dt class="heading">Returns:</dt>
1758 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1772 <td class="msource">
1774 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1780 <tr class="method-row config-row-alt0 expandable">
1781 <td class="micon"><a class="exi" href="#expand"> </a></td>
1785 <a id="Roo.Component-method-getId" name=".getId"></a>
1786 <div class="fixedFont">
1787 <span class="attributes"></span><b class="itemname">getId</b>
1795 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1804 <div class="short">Returns the id of this component.</div>
1810 Returns the id of this component.
1821 <dl class="detailList">
1822 <dt class="heading">Returns:</dt>
1824 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1838 <td class="msource">
1840 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1846 <tr class="method-row config-row-alt1 expandable">
1847 <td class="micon"><a class="exi" href="#expand"> </a></td>
1851 <a id="Roo.form.Field-method-getName" name=".getName"></a>
1852 <div class="fixedFont">
1853 <span class="attributes"></span><b class="itemname">getName</b>
1861 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1870 <div class="short">Returns the name attribute of the field if available</div>
1876 Returns the name attribute of the field if available
1887 <dl class="detailList">
1888 <dt class="heading">Returns:</dt>
1890 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> name The field name</dd>
1904 <td class="msource">
1906 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
1912 <tr class="method-row config-row-alt0 expandable">
1913 <td class="micon"><a class="exi" href="#expand"> </a></td>
1917 <a id="Roo.BoxComponent-method-getPosition" name=".getPosition"></a>
1918 <div class="fixedFont">
1919 <span class="attributes"></span><b class="itemname">getPosition</b>
1921 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>local</i></B>)
1927 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
1936 <div class="short">Gets the current XY position of the component's underlying element.</div>
1942 Gets the current XY position of the component's underlying element.
1949 <dl class="detailList">
1950 <dt class="heading">Parameters:</dt>
1953 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>local</b>
1956 <dd>(optional) If true the element's left and top are returned instead of page XY (defaults to false)</dd>
1964 <dl class="detailList">
1965 <dt class="heading">Returns:</dt>
1967 <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> The XY position of the element (e.g., [100, 200])</dd>
1981 <td class="msource">
1983 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
1989 <tr class="method-row config-row-alt1 expandable">
1990 <td class="micon"><a class="exi" href="#expand"> </a></td>
1994 <a id="Roo.form.Field-method-getRawValue" name=".getRawValue"></a>
1995 <div class="fixedFont">
1996 <span class="attributes"></span><b class="itemname">getRawValue</b>
2013 <div class="short">Returns the raw data value which may or may not be a valid, defined value.</div>
2019 Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {<b>link</b> <b>getValue</b>}.
2030 <dl class="detailList">
2031 <dt class="heading">Returns:</dt>
2033 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2047 <td class="msource">
2049 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2055 <tr class="method-row config-row-alt0 expandable">
2056 <td class="micon"><a class="exi" href="#expand"> </a></td>
2060 <a id="Roo.BoxComponent-method-getSize" name=".getSize"></a>
2061 <div class="fixedFont">
2062 <span class="attributes"></span><b class="itemname">getSize</b>
2070 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
2079 <div class="short">Gets the current size of the component's underlying element.</div>
2085 Gets the current size of the component's underlying element.
2096 <dl class="detailList">
2097 <dt class="heading">Returns:</dt>
2099 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> An object containing the element's size {width: (element width), height: (element height)}</dd>
2113 <td class="msource">
2115 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2121 <tr class="method-row config-row-alt1 expandable">
2122 <td class="micon"><a class="exi" href="#expand"> </a></td>
2126 <a id="Roo.form.Field-method-getValue" name=".getValue"></a>
2127 <div class="fixedFont">
2128 <span class="attributes"></span><b class="itemname">getValue</b>
2145 <div class="short">Returns the normalized data value (undefined or emptyText will be returned as '').</div>
2151 Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {<b>link</b> <b>getRawValue</b>}.
2162 <dl class="detailList">
2163 <dt class="heading">Returns:</dt>
2165 <dd><span class="fixedFont">Mixed</span> value The field value</dd>
2179 <td class="msource">
2181 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2187 <tr class="method-row config-row-alt0 expandable">
2188 <td class="micon"><a class="exi" href="#expand"> </a></td>
2192 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
2193 <div class="fixedFont">
2194 <span class="attributes"></span><b class="itemname">hasListener</b>
2196 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
2202 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2211 <div class="short">Checks to see if this object has any listeners for a specified event</div>
2217 Checks to see if this object has any listeners for a specified event
2224 <dl class="detailList">
2225 <dt class="heading">Parameters:</dt>
2228 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2231 <dd>The name of the event to check for</dd>
2239 <dl class="detailList">
2240 <dt class="heading">Returns:</dt>
2242 <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>
2256 <td class="msource">
2258 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</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-hide" name=".hide"></a>
2270 <div class="fixedFont">
2271 <span class="attributes"></span><b class="itemname">hide</b>
2279 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2288 <div class="short">Hide this component.</div>
2294 Hide this component.
2305 <dl class="detailList">
2306 <dt class="heading">Returns:</dt>
2308 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2322 <td class="msource">
2324 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2330 <tr class="method-row config-row-alt0 expandable">
2331 <td class="micon"><a class="exi" href="#expand"> </a></td>
2335 <a id="Roo.form.Field-method-isDirty" name=".isDirty"></a>
2336 <div class="fixedFont">
2337 <span class="attributes"></span><b class="itemname">isDirty</b>
2346 <div class="short">Returns true if this field has been changed since it was originally loaded and is not disabled.</div>
2352 Returns true if this field has been changed since it was originally loaded and is not disabled.
2373 <td class="msource">
2375 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2381 <tr class="method-row config-row-alt1 expandable">
2382 <td class="micon"><a class="exi" href="#expand"> </a></td>
2386 <a id="Roo.form.Field-method-isValid" name=".isValid"></a>
2387 <div class="fixedFont">
2388 <span class="attributes"></span><b class="itemname">isValid</b>
2390 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>preventMark</i></B>)
2396 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2405 <div class="short">Returns whether or not the field value is currently valid</div>
2411 Returns whether or not the field value is currently valid
2418 <dl class="detailList">
2419 <dt class="heading">Parameters:</dt>
2422 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>preventMark</b>
2425 <dd>True to disable marking the field invalid</dd>
2433 <dl class="detailList">
2434 <dt class="heading">Returns:</dt>
2436 <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 value is valid, else false</dd>
2450 <td class="msource">
2452 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2458 <tr class="method-row config-row-alt0 expandable">
2459 <td class="micon"><a class="exi" href="#expand"> </a></td>
2463 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
2464 <div class="fixedFont">
2465 <span class="attributes"></span><b class="itemname">isVisible</b>
2474 <div class="short">Returns true if this component is visible.</div>
2480 Returns true if this component is visible.
2501 <td class="msource">
2503 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2509 <tr class="method-row config-row-alt1 expandable">
2510 <td class="micon"><a class="exi" href="#expand"> </a></td>
2514 <a id="Roo.util.Observable-method-on" name=".on"></a>
2515 <div class="fixedFont">
2516 <span class="attributes"></span><b class="itemname">on</b>
2518 (<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>)
2525 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2531 Appends an event handler to this element (shorthand for addListener)
2538 <dl class="detailList">
2539 <dt class="heading">Parameters:</dt>
2542 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2545 <dd>The type of event to listen for</dd>
2548 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2551 <dd>The method the event invokes</dd>
2554 <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>
2557 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2560 <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>
2581 <td class="msource">
2583 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2589 <tr class="method-row config-row-alt0 expandable">
2590 <td class="micon"><a class="exi" href="#expand"> </a></td>
2594 <a id="Roo.BoxComponent-method-onPosition" name=".onPosition"></a>
2595 <div class="fixedFont">
2596 <span class="attributes"></span><b class="itemname">onPosition</b>
2598 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
2605 <div class="short">Called after the component is moved, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a move occurs.</div>
2611 Called after the component is moved, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a move occurs.
2618 <dl class="detailList">
2619 <dt class="heading">Parameters:</dt>
2622 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
2625 <dd>The new x position</dd>
2628 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
2631 <dd>The new y position</dd>
2649 <td class="msource">
2651 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2657 <tr class="method-row config-row-alt1 expandable">
2658 <td class="micon"><a class="exi" href="#expand"> </a></td>
2662 <a id="Roo.BoxComponent-method-onResize" name=".onResize"></a>
2663 <div class="fixedFont">
2664 <span class="attributes"></span><b class="itemname">onResize</b>
2666 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjHeight</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawHeight</i></B>)
2673 <div class="short">Called after the component is resized, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a resize occurs.</div>
2679 Called after the component is resized, this method is empty by default but can be implemented by any<br/>subclass that needs to perform custom logic after a resize occurs.
2686 <dl class="detailList">
2687 <dt class="heading">Parameters:</dt>
2690 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
2693 <dd>The box-adjusted width that was set</dd>
2696 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
2699 <dd>The box-adjusted height that was set</dd>
2702 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
2705 <dd>The width that was originally specified</dd>
2708 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
2711 <dd>The height that was originally specified</dd>
2729 <td class="msource">
2731 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
2737 <tr class="method-row config-row-alt0 expandable">
2738 <td class="micon"><a class="exi" href="#expand"> </a></td>
2742 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2743 <div class="fixedFont">
2744 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2753 <div class="short">Removes all listeners for this object</div>
2759 Removes all listeners for this object
2780 <td class="msource">
2782 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2788 <tr class="method-row config-row-alt1 expandable">
2789 <td class="micon"><a class="exi" href="#expand"> </a></td>
2793 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2794 <div class="fixedFont">
2795 <span class="attributes"></span><b class="itemname">removeListener</b>
2797 (<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>)
2804 <div class="short">Removes a listener</div>
2817 <dl class="detailList">
2818 <dt class="heading">Parameters:</dt>
2821 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2824 <dd>The type of event to listen for</dd>
2827 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2830 <dd>The handler to remove</dd>
2833 <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>
2836 <dd>(optional) The scope (this object) for the handler</dd>
2854 <td class="msource">
2856 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2862 <tr class="method-row config-row-alt0 expandable">
2863 <td class="micon"><a class="exi" href="#expand"> </a></td>
2867 <a id="Roo.Component-method-render" name=".render"></a>
2868 <div class="fixedFont">
2869 <span class="attributes"></span><b class="itemname">render</b>
2871 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
2878 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
2884 If this is a lazy rendering component, render it to its container element.
2891 <dl class="detailList">
2892 <dt class="heading">Parameters:</dt>
2895 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
2898 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
2916 <td class="msource">
2918 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2924 <tr class="method-row config-row-alt1 expandable">
2925 <td class="micon"><a class="exi" href="#expand"> </a></td>
2929 <a id="Roo.form.Field-method-reset" name=".reset"></a>
2930 <div class="fixedFont">
2931 <span class="attributes"></span><b class="itemname">reset</b>
2940 <div class="short">Resets the current field value to the originally loaded value and clears any validation messages</div>
2946 Resets the current field value to the originally loaded value and clears any validation messages
2967 <td class="msource">
2969 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
2975 <tr class="method-row config-row-alt0 expandable">
2976 <td class="micon"><a class="exi" href="#expand"> </a></td>
2980 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
2981 <div class="fixedFont">
2982 <span class="attributes"></span><b class="itemname">setDisabled</b>
2984 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
2991 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
2997 Convenience function for setting disabled/enabled by boolean.
3004 <dl class="detailList">
3005 <dt class="heading">Parameters:</dt>
3008 <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>
3029 <td class="msource">
3031 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3037 <tr class="method-row config-row-alt1 expandable">
3038 <td class="micon"><a class="exi" href="#expand"> </a></td>
3042 <a id="Roo.BoxComponent-method-setPagePosition" name=".setPagePosition"></a>
3043 <div class="fixedFont">
3044 <span class="attributes"></span><b class="itemname">setPagePosition</b>
3046 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
3053 <div class="short">Sets the page XY position of the component.</div>
3059 Sets the page XY position of the component. To set the left and top instead, use {<b>link</b> <b>setPosition</b>}.<br/>This method fires the move event.
3066 <dl class="detailList">
3067 <dt class="heading">Parameters:</dt>
3070 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
3073 <dd>The new x position</dd>
3076 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
3079 <dd>The new y position</dd>
3097 <td class="msource">
3099 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3105 <tr class="method-row config-row-alt0 expandable">
3106 <td class="micon"><a class="exi" href="#expand"> </a></td>
3110 <a id="Roo.BoxComponent-method-setPosition" name=".setPosition"></a>
3111 <div class="fixedFont">
3112 <span class="attributes"></span><b class="itemname">setPosition</b>
3114 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>left</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>top</i></B>)
3121 <div class="short">Sets the left and top of the component.</div>
3127 Sets the left and top of the component. To set the page XY position instead, use {<b>link</b> <b>setPagePosition</b>}.<br/>This method fires the move event.
3134 <dl class="detailList">
3135 <dt class="heading">Parameters:</dt>
3138 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>left</b>
3141 <dd>The new left</dd>
3144 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>top</b>
3147 <dd>The new top</dd>
3165 <td class="msource">
3167 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3173 <tr class="method-row config-row-alt1 expandable">
3174 <td class="micon"><a class="exi" href="#expand"> </a></td>
3178 <a id="Roo.form.Field-method-setRawValue" name=".setRawValue"></a>
3179 <div class="fixedFont">
3180 <span class="attributes"></span><b class="itemname">setRawValue</b>
3182 (Mixed <B><i>value</i></B>)
3189 <div class="short">Sets the underlying DOM field's value directly, bypassing validation.</div>
3195 Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {<b>link</b> <b>setValue</b>}.
3202 <dl class="detailList">
3203 <dt class="heading">Parameters:</dt>
3206 <span class="fixedFont">Mixed</span> <b>value</b>
3209 <dd>The value to set</dd>
3227 <td class="msource">
3229 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3235 <tr class="method-row config-row-alt0 expandable">
3236 <td class="micon"><a class="exi" href="#expand"> </a></td>
3240 <a id="Roo.BoxComponent-method-setSize" name=".setSize"></a>
3241 <div class="fixedFont">
3242 <span class="attributes"></span><b class="itemname">setSize</b>
3244 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object <B><i>width</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>height</i></B>)
3250 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3259 <div class="short">Sets the width and height of the component.</div>
3265 Sets the width and height of the component. This method fires the resize event. This method can accept<br/>either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.
3272 <dl class="detailList">
3273 <dt class="heading">Parameters:</dt>
3276 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>/Object</span> <b>width</b>
3279 <dd>The new width to set, or a size object in the format {width, height}</dd>
3282 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>height</b>
3285 <dd>The new height to set (not required if a size object is passed as the first arg)</dd>
3293 <dl class="detailList">
3294 <dt class="heading">Returns:</dt>
3296 <dd><span class="fixedFont"><a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a></span> this</dd>
3310 <td class="msource">
3312 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3318 <tr class="method-row config-row-alt1 expandable">
3319 <td class="micon"><a class="exi" href="#expand"> </a></td>
3323 <a id="Roo.form.Field-method-setValue" name=".setValue"></a>
3324 <div class="fixedFont">
3325 <span class="attributes"></span><b class="itemname">setValue</b>
3327 (Mixed <B><i>value</i></B>)
3334 <div class="short">Sets a data value into the field and validates it.</div>
3340 Sets a data value into the field and validates it. To set the value directly without validation see {<b>link</b> <b>setRawValue</b>}.
3347 <dl class="detailList">
3348 <dt class="heading">Parameters:</dt>
3351 <span class="fixedFont">Mixed</span> <b>value</b>
3354 <dd>The value to set</dd>
3372 <td class="msource">
3374 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3380 <tr class="method-row config-row-alt0 expandable">
3381 <td class="micon"><a class="exi" href="#expand"> </a></td>
3385 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
3386 <div class="fixedFont">
3387 <span class="attributes"></span><b class="itemname">setVisible</b>
3389 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
3395 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3404 <div class="short">Convenience function to hide or show this component by boolean.</div>
3410 Convenience function to hide or show this component by boolean.
3417 <dl class="detailList">
3418 <dt class="heading">Parameters:</dt>
3421 <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>
3424 <dd>True to show, false to hide</dd>
3432 <dl class="detailList">
3433 <dt class="heading">Returns:</dt>
3435 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3449 <td class="msource">
3451 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3457 <tr class="method-row config-row-alt1 expandable">
3458 <td class="micon"><a class="exi" href="#expand"> </a></td>
3462 <a id="Roo.Component-method-show" name=".show"></a>
3463 <div class="fixedFont">
3464 <span class="attributes"></span><b class="itemname">show</b>
3472 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3481 <div class="short">Show this component.</div>
3487 Show this component.
3498 <dl class="detailList">
3499 <dt class="heading">Returns:</dt>
3501 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
3515 <td class="msource">
3517 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3523 <tr class="method-row config-row-alt0 expandable">
3524 <td class="micon"><a class="exi" href="#expand"> </a></td>
3528 <a id="Roo.BoxComponent-method-syncSize" name=".syncSize"></a>
3529 <div class="fixedFont">
3530 <span class="attributes"></span><b class="itemname">syncSize</b>
3539 <div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div>
3545 Force the component's size to recalculate based on the underlying element's current height and width.
3566 <td class="msource">
3568 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3574 <tr class="method-row config-row-alt1 expandable notInherited">
3575 <td class="micon"><a class="exi" href="#expand"> </a></td>
3579 <a id="Roo.form.HtmlEditor-method-toggleSourceEdit" name=".toggleSourceEdit"></a>
3580 <div class="fixedFont">
3581 <span class="attributes"></span><b class="itemname">toggleSourceEdit</b>
3583 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>sourceEdit</i></B>)
3590 <div class="short">Toggles the editor between standard and source edit mode.</div>
3596 Toggles the editor between standard and source edit mode.
3603 <dl class="detailList">
3604 <dt class="heading">Parameters:</dt>
3607 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>sourceEdit</b>
3610 <dd>(optional) True for source edit, false for standard</dd>
3628 <td class="msource">
3636 <tr class="method-row config-row-alt0 expandable">
3637 <td class="micon"><a class="exi" href="#expand"> </a></td>
3641 <a id="Roo.util.Observable-method-un" name=".un"></a>
3642 <div class="fixedFont">
3643 <span class="attributes"></span><b class="itemname">un</b>
3645 (<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>)
3652 <div class="short">Removes a listener (shorthand for removeListener)</div>
3658 Removes a listener (shorthand for removeListener)
3665 <dl class="detailList">
3666 <dt class="heading">Parameters:</dt>
3669 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
3672 <dd>The type of event to listen for</dd>
3675 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
3678 <dd>The handler to remove</dd>
3681 <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>
3684 <dd>(optional) The scope (this object) for the handler</dd>
3702 <td class="msource">
3704 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3710 <tr class="method-row config-row-alt1 expandable">
3711 <td class="micon"><a class="exi" href="#expand"> </a></td>
3715 <a id="Roo.BoxComponent-method-updateBox" name=".updateBox"></a>
3716 <div class="fixedFont">
3717 <span class="attributes"></span><b class="itemname">updateBox</b>
3719 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>box</i></B>)
3726 <div class="short">Sets the current box measurements of the component's underlying element.</div>
3732 Sets the current box measurements of the component's underlying element.
3739 <dl class="detailList">
3740 <dt class="heading">Parameters:</dt>
3743 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>box</b>
3746 <dd>An object in the format {x, y, width, height}</dd>
3764 <td class="msource">
3766 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
3772 <tr class="method-row config-row-alt0 expandable">
3773 <td class="micon"><a class="exi" href="#expand"> </a></td>
3777 <a id="Roo.form.Field-method-validate" name=".validate"></a>
3778 <div class="fixedFont">
3779 <span class="attributes"></span><b class="itemname">validate</b>
3787 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
3796 <div class="short">Validates the field value</div>
3802 Validates the field value
3813 <dl class="detailList">
3814 <dt class="heading">Returns:</dt>
3816 <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 value is valid, else false</dd>
3830 <td class="msource">
3832 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
3841 <!-- ============================== events summary / details ======================== -->
3844 <a id="Roo.form.HtmlEditor-events"></a>
3853 <table cellspacing="0" class="member-table">
3854 <caption>Events</caption>
3857 <th class="sig-header" colspan="2">Event</th>
3858 <th class="msource-header">Defined By</th>
3867 <tr class="method-row expandable config-row-alt0 notInherited">
3868 <td class="micon"><a class="exi" href="#expand"> </a></td>
3871 <a id="Roo.form.HtmlEditor-event-*activate"></a>
3873 <div class="fixedFont">
3874 <b class="itemname">activate</b> (HtmlEditor <B><i>this</i></B>)
3880 <div class="short">Fires when the editor is first receives the focus.
3886 Fires when the editor is first receives the focus. Any insertion must wait<br/>until after this event.
3892 <dl class="detailList">
3893 <dt class="heading">Parameters:</dt>
3896 <span class="fixedFont">HtmlEditor</span> <b>this</b>
3917 <td class="msource">
3922 <tr class="method-row expandable config-row-alt1 notInherited">
3923 <td class="micon"><a class="exi" href="#expand"> </a></td>
3926 <a id="Roo.form.HtmlEditor-event-*autosave"></a>
3928 <div class="fixedFont">
3929 <b class="itemname">autosave</b> (HtmlEditor <B><i>this</i></B>)
3935 <div class="short">Auto save the htmlEditor value as a file into Events
3941 Auto save the htmlEditor value as a file into Events
3947 <dl class="detailList">
3948 <dt class="heading">Parameters:</dt>
3951 <span class="fixedFont">HtmlEditor</span> <b>this</b>
3972 <td class="msource">
3977 <tr class="method-row expandable config-row-alt0">
3978 <td class="micon"><a class="exi" href="#expand"> </a></td>
3981 <a id="Roo.Component-event-*beforedestroy"></a>
3983 <div class="fixedFont">
3984 <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>)
3990 <div class="short">Fires before the component is destroyed.
3996 Fires before the component is destroyed. Return false to stop the destroy.
4002 <dl class="detailList">
4003 <dt class="heading">Parameters:</dt>
4006 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4027 <td class="msource">
4028 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4032 <tr class="method-row expandable config-row-alt1">
4033 <td class="micon"><a class="exi" href="#expand"> </a></td>
4036 <a id="Roo.Component-event-*beforehide"></a>
4038 <div class="fixedFont">
4039 <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>)
4045 <div class="short">Fires before the component is hidden.
4051 Fires before the component is hidden. Return false to stop the hide.
4057 <dl class="detailList">
4058 <dt class="heading">Parameters:</dt>
4061 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4082 <td class="msource">
4083 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4087 <tr class="method-row expandable config-row-alt0 notInherited">
4088 <td class="micon"><a class="exi" href="#expand"> </a></td>
4091 <a id="Roo.form.HtmlEditor-event-*beforepush"></a>
4093 <div class="fixedFont">
4094 <b class="itemname">beforepush</b> (HtmlEditor <B><i>this</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>html</i></B>)
4100 <div class="short">Fires before the iframe editor is updated with content from the textarea.
4106 Fires before the iframe editor is updated with content from the textarea. Return false<br/>to cancel the push.
4112 <dl class="detailList">
4113 <dt class="heading">Parameters:</dt>
4116 <span class="fixedFont">HtmlEditor</span> <b>this</b>
4122 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>html</b>
4143 <td class="msource">
4148 <tr class="method-row expandable config-row-alt1">
4149 <td class="micon"><a class="exi" href="#expand"> </a></td>
4152 <a id="Roo.Component-event-*beforerender"></a>
4154 <div class="fixedFont">
4155 <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>)
4161 <div class="short">Fires before the component is rendered.
4167 Fires before the component is rendered. Return false to stop the render.
4173 <dl class="detailList">
4174 <dt class="heading">Parameters:</dt>
4177 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4198 <td class="msource">
4199 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4203 <tr class="method-row expandable config-row-alt0">
4204 <td class="micon"><a class="exi" href="#expand"> </a></td>
4207 <a id="Roo.Component-event-*beforeshow"></a>
4209 <div class="fixedFont">
4210 <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>)
4216 <div class="short">Fires before the component is shown.
4222 Fires before the component is shown. Return false to stop the show.
4228 <dl class="detailList">
4229 <dt class="heading">Parameters:</dt>
4232 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4253 <td class="msource">
4254 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4258 <tr class="method-row expandable config-row-alt1 notInherited">
4259 <td class="micon"><a class="exi" href="#expand"> </a></td>
4262 <a id="Roo.form.HtmlEditor-event-*beforesync"></a>
4264 <div class="fixedFont">
4265 <b class="itemname">beforesync</b> (HtmlEditor <B><i>this</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>html</i></B>)
4271 <div class="short">Fires before the textarea is updated with content from the editor iframe.
4277 Fires before the textarea is updated with content from the editor iframe. Return false<br/>to cancel the sync.
4283 <dl class="detailList">
4284 <dt class="heading">Parameters:</dt>
4287 <span class="fixedFont">HtmlEditor</span> <b>this</b>
4293 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>html</b>
4314 <td class="msource">
4319 <tr class="method-row expandable config-row-alt0">
4320 <td class="micon"><a class="exi" href="#expand"> </a></td>
4323 <a id="Roo.Component-event-*destroy"></a>
4325 <div class="fixedFont">
4326 <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>)
4332 <div class="short">Fires after the component is destroyed.
4338 Fires after the component is destroyed.
4344 <dl class="detailList">
4345 <dt class="heading">Parameters:</dt>
4348 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4369 <td class="msource">
4370 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4374 <tr class="method-row expandable config-row-alt1">
4375 <td class="micon"><a class="exi" href="#expand"> </a></td>
4378 <a id="Roo.Component-event-*disable"></a>
4380 <div class="fixedFont">
4381 <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>)
4387 <div class="short">Fires after the component is disabled.
4393 Fires after the component is disabled.
4399 <dl class="detailList">
4400 <dt class="heading">Parameters:</dt>
4403 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4424 <td class="msource">
4425 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4429 <tr class="method-row expandable config-row-alt0 notInherited">
4430 <td class="micon"><a class="exi" href="#expand"> </a></td>
4433 <a id="Roo.form.HtmlEditor-event-*editmodechange"></a>
4435 <div class="fixedFont">
4436 <b class="itemname">editmodechange</b> (HtmlEditor <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>sourceEdit</i></B>)
4442 <div class="short">Fires when the editor switches edit modes
4448 Fires when the editor switches edit modes
4454 <dl class="detailList">
4455 <dt class="heading">Parameters:</dt>
4458 <span class="fixedFont">HtmlEditor</span> <b>this</b>
4464 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>sourceEdit</b>
4467 <dd>True if source edit, false if standard editing.</dd>
4485 <td class="msource">
4490 <tr class="method-row expandable config-row-alt1 notInherited">
4491 <td class="micon"><a class="exi" href="#expand"> </a></td>
4494 <a id="Roo.form.HtmlEditor-event-*editorevent"></a>
4496 <div class="fixedFont">
4497 <b class="itemname">editorevent</b> (HtmlEditor <B><i>this</i></B>)
4503 <div class="short">Fires when on any editor (mouse up/down cursor movement etc.
4509 Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.
4515 <dl class="detailList">
4516 <dt class="heading">Parameters:</dt>
4519 <span class="fixedFont">HtmlEditor</span> <b>this</b>
4540 <td class="msource">
4545 <tr class="method-row expandable config-row-alt0">
4546 <td class="micon"><a class="exi" href="#expand"> </a></td>
4549 <a id="Roo.Component-event-*enable"></a>
4551 <div class="fixedFont">
4552 <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>)
4558 <div class="short">Fires after the component is enabled.
4564 Fires after the component is enabled.
4570 <dl class="detailList">
4571 <dt class="heading">Parameters:</dt>
4574 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4595 <td class="msource">
4596 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4600 <tr class="method-row expandable config-row-alt1 notInherited">
4601 <td class="micon"><a class="exi" href="#expand"> </a></td>
4604 <a id="Roo.form.HtmlEditor-event-*firstfocus"></a>
4606 <div class="fixedFont">
4607 <b class="itemname">firstfocus</b> (HtmlEditor <B><i>this</i></B>)
4613 <div class="short">Fires when on first focus - needed by toolbars.
4619 Fires when on first focus - needed by toolbars..
4625 <dl class="detailList">
4626 <dt class="heading">Parameters:</dt>
4629 <span class="fixedFont">HtmlEditor</span> <b>this</b>
4650 <td class="msource">
4655 <tr class="method-row expandable config-row-alt0">
4656 <td class="micon"><a class="exi" href="#expand"> </a></td>
4659 <a id="Roo.Component-event-*hide"></a>
4661 <div class="fixedFont">
4662 <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>)
4668 <div class="short">Fires after the component is hidden.
4674 Fires after the component is hidden.
4680 <dl class="detailList">
4681 <dt class="heading">Parameters:</dt>
4684 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4705 <td class="msource">
4706 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
4710 <tr class="method-row expandable config-row-alt1 notInherited">
4711 <td class="micon"><a class="exi" href="#expand"> </a></td>
4714 <a id="Roo.form.HtmlEditor-event-*initialize"></a>
4716 <div class="fixedFont">
4717 <b class="itemname">initialize</b> (HtmlEditor <B><i>this</i></B>)
4723 <div class="short">Fires when the editor is fully initialized (including the iframe)
4729 Fires when the editor is fully initialized (including the iframe)
4735 <dl class="detailList">
4736 <dt class="heading">Parameters:</dt>
4739 <span class="fixedFont">HtmlEditor</span> <b>this</b>
4760 <td class="msource">
4765 <tr class="method-row expandable config-row-alt0">
4766 <td class="micon"><a class="exi" href="#expand"> </a></td>
4769 <a id="Roo.form.Field-event-*invalid"></a>
4771 <div class="fixedFont">
4772 <b class="itemname">invalid</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="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>msg</i></B>)
4778 <div class="short">Fires after the field has been marked as invalid.
4784 Fires after the field has been marked as invalid.
4790 <dl class="detailList">
4791 <dt class="heading">Parameters:</dt>
4794 <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>
4800 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>msg</b>
4803 <dd>The validation message</dd>
4821 <td class="msource">
4822 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4826 <tr class="method-row expandable config-row-alt1">
4827 <td class="micon"><a class="exi" href="#expand"> </a></td>
4830 <a id="Roo.form.Field-event-*keyup"></a>
4832 <div class="fixedFont">
4833 <b class="itemname">keyup</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>)
4839 <div class="short">Fires after the key up
4845 Fires after the key up
4851 <dl class="detailList">
4852 <dt class="heading">Parameters:</dt>
4855 <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>
4861 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
4864 <dd>The event Object</dd>
4882 <td class="msource">
4883 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
4887 <tr class="method-row expandable config-row-alt0">
4888 <td class="micon"><a class="exi" href="#expand"> </a></td>
4891 <a id="Roo.BoxComponent-event-*move"></a>
4893 <div class="fixedFont">
4894 <b class="itemname">move</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
4900 <div class="short">Fires after the component is moved.
4906 Fires after the component is moved.
4912 <dl class="detailList">
4913 <dt class="heading">Parameters:</dt>
4916 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
4922 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>x</b>
4925 <dd>The new x position</dd>
4928 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>y</b>
4931 <dd>The new y position</dd>
4949 <td class="msource">
4950 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
4954 <tr class="method-row expandable config-row-alt1 notInherited">
4955 <td class="micon"><a class="exi" href="#expand"> </a></td>
4958 <a id="Roo.form.HtmlEditor-event-*push"></a>
4960 <div class="fixedFont">
4961 <b class="itemname">push</b> (HtmlEditor <B><i>this</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>html</i></B>)
4967 <div class="short">Fires when the iframe editor is updated with content from the textarea.
4973 Fires when the iframe editor is updated with content from the textarea.
4979 <dl class="detailList">
4980 <dt class="heading">Parameters:</dt>
4983 <span class="fixedFont">HtmlEditor</span> <b>this</b>
4989 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>html</b>
5010 <td class="msource">
5015 <tr class="method-row expandable config-row-alt0">
5016 <td class="micon"><a class="exi" href="#expand"> </a></td>
5019 <a id="Roo.Component-event-*render"></a>
5021 <div class="fixedFont">
5022 <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>)
5028 <div class="short">Fires after the component is rendered.
5034 Fires after the component is rendered.
5040 <dl class="detailList">
5041 <dt class="heading">Parameters:</dt>
5044 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
5065 <td class="msource">
5066 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
5070 <tr class="method-row expandable config-row-alt1">
5071 <td class="micon"><a class="exi" href="#expand"> </a></td>
5074 <a id="Roo.BoxComponent-event-*resize"></a>
5076 <div class="fixedFont">
5077 <b class="itemname">resize</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>adjHeight</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawWidth</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rawHeight</i></B>)
5083 <div class="short">Fires after the component is resized.
5089 Fires after the component is resized.
5095 <dl class="detailList">
5096 <dt class="heading">Parameters:</dt>
5099 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
5105 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjWidth</b>
5108 <dd>The box-adjusted width that was set</dd>
5111 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>adjHeight</b>
5114 <dd>The box-adjusted height that was set</dd>
5117 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawWidth</b>
5120 <dd>The width that was originally specified</dd>
5123 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rawHeight</b>
5126 <dd>The height that was originally specified</dd>
5144 <td class="msource">
5145 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>
5149 <tr class="method-row expandable config-row-alt0 notInherited">
5150 <td class="micon"><a class="exi" href="#expand"> </a></td>
5153 <a id="Roo.form.HtmlEditor-event-*savedpreview"></a>
5155 <div class="fixedFont">
5156 <b class="itemname">savedpreview</b> (HtmlEditor <B><i>this</i></B>)
5162 <div class="short">preview the saved version of htmlEditor
5168 preview the saved version of htmlEditor
5174 <dl class="detailList">
5175 <dt class="heading">Parameters:</dt>
5178 <span class="fixedFont">HtmlEditor</span> <b>this</b>
5199 <td class="msource">
5204 <tr class="method-row expandable config-row-alt1">
5205 <td class="micon"><a class="exi" href="#expand"> </a></td>
5208 <a id="Roo.Component-event-*show"></a>
5210 <div class="fixedFont">
5211 <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>)
5217 <div class="short">Fires after the component is shown.
5223 Fires after the component is shown.
5229 <dl class="detailList">
5230 <dt class="heading">Parameters:</dt>
5233 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
5254 <td class="msource">
5255 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
5259 <tr class="method-row expandable config-row-alt0 notInherited">
5260 <td class="micon"><a class="exi" href="#expand"> </a></td>
5263 <a id="Roo.form.HtmlEditor-event-*stylesheetsclick"></a>
5265 <div class="fixedFont">
5266 <b class="itemname">stylesheetsclick</b> (<a href="./Roo.HtmlEditorCore.html#constructor" roo:cls="Roo.HtmlEditorCore.html#constructor">Roo.HtmlEditorCore</a> <B><i>this</i></B>)
5272 <div class="short">Fires when press the Sytlesheets button
5278 Fires when press the Sytlesheets button
5284 <dl class="detailList">
5285 <dt class="heading">Parameters:</dt>
5288 <span class="fixedFont"><a href="./Roo.HtmlEditorCore.html#constructor" roo:cls="Roo.HtmlEditorCore.html#constructor">Roo.HtmlEditorCore</a></span> <b>this</b>
5309 <td class="msource">
5314 <tr class="method-row expandable config-row-alt1 notInherited">
5315 <td class="micon"><a class="exi" href="#expand"> </a></td>
5318 <a id="Roo.form.HtmlEditor-event-*sync"></a>
5320 <div class="fixedFont">
5321 <b class="itemname">sync</b> (HtmlEditor <B><i>this</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>html</i></B>)
5327 <div class="short">Fires when the textarea is updated with content from the editor iframe.
5333 Fires when the textarea is updated with content from the editor iframe.
5339 <dl class="detailList">
5340 <dt class="heading">Parameters:</dt>
5343 <span class="fixedFont">HtmlEditor</span> <b>this</b>
5349 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>html</b>
5370 <td class="msource">
5375 <tr class="method-row expandable config-row-alt0">
5376 <td class="micon"><a class="exi" href="#expand"> </a></td>
5379 <a id="Roo.form.Field-event-*valid"></a>
5381 <div class="fixedFont">
5382 <b class="itemname">valid</b> (<a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a> <B><i>this</i></B>)
5388 <div class="short">Fires after the field has been validated with no errors.
5394 Fires after the field has been validated with no errors.
5400 <dl class="detailList">
5401 <dt class="heading">Parameters:</dt>
5404 <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>
5425 <td class="msource">
5426 <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>
5437 <!-- ============================== footer ================================= -->
5438 <div class="fineprint" style="clear:both">
5440 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Oct 02 2015 12:35:13 GMT+0800 (HKT)
5442 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>