Upgrade to ExtJS 3.0.3 - Released 10/11/2009
[extjs.git] / docs / output / Ext.form.HtmlEditor.html
1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.form.HtmlEditor-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.form.HtmlEditor-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.form.HtmlEditor-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.form.HtmlEditor-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.form.HtmlEditor"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.Component.html" ext:member="" ext:cls="Ext.Component">Component</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.BoxComponent.html" ext:member="" ext:cls="Ext.BoxComponent">BoxComponent</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif"><a href="output/Ext.form.Field.html" ext:member="" ext:cls="Ext.form.Field">Field</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">HtmlEditor</pre></div><h1>Class <a href="source/HtmlEditor.html#cls-Ext.form.HtmlEditor">Ext.form.HtmlEditor</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.form</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">HtmlEditor.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/HtmlEditor.html#cls-Ext.form.HtmlEditor">HtmlEditor</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.form.Field.html" ext:cls="Ext.form.Field" ext:member="">Field</a></td></tr><tr><td class="hd-info"></td></tr><tr><td class="label">xtype:</td><td class="hd-info">htmleditor</td></tr></table><div class="description">Provides a lightweight HTML Editor component. Some toolbar features are not supported by Safari and will be \r
2 automatically hidden when needed.  These are noted in the config options where appropriate.\r
3 <br><br>The editor's toolbar buttons have tooltips defined in the <a href="output/Ext.form.HtmlEditor.html#Ext.form.HtmlEditor-buttonTips" ext:member="buttonTips" ext:cls="Ext.form.HtmlEditor">buttonTips</a> property, but they are not \r
4 enabled by default unless the global <a href="output/Ext.QuickTips.html" ext:cls="Ext.QuickTips">Ext.QuickTips</a> singleton is <a href="output/Ext.QuickTips.html#Ext.QuickTips-init" ext:member="init" ext:cls="Ext.QuickTips">initialized</a>.\r
5 <br><br><b>Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT\r
6 supported by this editor.</b>\r
7 <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\r
8 any element that has display set to 'none' can cause problems in Safari and Firefox due to their default iframe reloading bugs.\r
9 <br><br>Example usage:\r
10 <pre><code><i>// Simple example rendered <b>with</b> <b>default</b> options:\r</i>
11 Ext.QuickTips.init();  <i>// enable tooltips\r</i>
12 <b>new</b> Ext.form.HtmlEditor({\r
13     renderTo: Ext.getBody(),\r
14     width: 800,\r
15     height: 300\r
16 });\r
17 \r
18 <i>// Passed via xtype into a container and <b>with</b> custom options:\r</i>
19 Ext.QuickTips.init();  <i>// enable tooltips\r</i>
20 <b>new</b> Ext.Panel({\r
21     title: <em>'HTML Editor'</em>,\r
22     renderTo: Ext.getBody(),\r
23     width: 600,\r
24     height: 300,\r
25     frame: true,\r
26     layout: <em>'fit'</em>,\r
27     items: {\r
28         xtype: <em>'htmleditor'</em>,\r
29         enableColors: false,\r
30         enableAlignments: false\r
31     }\r
32 });</code></pre></div><div class="hr"></div><a id="Ext.form.HtmlEditor-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-anchor"></a><b><a href="source/Component.html#cfg-Ext.Component-anchor">anchor</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this Component is rendered\r
33 by a Container which has been configured to use an Anc...</div><div class="long"><p><b>Note</b>: this config is only used when this Component is rendered
34 by a Container which has been configured to use an <b><a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">AnchorLayout</a></b>
35 based layout manager, for example:<div class="mdetail-params"><ul>
36 <li><a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a></li>
37 <li>specifying <code>layout: <em>'anchor'</em> <i>// or <em>'form'</em>, or <em>'absolute'</em></i></code></li>
38 </ul></div></p>
39 <p>See <a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">Ext.layout.AnchorLayout</a>.<a href="output/Ext.layout.AnchorLayout.html#Ext.layout.AnchorLayout-anchor" ext:member="anchor" ext:cls="Ext.layout.AnchorLayout">anchor</a> also.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#anchor" ext:member="#anchor" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-autoEl"></a><b><a href="source/Component.html#cfg-Ext.Component-autoEl">autoEl</a></b> : Mixed<div class="mdesc"><div class="short">A tag name or DomHelper spec used to create the Element which will\r
40 encapsulate this Component.\r
41 You do not normally ne...</div><div class="long"><p>A tag name or <a href="output/Ext.DomHelper.html" ext:cls="Ext.DomHelper">DomHelper</a> spec used to create the <a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a> which will
42 encapsulate this Component.</p>
43 <p>You do not normally need to specify this. For the base classes <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a>, <a href="output/Ext.BoxComponent.html" ext:cls="Ext.BoxComponent">Ext.BoxComponent</a>,
44 and <a href="output/Ext.Container.html" ext:cls="Ext.Container">Ext.Container</a>, this defaults to <b><tt>'div'</tt></b>. The more complex Ext classes use a more complex
45 DOM structure created by their own onRender methods.</p>
46 <p>This is intended to allow the developer to create application-specific utility Components encapsulated by
47 different DOM elements. Example usage:</p><pre><code>{
48     xtype: <em>'box'</em>,
49     autoEl: {
50         tag: <em>'img'</em>,
51         src: <em>'http:<i>//www.example.com/example.jpg'</em></i>
52     }
53 }, {
54     xtype: <em>'box'</em>,
55     autoEl: {
56         tag: <em>'blockquote'</em>,
57         html: <em>'autoEl is cool!'</em>
58     }
59 }, {
60     xtype: <em>'container'</em>,
61     autoEl: <em>'ul'</em>,
62     cls: <em>'ux-unordered-list'</em>,
63     items: {
64         xtype: <em>'box'</em>,
65         autoEl: <em>'li'</em>,
66         html: <em>'First list item'</em>
67     }
68 }</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#autoEl" ext:member="#autoEl" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-autoShow"></a><b><a href="source/Component.html#cfg-Ext.Component-autoShow">autoShow</a></b> : Boolean<div class="mdesc"><div class="short">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove\r
69 them on render...</div><div class="long">True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove
70 them on render (defaults to false).</div></div></td><td class="msource"><a href="output/Ext.Component.html#autoShow" ext:member="#autoShow" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-clearCls"></a><b><a href="source/Component.html#cfg-Ext.Component-clearCls">clearCls</a></b> : String<div class="mdesc"><div class="short">The CSS class used to to apply to the special clearing div rendered\r
71 directly after each form field wrapper to provide...</div><div class="long"><p>The CSS class used to to apply to the special clearing div rendered
72 directly after each form field wrapper to provide field clearing (defaults to
73 <tt>'x-form-clear-left'</tt>).</p>
74 <br><p><b>Note</b>: this config is only used when this Component is rendered by a Container
75 which has been configured to use the <b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">FormLayout</a></b> layout
76 manager (e.g. <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>) and either a
77 <tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt> is specified or <tt>isFormField=true</tt> is specified.</p><br>
78 <p>See <a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a> also.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#clearCls" ext:member="#clearCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-createLinkText"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-createLinkText">createLinkText</a></b> : String<div class="mdesc">The default text for the create link prompt</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-ctCls"></a><b><a href="source/Component.html#cfg-Ext.Component-ctCls">ctCls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to this component's container. This can be useful for\r
79 adding customize...</div><div class="long"><p>An optional extra CSS class that will be added to this component's container. This can be useful for
80 adding customized styles to the container or any of its children using standard CSS rules.  See
81 <a href="output/Ext.layout.ContainerLayout.html" ext:cls="Ext.layout.ContainerLayout">Ext.layout.ContainerLayout</a>.<a href="output/Ext.layout.ContainerLayout.html#Ext.layout.ContainerLayout-extraCls" ext:member="extraCls" ext:cls="Ext.layout.ContainerLayout">extraCls</a> also.</p>
82 <p><b>Note</b>: <tt>ctCls</tt> defaults to <tt>''</tt> except for the following class
83 which assigns a value by default:
84 <div class="mdetail-params"><ul>
85 <li><a href="output/Ext.layout.Box.html" ext:cls="Ext.layout.Box">Box Layout</a> : <tt>'x-box-layout-ct'</tt></li>
86 </ul></div>
87 To configure the above Class with an extra CSS class append to the default.  For example,
88 for BoxLayout (Hbox and Vbox):<pre><code>ctCls: <em>'x-box-layout-ct custom-class'</em></code></pre>
89 </p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ctCls" ext:member="#ctCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-defaultLinkValue"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-defaultLinkValue">defaultLinkValue</a></b> : String<div class="mdesc">The default value for the create link prompt (defaults to http:/ /)</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-defaultValue"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-defaultValue">defaultValue</a></b> : String<div class="mdesc"><div class="short">A default value to be put into the editor to resolve focus issues (defaults to &amp;#8203; (Zero-width space), &amp;nbsp; (No...</div><div class="long">A default value to be put into the editor to resolve focus issues (defaults to &#8203; (Zero-width space), &nbsp; (Non-breaking space) in Opera and IE6).</div></div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-enableAlignments"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-enableAlignments">enableAlignments</a></b> : Boolean<div class="mdesc">Enable the left, center, right alignment buttons (defaults to true)</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-enableColors"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-enableColors">enableColors</a></b> : Boolean<div class="mdesc">Enable the fore/highlight color buttons (defaults to true)</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-enableFont"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-enableFont">enableFont</a></b> : Boolean<div class="mdesc">Enable font selection. Not available in Safari. (defaults to true)</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-enableFontSize"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-enableFontSize">enableFontSize</a></b> : Boolean<div class="mdesc">Enable the increase/decrease font size buttons (defaults to true)</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-enableFormat"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-enableFormat">enableFormat</a></b> : Boolean<div class="mdesc">Enable the bold, italic and underline buttons (defaults to true)</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-enableLinks"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-enableLinks">enableLinks</a></b> : Boolean<div class="mdesc">Enable the create link button. Not available in Safari. (defaults to true)</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-enableLists"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-enableLists">enableLists</a></b> : Boolean<div class="mdesc">Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-enableSourceEdit"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-enableSourceEdit">enableSourceEdit</a></b> : Boolean<div class="mdesc">Enable the switch to source edit button. Not available in Safari. (defaults to true)</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-fieldLabel"></a><b><a href="source/Component.html#cfg-Ext.Component-fieldLabel">fieldLabel</a></b> : String<div class="mdesc"><div class="short">The label text to display next to this Component (defaults to '').\r
90 Note: this config is only used when this Component...</div><div class="long"><p>The label text to display next to this Component (defaults to '').</p>
91 <br><p><b>Note</b>: this config is only used when this Component is rendered by a Container which
92 has been configured to use the <b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">FormLayout</a></b> layout manager (e.g.
93 <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>).</p><br>
94 <p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></tt> and
95 <a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>.</p>
96 Example use:<pre><code><b>new</b> Ext.FormPanel({
97     height: 100,
98     renderTo: Ext.getBody(),
99     items: [{
100         xtype: <em>'textfield'</em>,
101         fieldLabel: <em>'Name'</em>
102     }]
103 });</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#fieldLabel" ext:member="#fieldLabel" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-fontFamilies"></a><b><a href="source/HtmlEditor.html#cfg-Ext.form.HtmlEditor-fontFamilies">fontFamilies</a></b> : Array<div class="mdesc">An array of available font families</div></td><td class="msource">HtmlEditor</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-height"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-height">height</a></b> : Number<div class="mdesc"><div class="short">The height of this component in pixels (defaults to auto).\r
104 Note to express this dimension as a percentage or offset s...</div><div class="long">The height of this component in pixels (defaults to auto).
105 <b>Note</b> to express this dimension as a percentage or offset see <a href="output/Ext.Component.html#Ext.Component-anchor" ext:member="anchor" ext:cls="Ext.Component">Ext.Component.anchor</a>.</div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#height" ext:member="#height" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-hidden"></a><b><a href="source/Component.html#cfg-Ext.Component-hidden">hidden</a></b> : Boolean<div class="mdesc">Render this component hidden (default is false). If <tt>true</tt>, the
106 <a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a> method will be called internally.</div></td><td class="msource"><a href="output/Ext.Component.html#hidden" ext:member="#hidden" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-hideLabel"></a><b><a href="source/Component.html#cfg-Ext.Component-hideLabel">hideLabel</a></b> : Boolean<div class="mdesc"><div class="short">true to completely hide the label element\r
107 (label and separator). Defaults to false.\r
108 By default, even if you do not sp...</div><div class="long"><p><tt>true</tt> to completely hide the label element
109 (<a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">label</a> and <a href="output/Ext.Component.html#Ext.Component-labelSeparator" ext:member="labelSeparator" ext:cls="Ext.Component">separator</a>). Defaults to <tt>false</tt>.
110 By default, even if you do not specify a <tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt> the space will still be
111 reserved so that the field will line up with other fields that do have labels.
112 Setting this to <tt>true</tt> will cause the field to not reserve that space.</p>
113 <br><p><b>Note</b>: see the note for <tt><a href="output/Ext.Component.html#Ext.Component-clearCls" ext:member="clearCls" ext:cls="Ext.Component">clearCls</a></tt>.</p><br>
114 Example use:<pre><code><b>new</b> Ext.FormPanel({
115     height: 100,
116     renderTo: Ext.getBody(),
117     items: [{
118         xtype: <em>'textfield'</em>
119         hideLabel: true
120     }]
121 });</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#hideLabel" ext:member="#hideLabel" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-hideMode"></a><b><a href="source/Component.html#cfg-Ext.Component-hideMode">hideMode</a></b> : String<div class="mdesc"><div class="short">How this component should be hidden. Supported values are 'visibility'\r
122 (css visibility), 'offsets' (negative offset p...</div><div class="long"><p>How this component should be hidden. Supported values are <tt>'visibility'</tt>
123 (css visibility), <tt>'offsets'</tt> (negative offset position) and <tt>'display'</tt>
124 (css display).</p>
125 <br><p><b>Note</b>: the default of <tt>'display'</tt> is generally preferred
126 since items are automatically laid out when they are first shown (no sizing
127 is done while hidden).</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#hideMode" ext:member="#hideMode" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-hideParent"></a><b><a href="source/Component.html#cfg-Ext.Component-hideParent">hideParent</a></b> : Boolean<div class="mdesc"><div class="short">True to hide and show the component's container when hide/show is called on the component, false to hide\r
128 and show the...</div><div class="long">True to hide and show the component's container when hide/show is called on the component, false to hide
129 and show the component itself (defaults to false).  For example, this can be used as a shortcut for a hide
130 button on a window by setting hide:true on the button when adding it to its parent container.</div></div></td><td class="msource"><a href="output/Ext.Component.html#hideParent" ext:member="#hideParent" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-id"></a><b><a href="source/Component.html#cfg-Ext.Component-id">id</a></b> : String<div class="mdesc"><div class="short">The unique id of this component (defaults to an auto-assigned id).\r
131 You should assign an id if you need to be able to ...</div><div class="long"><p>The <b>unique</b> id of this component (defaults to an <a href="output/Ext.Component.html#Ext.Component-getId" ext:member="getId" ext:cls="Ext.Component">auto-assigned id</a>).
132 You should assign an id if you need to be able to access the component later and you do
133 not have an object reference available (e.g., using <a href="output/Ext.html" ext:cls="Ext">Ext</a>.<a href="output/Ext.html#Ext-getCmp" ext:member="getCmp" ext:cls="Ext">getCmp</a>).</p>
134 <p>Note that this id will also be used as the element id for the containing HTML element
135 that is rendered to the page for this component. This allows you to write id-based CSS
136 rules to style the specific instance of this component uniquely, and also to select
137 sub-elements using this component's id as the parent.</p>
138 <p><b>Note</b>: to avoid complications imposed by a unique <tt>id</tt> also see
139 <code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code> and <code><a href="output/Ext.Component.html#Ext.Component-ref" ext:member="ref" ext:cls="Ext.Component">ref</a></code>.</p>
140 <p><b>Note</b>: to access the container of an item see <code><a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a></code>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#id" ext:member="#id" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-itemCls"></a><b><a href="source/Component.html#cfg-Ext.Component-itemCls">itemCls</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this Component is rendered by a Container which\r
141 has been configured to use the Fo...</div><div class="long"><p><b>Note</b>: this config is only used when this Component is rendered by a Container which
142 has been configured to use the <b><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">FormLayout</a></b> layout manager (e.g.
143 <a href="output/Ext.form.FormPanel.html" ext:cls="Ext.form.FormPanel">Ext.form.FormPanel</a> or specifying <tt>layout:'form'</tt>).</p><br>
144 <p>An additional CSS class to apply to the div wrapping the form item
145 element of this field.  If supplied, <tt>itemCls</tt> at the <b>field</b> level will override
146 the default <tt>itemCls</tt> supplied at the <b>container</b> level. The value specified for
147 <tt>itemCls</tt> will be added to the default class (<tt>'x-form-item'</tt>).</p>
148 <p>Since it is applied to the item wrapper (see
149 <a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>), it allows
150 you to write standard CSS rules that can apply to the field, the label (if specified), or
151 any other element within the markup for the field.</p>
152 <br><p><b>Note</b>: see the note for <tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt>.</p><br>
153 Example use:<pre><code><i>// Apply a style to the field&#39;s <b>label</b>:</i>
154 &lt;style>
155     .required .x-form-item-<b>label</b> {font-weight:bold;color:red;}
156 &lt;/style>
157
158 <b>new</b> Ext.FormPanel({
159     height: 100,
160     renderTo: Ext.getBody(),
161     items: [{
162         xtype: <em>'textfield'</em>,
163         fieldLabel: <em>'Name'</em>,
164         itemCls: <em>'required'</em> <i>//this <b>label</b> will be styled</i>
165     },{
166         xtype: <em>'textfield'</em>,
167         fieldLabel: <em>'Favorite Color'</em>
168     }]
169 });</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#itemCls" ext:member="#itemCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-itemId"></a><b><a href="source/Component.html#cfg-Ext.Component-itemId">itemId</a></b> : String<div class="mdesc"><div class="short">An itemId can be used as an alternative way to get a reference to a component\r
170 when no object reference is available. ...</div><div class="long"><p>An <tt>itemId</tt> can be used as an alternative way to get a reference to a component
171 when no object reference is available.  Instead of using an <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code> with
172 <a href="output/Ext.html" ext:cls="Ext">Ext</a>.<a href="output/Ext.html#Ext-getCmp" ext:member="getCmp" ext:cls="Ext">getCmp</a>, use <code>itemId</code> with
173 <a href="output/Ext.Container.html" ext:cls="Ext.Container">Ext.Container</a>.<a href="output/Ext.Container.html#Ext.Container-getComponent" ext:member="getComponent" ext:cls="Ext.Container">getComponent</a> which will retrieve
174 <code>itemId</code>'s or <tt><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></tt>'s. Since <code>itemId</code>'s are an index to the
175 container's internal MixedCollection, the <code>itemId</code> is scoped locally to the container --
176 avoiding potential conflicts with <a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a> which requires a <b>unique</b>
177 <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
178 <pre><code><b>var</b> c = <b>new</b> Ext.Panel({ <i>//</i>
179     <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 300,
180     <a href="output/Ext.Component.html#Ext.Component-renderTo" ext:member="renderTo" ext:cls="Ext.Component">renderTo</a>: document.body,
181     <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a>: <em>'auto'</em>,
182     <a href="output/Ext.Container.html#Ext.Container-items" ext:member="items" ext:cls="Ext.Container">items</a>: [
183         {
184             itemId: <em>'p1'</em>,
185             <a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a>: <em>'Panel 1'</em>,
186             <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 150
187         },
188         {
189             itemId: <em>'p2'</em>,
190             <a href="output/Ext.Panel.html#Ext.Panel-title" ext:member="title" ext:cls="Ext.Panel">title</a>: <em>'Panel 2'</em>,
191             <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-height" ext:member="height" ext:cls="Ext.BoxComponent">height</a>: 150
192         }
193     ]
194 })
195 p1 = c.<a href="output/Ext.Container.html#Ext.Container-getComponent" ext:member="getComponent" ext:cls="Ext.Container">getComponent</a>(<em>'p1'</em>); <i>// not the same as <a href="output/Ext.html#Ext-getCmp" ext:member="getCmp" ext:cls="Ext">Ext.getCmp()</a></i>
196 p2 = p1.<a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a>.<a href="output/Ext.Container.html#Ext.Container-getComponent" ext:member="getComponent" ext:cls="Ext.Container">getComponent</a>(<em>'p2'</em>); <i>// reference via a sibling</i></code></pre>
197 <p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></tt> and <code><a href="output/Ext.Component.html#Ext.Component-ref" ext:member="ref" ext:cls="Ext.Component">ref</a></code>.</p>
198 <p><b>Note</b>: to access the container of an item see <tt><a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a></tt>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#itemId" ext:member="#itemId" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-labelSeparator"></a><b><a href="source/Component.html#cfg-Ext.Component-labelSeparator">labelSeparator</a></b> : String<div class="mdesc"><div class="short">The separator to display after the text of each\r
199 fieldLabel.  This property may be configured at various levels.\r
200 The o...</div><div class="long"><p>The separator to display after the text of each
201 <tt><a href="output/Ext.Component.html#Ext.Component-fieldLabel" ext:member="fieldLabel" ext:cls="Ext.Component">fieldLabel</a></tt>.  This property may be configured at various levels.
202 The order of precedence is:
203 <div class="mdetail-params"><ul>
204 <li>field / component level</li>
205 <li>container level</li>
206 <li><a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-labelSeparator" ext:member="labelSeparator" ext:cls="Ext.layout.FormLayout">layout level</a> (defaults to colon <tt>':'</tt>)</li>
207 </ul></div>
208 To display no separator for this field's label specify empty string ''.</p>
209 <br><p><b>Note</b>: see the note for <tt><a href="output/Ext.Component.html#Ext.Component-clearCls" ext:member="clearCls" ext:cls="Ext.Component">clearCls</a></tt>.</p><br>
210 <p>Also see <tt><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></tt> and
211 <a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>.</p>
212 Example use:<pre><code><b>new</b> Ext.FormPanel({
213     height: 100,
214     renderTo: Ext.getBody(),
215     layoutConfig: {
216         labelSeparator: <em>'~'</em>   <i>// layout config has lowest priority (defaults to <em>':'</em>)</i>
217     },
218     <a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-labelSeparator" ext:member="labelSeparator" ext:cls="Ext.layout.FormLayout">labelSeparator</a>: <em>'>>'</em>,     <i>// config at container level</i>
219     items: [{
220         xtype: <em>'textfield'</em>,
221         fieldLabel: <em>'Field 1'</em>,
222         labelSeparator: <em>'...'</em> <i>// field/component level config supersedes others</i>
223     },{
224         xtype: <em>'textfield'</em>,
225         fieldLabel: <em>'Field 2'</em> <i>// labelSeparator will be <em>'='</em></i>
226     }]
227 });</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#labelSeparator" ext:member="#labelSeparator" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-labelStyle"></a><b><a href="source/Component.html#cfg-Ext.Component-labelStyle">labelStyle</a></b> : String<div class="mdesc"><div class="short">A CSS style specification string to apply directly to this field's\r
228 label.  Defaults to the container's labelStyle val...</div><div class="long"><p>A CSS style specification string to apply directly to this field's
229 label.  Defaults to the container's labelStyle value if set (e.g.,
230 <tt><a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-labelStyle" ext:member="labelStyle" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout.labelStyle</a></tt> , or '').</p>
231 <br><p><b>Note</b>: see the note for <code><a href="output/Ext.Component.html#Ext.Component-clearCls" ext:member="clearCls" ext:cls="Ext.Component">clearCls</a></code>.</p><br>
232 <p>Also see <code><a href="output/Ext.Component.html#Ext.Component-hideLabel" ext:member="hideLabel" ext:cls="Ext.Component">hideLabel</a></code> and
233 <code><a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>.<a href="output/Ext.layout.FormLayout.html#Ext.layout.FormLayout-fieldTpl" ext:member="fieldTpl" ext:cls="Ext.layout.FormLayout">fieldTpl</a>.</code></p>
234 Example use:<pre><code><b>new</b> Ext.FormPanel({
235     height: 100,
236     renderTo: Ext.getBody(),
237     items: [{
238         xtype: <em>'textfield'</em>,
239         fieldLabel: <em>'Name'</em>,
240         labelStyle: <em>'font-weight:bold;'</em>
241     }]
242 });</code></pre></div></div></td><td class="msource"><a href="output/Ext.Component.html#labelStyle" ext:member="#labelStyle" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this\r
243 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
244 object during initialization.  This should be a valid listeners config object as specified in the
245 <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
246 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
247 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
248 is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
249 <b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
250 events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
251 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
252 <i>// The Component is appended to the argument list of all handler functions.</i>
253 Ext.DomObserver = Ext.extend(Object, {
254     constructor: <b>function</b>(config) {
255         this.listeners = config.listeners ? config.listeners : config;
256     },
257
258     <i>// Component passes itself into plugin&#39;s init method</i>
259     init: <b>function</b>(c) {
260         <b>var</b> p, l = this.listeners;
261         <b>for</b> (p <b>in</b> l) {
262             <b>if</b> (Ext.isFunction(l[p])) {
263                 l[p] = this.createHandler(l[p], c);
264             } <b>else</b> {
265                 l[p].fn = this.createHandler(l[p].fn, c);
266             }
267         }
268
269         <i>// Add the listeners to the Element immediately following the render call</i>
270         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
271             <b>var</b> e = c.getEl();
272             <b>if</b> (e) {
273                 e.on(l);
274             }
275         });
276     },
277
278     createHandler: <b>function</b>(fn, c) {
279         <b>return</b> <b>function</b>(e) {
280             fn.call(this, e, c);
281         };
282     }
283 });
284
285 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
286
287     <i>// Collapse combo when its element is clicked on</i>
288     plugins: [ <b>new</b> Ext.DomObserver({
289         click: <b>function</b>(evt, comp) {
290             comp.collapse();
291         }
292     })],
293     store: myStore,
294     typeAhead: true,
295     mode: <em>'local'</em>,
296     triggerAction: <em>'all'</em>
297 });</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-margins"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-margins">margins</a></b> : Object<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is rendered\r
298 by a Container which has been configured to use the...</div><div class="long"><p><b>Note</b>: this config is only used when this BoxComponent is rendered
299 by a Container which has been configured to use the <b><a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a></b>
300 or one of the two <b><a href="output/Ext.layout.BoxLayout.html" ext:cls="Ext.layout.BoxLayout">BoxLayout</a> subclasses.</b></p>
301 <p>An object containing margins to apply to this BoxComponent in the
302 format:</p><pre><code>{
303     top: (top margin),
304     right: (right margin),
305     bottom: (bottom margin),
306     left: (left margin)
307 }</code></pre>
308 <p>May also be a string containing space-separated, numeric margin values. The order of the
309 sides associated with each value matches the way CSS processes margin values:</p>
310 <p><div class="mdetail-params"><ul>
311 <li>If there is only one value, it applies to all sides.</li>
312 <li>If there are two values, the top and bottom borders are set to the first value and the
313 right and left are set to the second.</li>
314 <li>If there are three values, the top is set to the first value, the left and right are set
315 to the second, and the bottom is set to the third.</li>
316 <li>If there are four values, they apply to the top, right, bottom, and left, respectively.</li>
317 </ul></div></p>
318 <p>Defaults to:</p><pre><code>{top:0, right:0, bottom:0, left:0}</code></pre></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#margins" ext:member="#margins" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-name"></a><b><a href="source/Field.html#cfg-Ext.form.Field-name">name</a></b> : String<div class="mdesc"><div class="short">The field's HTML name attribute (defaults to '').\r
319 Note: this property must be set if this field is to be automaticall...</div><div class="long">The field's HTML name attribute (defaults to '').
320 <b>Note</b>: this property must be set if this field is to be automatically included with
321 <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-submit" ext:member="submit" ext:cls="Ext.form.BasicForm">form submit()</a>.</div></div></td><td class="msource"><a href="output/Ext.form.Field.html#name" ext:member="#name" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-overCls"></a><b><a href="source/Component.html#cfg-Ext.Component-overCls">overCls</a></b> : String<div class="mdesc"><div class="short">An optional extra CSS class that will be added to this component's Element when the mouse moves\r
322 over the Element, and...</div><div class="long">An optional extra CSS class that will be added to this component's Element when the mouse moves
323 over the Element, and removed when the mouse moves out. (defaults to '').  This can be
324 useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.</div></div></td><td class="msource"><a href="output/Ext.Component.html#overCls" ext:member="#overCls" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-pageX"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-pageX">pageX</a></b> : Number<div class="mdesc">The page level x coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#pageX" ext:member="#pageX" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-pageY"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-pageY">pageY</a></b> : Number<div class="mdesc">The page level y coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#pageY" ext:member="#pageY" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-plugins"></a><b><a href="source/Component.html#cfg-Ext.Component-plugins">plugins</a></b> : Object/Array<div class="mdesc"><div class="short">An object or array of objects that will provide custom functionality for this component.  The only\r
325 requirement for a ...</div><div class="long">An object or array of objects that will provide custom functionality for this component.  The only
326 requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.
327 When a component is created, if any plugins are available, the component will call the init method on each
328 plugin, passing a reference to itself.  Each plugin can then call methods or respond to events on the
329 component as needed to provide its functionality.</div></div></td><td class="msource"><a href="output/Ext.Component.html#plugins" ext:member="#plugins" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-preventMark"></a><b><a href="source/Field.html#cfg-Ext.form.Field-preventMark">preventMark</a></b> : Boolean<div class="mdesc"><tt>true</tt> to disable <a href="output/Ext.form.Field.html#Ext.form.Field-markInvalid" ext:member="markInvalid" ext:cls="Ext.form.Field">marking the field invalid</a>.
330 Defaults to <tt>false</tt>.</div></td><td class="msource"><a href="output/Ext.form.Field.html#preventMark" ext:member="#preventMark" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-ptype"></a><b><a href="source/Component.html#cfg-Ext.Component-ptype">ptype</a></b> : String<div class="mdesc"><div class="short">The registered ptype to create. This config option is not used when passing\r
331 a config object into a constructor. This ...</div><div class="long">The registered <tt>ptype</tt> to create. This config option is not used when passing
332 a config object into a constructor. This config option is used only when
333 lazy instantiation is being used, and a Plugin is being
334 specified not as a fully instantiated Component, but as a <i>Component config
335 object</i>. The <tt>ptype</tt> will be looked up at render time up to determine what
336 type of Plugin to create.<br><br>
337 If you create your own Plugins, you may register them using
338 <a href="output/Ext.ComponentMgr.html#Ext.ComponentMgr-registerPlugin" ext:member="registerPlugin" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr.registerPlugin</a> in order to be able to
339 take advantage of lazy instantiation and rendering.</div></div></td><td class="msource"><a href="output/Ext.Component.html#ptype" ext:member="#ptype" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-ref"></a><b><a href="source/Component.html#cfg-Ext.Component-ref">ref</a></b> : String<div class="mdesc"><div class="short">A path specification, relative to the Component's ownerCt specifying into which\r
340 ancestor Container to place a named r...</div><div class="long"><p>A path specification, relative to the Component's <a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a> specifying into which
341 ancestor Container to place a named reference to this Component.</p>
342 <p>The ancestor axis can be traversed by using '/' characters in the path.
343 For example, to put a reference to a Toolbar Button into <i>the Panel which owns the Toolbar</i>:</p><pre><code><b>var</b> myGrid = <b>new</b> Ext.grid.EditorGridPanel({
344     title: <em>'My EditorGridPanel'</em>,
345     store: myStore,
346     colModel: myColModel,
347     tbar: [{
348         text: <em>'Save'</em>,
349         handler: saveChanges,
350         disabled: true,
351         ref: <em>'../saveButton'</em>
352     }],
353     listeners: {
354         afteredit: <b>function</b>() {
355 <i>//          The button reference is <b>in</b> the GridPanel</i>
356             myGrid.saveButton.enable();
357         }
358     }
359 });</code></pre>
360 <p>In the code above, if the ref had been <code><em>'saveButton'</em></code> the reference would
361 have been placed into the Toolbar. Each '/' in the ref moves up one level from the
362 Component's <a href="output/Ext.Component.html#Ext.Component-ownerCt" ext:member="ownerCt" ext:cls="Ext.Component">ownerCt</a>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ref" ext:member="#ref" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-region"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-region">region</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is rendered\r
363 by a Container which has been configured to use the...</div><div class="long"><p><b>Note</b>: this config is only used when this BoxComponent is rendered
364 by a Container which has been configured to use the <b><a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">BorderLayout</a></b>
365 layout manager (e.g. specifying <tt>layout:'border'</tt>).</p><br>
366 <p>See <a href="output/Ext.layout.BorderLayout.html" ext:cls="Ext.layout.BorderLayout">Ext.layout.BorderLayout</a> also.</p></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#region" ext:member="#region" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-renderTo"></a><b><a href="source/Component.html#cfg-Ext.Component-renderTo">renderTo</a></b> : Mixed<div class="mdesc"><div class="short">Specify the id of the element, a DOM element or an existing Element that this component\r
367 will be rendered into.\r
368 Notes ...</div><div class="long"><p>Specify the id of the element, a DOM element or an existing Element that this component
369 will be rendered into.</p><div><ul>
370 <li><b>Notes</b> : <ul>
371 <div class="sub-desc">Do <u>not</u> use this option if the Component is to be a child item of
372 a <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a>. It is the responsibility of the
373 <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a>'s <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout manager</a>
374 to render and manage its child items.</div>
375 <div class="sub-desc">When using this config, a call to render() is not required.</div>
376 </ul></li>
377 </ul></div>
378 <p>See <tt><a href="output/Ext.Component.html#Ext.Component-render" ext:member="render" ext:cls="Ext.Component">render</a></tt> also.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#renderTo" ext:member="#renderTo" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-stateEvents"></a><b><a href="source/Component.html#cfg-Ext.Component-stateEvents">stateEvents</a></b> : Array<div class="mdesc"><div class="short">An array of events that, when fired, should trigger this component to\r
379 save its state (defaults to none). stateEvents ...</div><div class="long"><p>An array of events that, when fired, should trigger this component to
380 save its state (defaults to none). <code>stateEvents</code> may be any type
381 of event supported by this component, including browser or custom events
382 (e.g., <tt>['click', 'customerchange']</tt>).</p>
383 <p>See <code><a href="output/Ext.Component.html#Ext.Component-stateful" ext:member="stateful" ext:cls="Ext.Component">stateful</a></code> for an explanation of saving and
384 restoring Component state.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#stateEvents" ext:member="#stateEvents" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-stateId"></a><b><a href="source/Component.html#cfg-Ext.Component-stateId">stateId</a></b> : String<div class="mdesc"><div class="short">The unique id for this component to use for state management purposes\r
385 (defaults to the component id if one was set, o...</div><div class="long">The unique id for this component to use for state management purposes
386 (defaults to the component id if one was set, otherwise null if the
387 component is using a generated id).
388 <p>See <code><a href="output/Ext.Component.html#Ext.Component-stateful" ext:member="stateful" ext:cls="Ext.Component">stateful</a></code> for an explanation of saving and
389 restoring Component state.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#stateId" ext:member="#stateId" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-stateful"></a><b><a href="source/Component.html#cfg-Ext.Component-stateful">stateful</a></b> : Boolean<div class="mdesc"><div class="short">A flag which causes the Component to attempt to restore the state of\r
390 internal properties from a saved state on startu...</div><div class="long"><p>A flag which causes the Component to attempt to restore the state of
391 internal properties from a saved state on startup. The component must have
392 either a <code><a href="output/Ext.Component.html#Ext.Component-stateId" ext:member="stateId" ext:cls="Ext.Component">stateId</a></code> or <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code> assigned
393 for state to be managed. Auto-generated ids are not guaranteed to be stable
394 across page loads and cannot be relied upon to save and restore the same
395 state for a component.<p>
396 <p>For state saving to work, the state manager's provider must have been
397 set to an implementation of <a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider">Ext.state.Provider</a> which overrides the
398 <a href="output/Ext.state.Provider.html#Ext.state.Provider-set" ext:member="set" ext:cls="Ext.state.Provider">set</a> and <a href="output/Ext.state.Provider.html#Ext.state.Provider-get" ext:member="get" ext:cls="Ext.state.Provider">get</a>
399 methods to save and recall name/value pairs. A built-in implementation,
400 <a href="output/Ext.state.CookieProvider.html" ext:cls="Ext.state.CookieProvider">Ext.state.CookieProvider</a> is available.</p>
401 <p>To set the state provider for the current page:</p>
402 <pre><code>Ext.state.Manager.setProvider(<b>new</b> Ext.state.CookieProvider({
403     expires: <b>new</b> Date(<b>new</b> Date().getTime()+(1000*60*60*24*7)), <i>//7 days from now</i>
404 }));</code></pre>
405 <p>A stateful Component attempts to save state when one of the events
406 listed in the <code><a href="output/Ext.Component.html#Ext.Component-stateEvents" ext:member="stateEvents" ext:cls="Ext.Component">stateEvents</a></code> configuration fires.</p>
407 <p>To save state, a stateful Component first serializes its state by
408 calling <b><code>getState</code></b>. By default, this function does
409 nothing. The developer must provide an implementation which returns an
410 object hash which represents the Component's restorable state.</p>
411 <p>The value yielded by getState is passed to <a href="output/Ext.state.Manager.html#Ext.state.Manager-set" ext:member="set" ext:cls="Ext.state.Manager">Ext.state.Manager.set</a>
412 which uses the configured <a href="output/Ext.state.Provider.html" ext:cls="Ext.state.Provider">Ext.state.Provider</a> to save the object
413 keyed by the Component's <code><a href="output/stateId.html" ext:cls="stateId">stateId</a></code>, or, if that is not
414 specified, its <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
415 <p>During construction, a stateful Component attempts to <i>restore</i>
416 its state by calling <a href="output/Ext.state.Manager.html#Ext.state.Manager-get" ext:member="get" ext:cls="Ext.state.Manager">Ext.state.Manager.get</a> passing the
417 <code><a href="output/Ext.Component.html#Ext.Component-stateId" ext:member="stateId" ext:cls="Ext.Component">stateId</a></code>, or, if that is not specified, the
418 <code><a href="output/Ext.Component.html#Ext.Component-id" ext:member="id" ext:cls="Ext.Component">id</a></code>.</p>
419 <p>The resulting object is passed to <b><code>applyState</code></b>.
420 The default implementation of <code>applyState</code> simply copies
421 properties into the object, but a developer may override this to support
422 more behaviour.</p>
423 <p>You can perform extra processing on state save and restore by attaching
424 handlers to the <a href="output/Ext.Component.html#Ext.Component-beforestaterestore" ext:member="beforestaterestore" ext:cls="Ext.Component">beforestaterestore</a>, <a href="output/Ext.Component.html#Ext.Component-staterestore" ext:member="staterestore" ext:cls="Ext.Component">staterestore</a>,
425 <a href="output/Ext.Component.html#Ext.Component-beforestatesave" ext:member="beforestatesave" ext:cls="Ext.Component">beforestatesave</a> and <a href="output/Ext.Component.html#Ext.Component-statesave" ext:member="statesave" ext:cls="Ext.Component">statesave</a> events.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#stateful" ext:member="#stateful" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-tabTip"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-tabTip">tabTip</a></b> : String<div class="mdesc"><div class="short">Note: this config is only used when this BoxComponent is a child item of a TabPanel.\r
426 A string to be used as innerHTML...</div><div class="long"><p><b>Note</b>: this config is only used when this BoxComponent is a child item of a TabPanel.</p>
427 A string to be used as innerHTML (html tags are accepted) to show in a tooltip when mousing over
428 the associated tab selector element. <a href="output/Ext.QuickTips.html" ext:cls="Ext.QuickTips">Ext.QuickTips</a>.init()
429 must be called in order for the tips to render.</div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#tabTip" ext:member="#tabTip" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-value"></a><b><a href="source/Field.html#cfg-Ext.form.Field-value">value</a></b> : Mixed<div class="mdesc">A value to initialize this field with (defaults to undefined).</div></td><td class="msource"><a href="output/Ext.form.Field.html#value" ext:member="#value" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-width"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-width">width</a></b> : Number<div class="mdesc"><div class="short">The width of this component in pixels (defaults to auto).\r
430 Note to express this dimension as a percentage or offset se...</div><div class="long">The width of this component in pixels (defaults to auto).
431 <b>Note</b> to express this dimension as a percentage or offset see <a href="output/Ext.Component.html#Ext.Component-anchor" ext:member="anchor" ext:cls="Ext.Component">Ext.Component.anchor</a>.</div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#width" ext:member="#width" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-x"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-x">x</a></b> : Number<div class="mdesc">The local x (left) coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#x" ext:member="#x" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-xtype"></a><b><a href="source/Component.html#cfg-Ext.Component-xtype">xtype</a></b> : String<div class="mdesc"><div class="short">The registered xtype to create. This config option is not used when passing\r
432 a config object into a constructor. This ...</div><div class="long">The registered <tt>xtype</tt> to create. This config option is not used when passing
433 a config object into a constructor. This config option is used only when
434 lazy instantiation is being used, and a child item of a Container is being
435 specified not as a fully instantiated Component, but as a <i>Component config
436 object</i>. The <tt>xtype</tt> will be looked up at render time up to determine what
437 type of child Component to create.<br><br>
438 The predefined xtypes are listed <a href="output/Ext.Component.html" ext:cls="Ext.Component">here</a>.
439 <br><br>
440 If you subclass Components to create your own Components, you may register
441 them using <a href="output/Ext.ComponentMgr.html#Ext.ComponentMgr-registerType" ext:member="registerType" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr.registerType</a> in order to be able to
442 take advantage of lazy instantiation and rendering.</div></div></td><td class="msource"><a href="output/Ext.Component.html#xtype" ext:member="#xtype" ext:cls="Ext.Component">Component</a></td></tr><tr class="config-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-y"></a><b><a href="source/BoxComponent.html#cfg-Ext.BoxComponent-y">y</a></b> : Number<div class="mdesc">The local y (top) coordinate for this component if contained within a positioning container.</div></td><td class="msource"><a href="output/Ext.BoxComponent.html#y" ext:member="#y" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr></tbody></table><a id="Ext.form.HtmlEditor-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-buttonTips"></a><b><a href="source/HtmlEditor.html#prop-Ext.form.HtmlEditor-buttonTips">buttonTips</a></b> : Object<div class="mdesc"><div class="short">Object collection of toolbar tooltips for the buttons in the editor. The key&#13;\r
443 is the command id associated with that ...</div><div class="long">Object collection of toolbar tooltips for the buttons in the editor. The key\r
444 is the command id associated with that button and the value is a valid QuickTips object.\r
445 For example:\r
446 <pre><code>{\r
447     bold : {\r
448         title: <em>'Bold (Ctrl+B)'</em>,\r
449         text: <em>'Make the selected text bold.'</em>,\r
450         cls: <em>'x-html-editor-tip'</em>\r
451     },\r
452     italic : {\r
453         title: <em>'Italic (Ctrl+I)'</em>,\r
454         text: <em>'Make the selected text italic.'</em>,\r
455         cls: <em>'x-html-editor-tip'</em>\r
456     },\r
457     ...</code></pre></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-el"></a><b><a href="source/Component.html#prop-Ext.Component-el">el</a></b> : Ext.Element<div class="mdesc"><div class="short">The Ext.Element which encapsulates this Component. Read-only.\r
458 This will usually be a &amp;lt;DIV&gt; element created by the ...</div><div class="long"><p>The <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> which encapsulates this Component. Read-only.</p>
459 <p>This will <i>usually</i> be a &lt;DIV> element created by the class's onRender method, but
460 that may be overridden using the <code><a href="output/Ext.Component.html#Ext.Component-autoEl" ext:member="autoEl" ext:cls="Ext.Component">autoEl</a></code> config.</p>
461 <br><p><b>Note</b>: this element will not be available until this Component has been rendered.</p><br>
462 <p>To add listeners for <b>DOM events</b> to this Component (as opposed to listeners
463 for this Component's own Observable events), see the <a href="output/Ext.util.Observable.html#Ext.util.Observable-listeners" ext:member="listeners" ext:cls="Ext.util.Observable">listeners</a>
464 config for a suggestion, or use a render listener directly:</p><pre><code><b>new</b> Ext.Panel({
465     title: <em>'The Clickable Panel'</em>,
466     listeners: {
467         render: <b>function</b>(p) {
468             <i>// Append the Panel to the click handler&#39;s argument list.</i>
469             p.getEl().on(<em>'click'</em>, handlePanelClick.createDelegate(null, [p], true));
470         },
471         single: true  <i>// Remove the listener after first invocation</i>
472     }
473 });</code></pre>
474 <p>See also <tt><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">getEl</a></p></div></div></td><td class="msource"><a href="output/Ext.Component.html#el" ext:member="#el" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-hidden"></a><b><a href="source/Component.html#prop-Ext.Component-hidden">hidden</a></b> : Boolean<div class="mdesc">True if this component is hidden. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#hidden" ext:member="#hidden" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-initialConfig"></a><b><a href="source/Component.html#prop-Ext.Component-initialConfig">initialConfig</a></b> : Object<div class="mdesc">This Component's initial configuration specification. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#initialConfig" ext:member="#initialConfig" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-originalValue"></a><b><a href="source/Field.html#prop-Ext.form.Field-originalValue">originalValue</a></b> : mixed<div class="mdesc"><div class="short">The original value of the field as configured in the value configuration, or\r
475 as loaded by the last form load operatio...</div><div class="long">The original value of the field as configured in the <a href="output/Ext.form.Field.html#Ext.form.Field-value" ext:member="value" ext:cls="Ext.form.Field">value</a> configuration, or
476 as loaded by the last form load operation if the form's <a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-trackResetOnLoad" ext:member="trackResetOnLoad" ext:cls="Ext.form.BasicForm">trackResetOnLoad</a>
477 setting is <code>true</code>.</div></div></td><td class="msource"><a href="output/Ext.form.Field.html#originalValue" ext:member="#originalValue" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="property-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-ownerCt"></a><b><a href="source/Component.html#prop-Ext.Component-ownerCt">ownerCt</a></b> : Ext.Container<div class="mdesc"><div class="short">This Component's owner Container (defaults to undefined, and is set automatically when\r
478 this Component is added to a C...</div><div class="long">This Component's owner <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a> (defaults to undefined, and is set automatically when
479 this Component is added to a Container).  Read-only.
480 <p><b>Note</b>: to access items within the Container see <tt><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></tt>.</p></div></div></td><td class="msource"><a href="output/Ext.Component.html#ownerCt" ext:member="#ownerCt" ext:cls="Ext.Component">Component</a></td></tr><tr class="property-row  inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-rendered"></a><b><a href="source/Component.html#prop-Ext.Component-rendered">rendered</a></b> : Boolean<div class="mdesc">True if this component has been rendered. Read-only.</div></td><td class="msource"><a href="output/Ext.Component.html#rendered" ext:member="#rendered" ext:cls="Ext.Component">Component</a></td></tr></tbody></table><a id="Ext.form.HtmlEditor-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-HtmlEditor"></a><b><a href="source/HtmlEditor.html#cls-Ext.form.HtmlEditor">HtmlEditor</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)\r
481     <div class="mdesc"><div class="short">Create a new HtmlEditor</div><div class="long">Create a new HtmlEditor<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div><table><tr><td class="label">xtype:</td><td class="hd-info">htmleditor</td></tr></table></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-addClass"></a><b><a href="source/Component.html#method-Ext.Component-addClass">addClass</a></b>(&nbsp;<code>string&nbsp;cls</code>&nbsp;)\r
482     :\r
483                                         Ext.Component<div class="mdesc"><div class="short">Adds a CSS class to the component's underlying element.</div><div class="long">Adds a CSS class to the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to add</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#addClass" ext:member="#addClass" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>(&nbsp;<code>Object|String&nbsp;o</code>,&nbsp;<code>string&nbsp;Optional.</code>&nbsp;)\r
484     :\r
485                                         void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
486 or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
487 Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
488     :\r
489                                         void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
490 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
491 properties. This may contain any of the following properties:<ul>
492 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
493 <b>If omitted, defaults to the object which fired the event.</b></div></li>
494 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
495 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
496 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
497 by the specified number of milliseconds. If the event fires again within that time, the original
498 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
499 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
500 if the event was bubbled up from a child Observable.</div></li>
501 </ul><br>
502 <p>
503 <b>Combining Options</b><br>
504 Using the options argument, it is possible to combine different types of listeners:<br>
505 <br>
506 A delayed, one-time listener.
507 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
508 single: true,
509 delay: 100
510 });</code></pre>
511 <p>
512 <b>Attaching multiple handlers in 1 call</b><br>
513 The method also allows for a single argument to be passed which is a config object containing properties
514 which specify multiple handlers.
515 <p>
516 <pre><code>myGridPanel.on({
517 <em>'click'</em> : {
518     fn: this.onClick,
519     scope: this,
520     delay: 100
521 },
522 <em>'mouseover'</em> : {
523     fn: this.onMouseOver,
524     scope: this
525 },
526 <em>'mouseout'</em> : {
527     fn: this.onMouseOut,
528     scope: this
529 }
530 });</code></pre>
531 <p>
532 Or a shorthand syntax:<br>
533 <pre><code>myGridPanel.on({
534 <em>'click'</em> : this.onClick,
535 <em>'mouseover'</em> : this.onMouseOver,
536 <em>'mouseout'</em> : this.onMouseOut,
537  scope: this
538 });</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-cleanHtml"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-cleanHtml">cleanHtml</a></b>(&nbsp;<code>String&nbsp;html</code>&nbsp;)\r
539     :\r
540                                         String<div class="mdesc"><div class="short">Protected method that will not generally be called directly. If you need/want&#13;\r
541 custom HTML cleanup, this is the metho...</div><div class="long">Protected method that will not generally be called directly. If you need/want\r
542 custom HTML cleanup, this is the method you should override.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>html</code> : String<div class="sub-desc">The HTML to be cleaned</div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The cleaned HTML</div></li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-cloneConfig"></a><b><a href="source/Component.html#method-Ext.Component-cloneConfig">cloneConfig</a></b>(&nbsp;<code>Object&nbsp;overrides</code>&nbsp;)\r
543     :\r
544                                         Ext.Component<div class="mdesc"><div class="short">Clone the current component using the original config values passed into this instance by default.</div><div class="long">Clone the current component using the original config values passed into this instance by default.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>overrides</code> : Object<div class="sub-desc">A new config containing any properties to override in the cloned version.
545 An id property can be passed on this object, otherwise one will be generated to avoid duplicates.</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">clone The cloned copy of this component</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#cloneConfig" ext:member="#cloneConfig" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-destroy"></a><b><a href="source/Component.html#method-Ext.Component-destroy">destroy</a></b>()\r
546     :\r
547                                         void<div class="mdesc"><div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,\r
548 removing the c...</div><div class="long">Destroys this component by purging any event listeners, removing the component's element from the DOM,
549 removing the component from its <a href="output/Ext.Container.html" ext:cls="Ext.Container">Ext.Container</a> (if applicable) and unregistering it from
550 <a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a>.  Destruction is generally handled automatically by the framework and this method
551 should usually not need to be called directly.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#destroy" ext:member="#destroy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>(&nbsp;<code>Object&nbsp;events</code>&nbsp;)\r
552     :\r
553                                         void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling&#13;\r
554 this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
555 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
556 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default\r
557 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
558 access the required target more quickly.</p>\r
559 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
560 <i>//  Add functionality to Field<em>'s initComponent to enable the change event to bubble\r</i>
561     initComponent: Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
562         this.enableBubble('</em>change<em>');\r
563     }),\r
564 \r
565 <i>//  We know that we want Field'</em>s events to bubble directly to the FormPanel.\r</i>
566     getBubbleTarget: <b>function</b>() {\r
567         <b>if</b> (!this.formPanel) {\r
568             this.formPanel = this.findParentByType(<em>'form'</em>);\r
569         }\r
570         <b>return</b> this.formPanel;\r
571     }\r
572 });\r
573 \r
574 <b>var</b> myForm = <b>new</b> Ext.formPanel({\r
575     title: <em>'User Details'</em>,\r
576     items: [{\r
577         ...\r
578     }],\r
579     listeners: {\r
580         change: <b>function</b>() {\r
581 <i>//          Title goes red <b>if</b> form has been modified.\r</i>
582             myForm.header.setStyle(<em>"color"</em>, <em>"red"</em>);\r
583         }\r
584     }\r
585 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-execCmd"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-execCmd">execCmd</a></b>(&nbsp;<code>String&nbsp;cmd</code>,&nbsp;<span title="Optional" class="optional">[<code>String/Boolean&nbsp;value</code>]</span>&nbsp;)\r
586     :\r
587                                         void<div class="mdesc"><div class="short">Executes a Midas editor command directly on the editor document.&#13;\r
588 For visual commands, you should use relayCmd instea...</div><div class="long">Executes a Midas editor command directly on the editor document.\r
589 For visual commands, you should use <a href="output/Ext.form.HtmlEditor.html#Ext.form.HtmlEditor-relayCmd" ext:member="relayCmd" ext:cls="Ext.form.HtmlEditor">relayCmd</a> instead.\r
590 <b>This should only be called after the editor is initialized.</b><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cmd</code> : String<div class="sub-desc">The Midas command</div></li><li><code>value</code> : String/Boolean<div class="sub-desc">(optional) The value to pass to the command (defaults to null)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-findParentBy"></a><b><a href="source/Component.html#method-Ext.Component-findParentBy">findParentBy</a></b>(&nbsp;<code>Function&nbsp;fn</code>&nbsp;)\r
591     :\r
592                                         Ext.Container<div class="mdesc"><div class="short">Find a container above this component at any level by a custom function. If the passed function returns\r
593 true, the con...</div><div class="long">Find a container above this component at any level by a custom function. If the passed function returns
594 true, the container will be returned.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>fn</code> : Function<div class="sub-desc">The custom function to call with the arguments (container, this component).</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">The first Container for which the custom function returns true</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#findParentBy" ext:member="#findParentBy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-findParentByType"></a><b><a href="source/Component.html#method-Ext.Component-findParentByType">findParentByType</a></b>(&nbsp;<code>String/Class&nbsp;xtype</code>&nbsp;)\r
595     :\r
596                                         Ext.Container<div class="mdesc"><div class="short">Find a container above this component at any level by xtype or class</div><div class="long">Find a container above this component at any level by xtype or class<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>xtype</code> : String/Class<div class="sub-desc">The xtype string for a component, or the class of the component directly</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">The first Container which matches the given xtype or class</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#findParentByType" ext:member="#findParentByType" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)\r
597     :\r
598                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).\r
599 An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
600 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
601 by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-focus"></a><b><a href="source/Component.html#method-Ext.Component-focus">focus</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;selectText</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Boolean/Number&nbsp;delay</code>]</span>&nbsp;)\r
602     :\r
603                                         Ext.Component<div class="mdesc"><div class="short">Try to focus this component.</div><div class="long">Try to focus this component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>selectText</code> : Boolean<div class="sub-desc">(optional) If applicable, true to also select the text in this component</div></li><li><code>delay</code> : Boolean/Number<div class="sub-desc">(optional) Delay the focus this number of milliseconds (true for 10 milliseconds)</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#focus" ext:member="#focus" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getBox">getBox</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;local</code>]</span>&nbsp;)\r
604     :\r
605                                         Object<div class="mdesc"><div class="short">Gets the current box measurements of the component's underlying element.</div><div class="long">Gets the current box measurements of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">box An object in the format {x, y, width, height}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getBox" ext:member="#getBox" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getBubbleTarget"></a><b><a href="source/Component.html#method-Ext.Component-getBubbleTarget">getBubbleTarget</a></b>()\r
606     :\r
607                                         Ext.Container<div class="mdesc"><div class="short">Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.</div><div class="long">Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Container</code><div class="sub-desc">the Container which owns this Component.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getBubbleTarget" ext:member="#getBubbleTarget" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-getDocMarkup"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-getDocMarkup">getDocMarkup</a></b>()\r
608     :\r
609                                         void<div class="mdesc"><div class="short">Protected method that will not generally be called directly. It&#13;\r
610 is called when the editor initializes the iframe wit...</div><div class="long">Protected method that will not generally be called directly. It\r
611 is called when the editor initializes the iframe with HTML contents. Override this method if you\r
612 want to change the initialization markup of the iframe (e.g. to add stylesheets).<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getEl"></a><b><a href="source/Component.html#method-Ext.Component-getEl">getEl</a></b>()\r
613     :\r
614                                         Ext.Element<div class="mdesc"><div class="short">Returns the Ext.Element which encapsulates this Component.\r
615 This will usually be a &amp;lt;DIV&gt; element created by the cla...</div><div class="long"><p>Returns the <a href="output/Ext.Element.html" ext:cls="Ext.Element">Ext.Element</a> which encapsulates this Component.</p>
616 <p>This will <i>usually</i> be a &lt;DIV> element created by the class's onRender method, but
617 that may be overridden using the <a href="output/Ext.Component.html#Ext.Component-autoEl" ext:member="autoEl" ext:cls="Ext.Component">autoEl</a> config.</p>
618 <br><p><b>Note</b>: this element will not be available until this Component has been rendered.</p><br>
619 <p>To add listeners for <b>DOM events</b> to this Component (as opposed to listeners
620 for this Component's own Observable events), see the <a href="output/Ext.Component.html#Ext.Component-listeners" ext:member="listeners" ext:cls="Ext.Component">listeners</a> config for a suggestion,
621 or use a render listener directly:</p><pre><code><b>new</b> Ext.Panel({
622     title: <em>'The Clickable Panel'</em>,
623     listeners: {
624         render: <b>function</b>(p) {
625             <i>// Append the Panel to the click handler&#39;s argument list.</i>
626             p.getEl().on(<em>'click'</em>, handlePanelClick.createDelegate(null, [p], true));
627         },
628         single: true  <i>// Remove the listener after first invocation</i>
629     }
630 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Element</code><div class="sub-desc">The Element which encapsulates this Component.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getEl" ext:member="#getEl" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getHeight">getHeight</a></b>()\r
631     :\r
632                                         Number<div class="mdesc"><div class="short">Gets the current height of the component's underlying element.</div><div class="long">Gets the current height of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getHeight" ext:member="#getHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getId"></a><b><a href="source/Component.html#method-Ext.Component-getId">getId</a></b>()\r
633     :\r
634                                         String<div class="mdesc"><div class="short">Returns the id of this component or automatically generates and\r
635 returns an id if an id is not defined yet:'ext-comp-'...</div><div class="long">Returns the <code>id</code> of this component or automatically generates and
636 returns an <code>id</code> if an <code>id</code> is not defined yet:<pre><code><em>'ext-comp-'</em> + (++Ext.Component.AUTO_ID)</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">id</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getId" ext:member="#getId" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getItemId"></a><b><a href="source/Component.html#method-Ext.Component-getItemId">getItemId</a></b>()\r
637     :\r
638                                         String<div class="mdesc"><div class="short">Returns the itemId of this component.  If an\r
639 itemId was not assigned through configuration the\r
640 id is returned using g...</div><div class="long">Returns the <code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code> of this component.  If an
641 <code><a href="output/Ext.Component.html#Ext.Component-itemId" ext:member="itemId" ext:cls="Ext.Component">itemId</a></code> was not assigned through configuration the
642 <code>id</code> is returned using <code><a href="output/Ext.Component.html#Ext.Component-getId" ext:member="getId" ext:cls="Ext.Component">getId</a></code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getItemId" ext:member="#getItemId" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-getName"></a><b><a href="source/Field.html#method-Ext.form.Field-getName">getName</a></b>()\r
643     :\r
644                                         String<div class="mdesc"><div class="short">Returns the name or hiddenName\r
645 attribute of the field if available.</div><div class="long">Returns the <a href="output/Ext.form.Field.html#Ext.form.Field-name" ext:member="name" ext:cls="Ext.form.Field">name</a> or <a href="output/Ext.form.ComboBox.html#Ext.form.ComboBox-hiddenName" ext:member="hiddenName" ext:cls="Ext.form.ComboBox">hiddenName</a>
646 attribute of the field if available.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">name The field {@link Ext.form.Field#name name} or {@link Ext.form.ComboBox#hiddenName hiddenName}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#getName" ext:member="#getName" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getOuterSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getOuterSize">getOuterSize</a></b>()\r
647     :\r
648                                         Object<div class="mdesc"><div class="short">Gets the current size of the component's underlying element, including space taken by its margins.</div><div class="long">Gets the current size of the component's underlying element, including space taken by its margins.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width + left/right margins), height: (element height + top/bottom margins)}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getOuterSize" ext:member="#getOuterSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getPosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getPosition">getPosition</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;local</code>]</span>&nbsp;)\r
649     :\r
650                                         Array<div class="mdesc"><div class="short">Gets the current XY position of the component's underlying element.</div><div class="long">Gets the current XY position of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>local</code> : Boolean<div class="sub-desc">(optional) If true the element's left and top are returned instead of page XY (defaults to false)</div></li></ul><strong>Returns:</strong><ul><li><code>Array</code><div class="sub-desc">The XY position of the element (e.g., [100, 200])</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getPosition" ext:member="#getPosition" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-getRawValue"></a><b><a href="source/Field.html#method-Ext.form.Field-getRawValue">getRawValue</a></b>()\r
651     :\r
652                                         Mixed<div class="mdesc"><div class="short">Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see getValue...</div><div class="long">Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see <a href="output/Ext.form.Field.html#Ext.form.Field-getValue" ext:member="getValue" ext:cls="Ext.form.Field">getValue</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Mixed</code><div class="sub-desc">value The field value</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#getRawValue" ext:member="#getRawValue" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getResizeEl"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getResizeEl">getResizeEl</a></b>()\r
653     :\r
654                                         void<div class="mdesc"><div class="short">Returns the outermost Element of this Component which defines the Components overall size.\r
655 Usually this will return t...</div><div class="long"><p>Returns the outermost Element of this Component which defines the Components overall size.</p>
656 <p><i>Usually</i> this will return the same Element as <code><a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">getEl</a></code>,
657 but in some cases, a Component may have some more wrapping Elements around its main
658 active Element.</p>
659 <p>An example is a ComboBox. It is encased in a <i>wrapping</i> Element which
660 contains both the <code>&lt;input></code> Element (which is what would be returned
661 by its <code><a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">getEl</a></code> method, <i>and</i> the trigger button Element.
662 This Element is returned as the <code>resizeEl</code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getResizeEl" ext:member="#getResizeEl" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getSize">getSize</a></b>()\r
663     :\r
664                                         Object<div class="mdesc"><div class="short">Gets the current size of the component's underlying element.</div><div class="long">Gets the current size of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Object</code><div class="sub-desc">An object containing the element's size {width: (element width), height: (element height)}</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getSize" ext:member="#getSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-getToolbar"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-getToolbar">getToolbar</a></b>()\r
665     :\r
666                                         Ext.Toolbar<div class="mdesc"><div class="short">Returns the editor's toolbar. This is only available after the editor has been rendered.</div><div class="long">Returns the editor's toolbar. <b>This is only available after the editor has been rendered.</b><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Toolbar</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-getValue"></a><b><a href="source/Field.html#method-Ext.form.Field-getValue">getValue</a></b>()\r
667     :\r
668                                         Mixed<div class="mdesc"><div class="short">Returns the normalized data value (undefined or emptyText will be returned as '').  To return the raw value see getRa...</div><div class="long">Returns the normalized data value (undefined or emptyText will be returned as '').  To return the raw value see <a href="output/Ext.form.Field.html#Ext.form.Field-getRawValue" ext:member="getRawValue" ext:cls="Ext.form.Field">getRawValue</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Mixed</code><div class="sub-desc">value The field value</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#getValue" ext:member="#getValue" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-getWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-getWidth">getWidth</a></b>()\r
669     :\r
670                                         Number<div class="mdesc"><div class="short">Gets the current width of the component's underlying element.</div><div class="long">Gets the current width of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#getWidth" ext:member="#getWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getXType"></a><b><a href="source/Component.html#method-Ext.Component-getXType">getXType</a></b>()\r
671     :\r
672                                         String<div class="mdesc"><div class="short">Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all\r
673 available xtypes, see the Ex...</div><div class="long">Gets the xtype for this component as registered with <a href="output/Ext.ComponentMgr.html" ext:cls="Ext.ComponentMgr">Ext.ComponentMgr</a>. For a list of all
674 available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header. Example usage:
675 <pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
676 alert(t.getXType());  <i>// alerts <em>'textfield'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The xtype</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getXType" ext:member="#getXType" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-getXTypes"></a><b><a href="source/Component.html#method-Ext.Component-getXTypes">getXTypes</a></b>()\r
677     :\r
678                                         String<div class="mdesc"><div class="short">Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all\r
679 available xtypes, see the Ext...</div><div class="long"><p>Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all
680 available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header.</p>
681 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
682 to participate in determination of inherited xtypes.</b></p>
683 <p>Example usage:</p>
684 <pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
685 alert(t.getXTypes());  <i>// alerts <em>'component/box/field/textfield'</em></i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc">The xtype hierarchy string</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#getXTypes" ext:member="#getXTypes" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>&nbsp;)\r
686     :\r
687                                         Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-hide"></a><b><a href="source/Component.html#method-Ext.Component-hide">hide</a></b>()\r
688     :\r
689                                         Ext.Component<div class="mdesc"><div class="short">Hide this component.  Listen to the 'beforehide' event and return\r
690 false to cancel hiding the component.  Fires the 'h...</div><div class="long">Hide this component.  Listen to the '<a href="output/Ext.Component.html#Ext.Component-beforehide" ext:member="beforehide" ext:cls="Ext.Component">beforehide</a>' event and return
691 <tt>false</tt> to cancel hiding the component.  Fires the '<a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a>'
692 event after hiding the component. Note this method is called internally if
693 the component is configured to be <code><a href="output/Ext.Component.html#Ext.Component-hidden" ext:member="hidden" ext:cls="Ext.Component">hidden</a></code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#hide" ext:member="#hide" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-insertAtCursor"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-insertAtCursor">insertAtCursor</a></b>(&nbsp;<code>String&nbsp;text</code>&nbsp;)\r
694     :\r
695                                         void<div class="mdesc"><div class="short">Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated&#13;\r
696 to insert...</div><div class="long">Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated\r
697 to insert text.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>text</code> : String<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-isDirty"></a><b><a href="source/Field.html#method-Ext.form.Field-isDirty">isDirty</a></b>()\r
698     :\r
699                                         Boolean<div class="mdesc"><div class="short">Returns true if the value of this Field has been changed from its original value.\r
700 Will return false if the field is d...</div><div class="long"><p>Returns true if the value of this Field has been changed from its original value.
701 Will return false if the field is disabled or has not been rendered yet.</p>
702 <p>Note that if the owning <a href="output/Ext.form.BasicForm.html" ext:cls="Ext.form.BasicForm">form</a> was configured with
703 <a href="output/Ext.form.BasicForm.html" ext:cls="Ext.form.BasicForm">Ext.form.BasicForm</a>.<a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-trackResetOnLoad" ext:member="trackResetOnLoad" ext:cls="Ext.form.BasicForm">trackResetOnLoad</a>
704 then the <i>original value</i> is updated when the values are loaded by
705 <a href="output/Ext.form.BasicForm.html" ext:cls="Ext.form.BasicForm">Ext.form.BasicForm</a>.<a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-setValues" ext:member="setValues" ext:cls="Ext.form.BasicForm">setValues</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if this field has been changed from its original value (and\r
706 is not disabled), false otherwise.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#isDirty" ext:member="#isDirty" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-isValid"></a><b><a href="source/Field.html#method-Ext.form.Field-isValid">isValid</a></b>(&nbsp;<code>Boolean&nbsp;preventMark</code>&nbsp;)\r
707     :\r
708                                         Boolean<div class="mdesc"><div class="short">Returns whether or not the field value is currently valid by\r
709 validating the processed value\r
710 of the field. Note: disab...</div><div class="long">Returns whether or not the field value is currently valid by
711 <a href="output/Ext.form.Field.html#Ext.form.Field-validateValue" ext:member="validateValue" ext:cls="Ext.form.Field">validating</a> the <a href="output/Ext.form.Field.html#Ext.form.Field-processValue" ext:member="processValue" ext:cls="Ext.form.Field">processed value</a>
712 of the field. <b>Note</b>: <a href="output/Ext.form.Field.html#Ext.form.Field-disabled" ext:member="disabled" ext:cls="Ext.form.Field">disabled</a> fields are ignored.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>preventMark</code> : Boolean<div class="sub-desc">True to disable marking the field invalid</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the value is valid, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#isValid" ext:member="#isValid" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-isVisible"></a><b><a href="source/Component.html#method-Ext.Component-isVisible">isVisible</a></b>()\r
713     :\r
714                                         Boolean<div class="mdesc"><div class="short">Returns true if this component is visible.</div><div class="long">Returns true if this component is visible.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if this component is visible, false otherwise.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#isVisible" ext:member="#isVisible" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-isXType"></a><b><a href="source/Component.html#method-Ext.Component-isXType">isXType</a></b>(&nbsp;<code>String&nbsp;xtype</code>,&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;shallow</code>]</span>&nbsp;)\r
715     :\r
716                                         Boolean<div class="mdesc"><div class="short">Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended\r
717 from th...</div><div class="long"><p>Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended
718 from the xtype (default) or whether it is directly of the xtype specified (shallow = true).</p>
719 <p><b>If using your own subclasses, be aware that a Component must register its own xtype
720 to participate in determination of inherited xtypes.</b></p>
721 <p>For a list of all available xtypes, see the <a href="output/Ext.Component.html" ext:cls="Ext.Component">Ext.Component</a> header.</p>
722 <p>Example usage:</p>
723 <pre><code><b>var</b> t = <b>new</b> Ext.form.TextField();
724 <b>var</b> isText = t.isXType(<em>'textfield'</em>);        <i>// true</i>
725 <b>var</b> isBoxSubclass = t.isXType(<em>'box'</em>);       <i>// true, descended from BoxComponent</i>
726 <b>var</b> isBoxInstance = t.isXType(<em>'box'</em>, true); <i>// false, not a direct BoxComponent instance</i></code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>xtype</code> : String<div class="sub-desc">The xtype to check for this Component</div></li><li><code>shallow</code> : Boolean<div class="sub-desc">(optional) False to check whether this Component is descended from the xtype (this is
727 the default), or true to check whether this Component is directly of the specified xtype.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if this component descends from the specified xtype, false otherwise.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#isXType" ext:member="#isXType" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-nextSibling"></a><b><a href="source/Component.html#method-Ext.Component-nextSibling">nextSibling</a></b>()\r
728     :\r
729                                         Ext.Component<div class="mdesc"><div class="short">Returns the next component in the owning container</div><div class="long">Returns the next component in the owning container<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#nextSibling" ext:member="#nextSibling" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)\r
730     :\r
731                                         void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
732 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-previousSibling"></a><b><a href="source/Component.html#method-Ext.Component-previousSibling">previousSibling</a></b>()\r
733     :\r
734                                         Ext.Component<div class="mdesc"><div class="short">Returns the previous component in the owning container</div><div class="long">Returns the previous component in the owning container<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#previousSibling" ext:member="#previousSibling" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-processValue"></a><b><a href="source/Field.html#method-Ext.form.Field-processValue">processValue</a></b>(&nbsp;<code>Mixed&nbsp;value</code>&nbsp;)\r
735     :\r
736                                         void<div class="mdesc"><div class="short">This method should only be overridden if necessary to prepare raw values\r
737 for validation (see validate and isValid).  ...</div><div class="long">This method should only be overridden if necessary to prepare raw values
738 for validation (see <a href="output/Ext.form.Field.html#Ext.form.Field-validate" ext:member="validate" ext:cls="Ext.form.Field">validate</a> and <a href="output/Ext.form.Field.html#Ext.form.Field-isValid" ext:member="isValid" ext:cls="Ext.form.Field">isValid</a>).  This method
739 is expected to return the processed value for the field which will
740 be used for validation (see validateValue method).<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Mixed<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#processValue" ext:member="#processValue" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()\r
741     :\r
742                                         void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-pushValue"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-pushValue">pushValue</a></b>()\r
743     :\r
744                                         void<div class="mdesc"><div class="short">Protected method that will not generally be called directly. Pushes the value of the textarea&#13;\r
745 into the iframe editor...</div><div class="long">Protected method that will not generally be called directly. Pushes the value of the textarea\r
746 into the iframe editor.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-relayCmd"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-relayCmd">relayCmd</a></b>(&nbsp;<code>String&nbsp;cmd</code>,&nbsp;<span title="Optional" class="optional">[<code>String/Boolean&nbsp;value</code>]</span>&nbsp;)\r
747     :\r
748                                         void<div class="mdesc"><div class="short">Executes a Midas editor command on the editor document and performs necessary focus and&#13;\r
749 toolbar updates. This should...</div><div class="long">Executes a Midas editor command on the editor document and performs necessary focus and\r
750 toolbar updates. <b>This should only be called after the editor is initialized.</b><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cmd</code> : String<div class="sub-desc">The Midas command</div></li><li><code>value</code> : String/Boolean<div class="sub-desc">(optional) The value to pass to the command (defaults to null)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>(&nbsp;<code>Object&nbsp;o</code>,&nbsp;<code>Array&nbsp;events</code>&nbsp;)\r
751     :\r
752                                         void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-removeClass"></a><b><a href="source/Component.html#method-Ext.Component-removeClass">removeClass</a></b>(&nbsp;<code>string&nbsp;cls</code>&nbsp;)\r
753     :\r
754                                         Ext.Component<div class="mdesc"><div class="short">Removes a CSS class from the component's underlying element.</div><div class="long">Removes a CSS class from the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>cls</code> : string<div class="sub-desc">The CSS class name to remove</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#removeClass" ext:member="#removeClass" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
755     :\r
756                                         void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-render"></a><b><a href="source/Component.html#method-Ext.Component-render">render</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Element/HTMLElement/String&nbsp;container</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>String/Number&nbsp;position</code>]</span>&nbsp;)\r
757     :\r
758                                         void<div class="mdesc"><div class="short">Render this Component into the passed HTML element.\r
759 If you are using a Container object to house this Component, then...</div><div class="long"><p>Render this Component into the passed HTML element.</p>
760 <p><b>If you are using a <a href="output/Ext.Container.html" ext:cls="Ext.Container">Container</a> object to house this Component, then
761 do not use the render method.</b></p>
762 <p>A Container's child Components are rendered by that Container's
763 <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> manager when the Container is first rendered.</p>
764 <p>Certain layout managers allow dynamic addition of child components. Those that do
765 include <a href="output/Ext.layout.CardLayout.html" ext:cls="Ext.layout.CardLayout">Ext.layout.CardLayout</a>, <a href="output/Ext.layout.AnchorLayout.html" ext:cls="Ext.layout.AnchorLayout">Ext.layout.AnchorLayout</a>,
766 <a href="output/Ext.layout.FormLayout.html" ext:cls="Ext.layout.FormLayout">Ext.layout.FormLayout</a>, <a href="output/Ext.layout.TableLayout.html" ext:cls="Ext.layout.TableLayout">Ext.layout.TableLayout</a>.</p>
767 <p>If the Container is already rendered when a new child Component is added, you may need to call
768 the Container's <a href="output/Ext.Container.html#Ext.Container-doLayout" ext:member="doLayout" ext:cls="Ext.Container">doLayout</a> to refresh the view which causes any
769 unrendered child Components to be rendered. This is required so that you can add multiple
770 child components if needed while only refreshing the layout once.</p>
771 <p>When creating complex UIs, it is important to remember that sizing and positioning
772 of child items is the responsibility of the Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> manager.
773 If you expect child items to be sized in response to user interactions, you must
774 configure the Container with a layout manager which creates and manages the type of layout you
775 have in mind.</p>
776 <p><b>Omitting the Container's <a href="output/Ext.Container.html#Ext.Container-layout" ext:member="layout" ext:cls="Ext.Container">layout</a> config means that a basic
777 layout manager is used which does nothing but render child components sequentially into the
778 Container. No sizing or positioning will be performed in this situation.</b></p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>container</code> : Element/HTMLElement/String<div class="sub-desc">(optional) The element this Component should be
779 rendered into. If it is being created from existing markup, this should be omitted.</div></li><li><code>position</code> : String/Number<div class="sub-desc">(optional) The element ID or DOM node index within the container <b>before</b>
780 which this component will be inserted (defaults to appending to the end of the container)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#render" ext:member="#render" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-reset"></a><b><a href="source/Field.html#method-Ext.form.Field-reset">reset</a></b>()\r
781     :\r
782                                         void<div class="mdesc"><div class="short">Resets the current field value to the originally loaded value and clears any validation messages.\r
783 See Ext.form.BasicF...</div><div class="long">Resets the current field value to the originally loaded value and clears any validation messages.
784 See <a href="output/Ext.form.BasicForm.html" ext:cls="Ext.form.BasicForm">Ext.form.BasicForm</a>.<a href="output/Ext.form.BasicForm.html#Ext.form.BasicForm-trackResetOnLoad" ext:member="trackResetOnLoad" ext:cls="Ext.form.BasicForm">trackResetOnLoad</a><div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#reset" ext:member="#reset" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()\r
785     :\r
786                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)\r
787 If events were suspended using the queueSuspended parameter, then all\r
788 event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
789 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
790 events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setHeight"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setHeight">setHeight</a></b>(&nbsp;<code>Number&nbsp;height</code>&nbsp;)\r
791     :\r
792                                         Ext.BoxComponent<div class="mdesc"><div class="short">Sets the height of the component.  This method fires the resize event.</div><div class="long">Sets the height of the component.  This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>height</code> : Number<div class="sub-desc">The new height to set. This may be one of:<div class="mdetail-params"><ul>
793 <li>A Number specifying the new height in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
794 <li>A String used to set the CSS height style.</li>
795 <li><i>undefined</i> to leave the height unchanged.</li>
796 </ul></div></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setHeight" ext:member="#setHeight" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setPagePosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setPagePosition">setPagePosition</a></b>(&nbsp;<code>Number&nbsp;x</code>,&nbsp;<code>Number&nbsp;y</code>&nbsp;)\r
797     :\r
798                                         Ext.BoxComponent<div class="mdesc"><div class="short">Sets the page XY position of the component.  To set the left and top instead, use setPosition.\r
799 This method fires the ...</div><div class="long">Sets the page XY position of the component.  To set the left and top instead, use <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-setPosition" ext:member="setPosition" ext:cls="Ext.BoxComponent">setPosition</a>.
800 This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-move" ext:member="move" ext:cls="Ext.BoxComponent">move</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setPagePosition" ext:member="#setPagePosition" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setPosition"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setPosition">setPosition</a></b>(&nbsp;<code>Number&nbsp;left</code>,&nbsp;<code>Number&nbsp;top</code>&nbsp;)\r
801     :\r
802                                         Ext.BoxComponent<div class="mdesc"><div class="short">Sets the left and top of the component.  To set the page XY position instead, use setPagePosition.\r
803 This method fires ...</div><div class="long">Sets the left and top of the component.  To set the page XY position instead, use <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-setPagePosition" ext:member="setPagePosition" ext:cls="Ext.BoxComponent">setPagePosition</a>.
804 This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-move" ext:member="move" ext:cls="Ext.BoxComponent">move</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>left</code> : Number<div class="sub-desc">The new left</div></li><li><code>top</code> : Number<div class="sub-desc">The new top</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setPosition" ext:member="#setPosition" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-setRawValue"></a><b><a href="source/Field.html#method-Ext.form.Field-setRawValue">setRawValue</a></b>(&nbsp;<code>Mixed&nbsp;value</code>&nbsp;)\r
805     :\r
806                                         Mixed<div class="mdesc"><div class="short">Sets the underlying DOM field's value directly, bypassing validation.  To set the value with validation see setValue.</div><div class="long">Sets the underlying DOM field's value directly, bypassing validation.  To set the value with validation see <a href="output/Ext.form.Field.html#Ext.form.Field-setValue" ext:member="setValue" ext:cls="Ext.form.Field">setValue</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Mixed<div class="sub-desc">The value to set</div></li></ul><strong>Returns:</strong><ul><li><code>Mixed</code><div class="sub-desc">value The field value that is set</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#setRawValue" ext:member="#setRawValue" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setSize">setSize</a></b>(&nbsp;<code>Mixed&nbsp;width</code>,&nbsp;<code>Mixed&nbsp;height</code>&nbsp;)\r
807     :\r
808                                         Ext.BoxComponent<div class="mdesc"><div class="short">Sets the width and height of this BoxComponent. This method fires the resize event. This method can accept\r
809 either wid...</div><div class="long">Sets the width and height of this BoxComponent. This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event. This method can accept
810 either width and height as separate arguments, or you can pass a size object like <code>{width:10, height:20}</code>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>width</code> : Mixed<div class="sub-desc">The new width to set. This may be one of:<div class="mdetail-params"><ul>
811 <li>A Number specifying the new width in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
812 <li>A String used to set the CSS width style.</li>
813 <li>A size object in the format <code>{width: widthValue, height: heightValue}</code>.</li>
814 <li><code>undefined</code> to leave the width unchanged.</li>
815 </ul></div></div></li><li><code>height</code> : Mixed<div class="sub-desc">The new height to set (not required if a size object is passed as the first arg).
816 This may be one of:<div class="mdetail-params"><ul>
817 <li>A Number specifying the new height in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
818 <li>A String used to set the CSS height style. Animation may <b>not</b> be used.</li>
819 <li><code>undefined</code> to leave the height unchanged.</li>
820 </ul></div></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setSize" ext:member="#setSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-setValue"></a><b><a href="source/Field.html#method-Ext.form.Field-setValue">setValue</a></b>(&nbsp;<code>Mixed&nbsp;value</code>&nbsp;)\r
821     :\r
822                                         Ext.form.Field<div class="mdesc"><div class="short">Sets a data value into the field and validates it.  To set the value directly without validation see setRawValue.</div><div class="long">Sets a data value into the field and validates it.  To set the value directly without validation see <a href="output/Ext.form.Field.html#Ext.form.Field-setRawValue" ext:member="setRawValue" ext:cls="Ext.form.Field">setRawValue</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Mixed<div class="sub-desc">The value to set</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.form.Field</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#setValue" ext:member="#setValue" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-setVisible"></a><b><a href="source/Component.html#method-Ext.Component-setVisible">setVisible</a></b>(&nbsp;<code>Boolean&nbsp;visible</code>&nbsp;)\r
823     :\r
824                                         Ext.Component<div class="mdesc"><div class="short">Convenience function to hide or show this component by boolean.</div><div class="long">Convenience function to hide or show this component by boolean.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>visible</code> : Boolean<div class="sub-desc">True to show, false to hide</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#setVisible" ext:member="#setVisible" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-setWidth"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-setWidth">setWidth</a></b>(&nbsp;<code>Number&nbsp;width</code>&nbsp;)\r
825     :\r
826                                         Ext.BoxComponent<div class="mdesc"><div class="short">Sets the width of the component.  This method fires the resize event.</div><div class="long">Sets the width of the component.  This method fires the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-resize" ext:member="resize" ext:cls="Ext.BoxComponent">resize</a> event.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>width</code> : Number<div class="sub-desc">The new width to setThis may be one of:<div class="mdetail-params"><ul>
827 <li>A Number specifying the new width in the <a href="output/Ext.BoxComponent.html#Ext.BoxComponent-getEl" ext:member="getEl" ext:cls="Ext.BoxComponent">Element</a>'s <a href="output/Ext.Element.html#Ext.Element-defaultUnit" ext:member="defaultUnit" ext:cls="Ext.Element">Ext.Element.defaultUnit</a>s (by default, pixels).</li>
828 <li>A String used to set the CSS width style.</li>
829 </ul></div></div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#setWidth" ext:member="#setWidth" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-show"></a><b><a href="source/Component.html#method-Ext.Component-show">show</a></b>()\r
830     :\r
831                                         Ext.Component<div class="mdesc"><div class="short">Show this component.  Listen to the 'beforeshow' event and return\r
832 false to cancel showing the component.  Fires the '...</div><div class="long">Show this component.  Listen to the '<a href="output/Ext.Component.html#Ext.Component-beforeshow" ext:member="beforeshow" ext:cls="Ext.Component">beforeshow</a>' event and return
833 <tt>false</tt> to cancel showing the component.  Fires the '<a href="output/Ext.Component.html#Ext.Component-show" ext:member="show" ext:cls="Ext.Component">show</a>'
834 event after showing the component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.Component</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#show" ext:member="#show" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>(&nbsp;<code>Boolean&nbsp;queueSuspended</code>&nbsp;)\r
835     :\r
836                                         void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
837 after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-syncSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-syncSize">syncSize</a></b>()\r
838     :\r
839                                         Ext.BoxComponent<div class="mdesc"><div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div><div class="long">Force the component's size to recalculate based on the underlying element's current height and width.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#syncSize" ext:member="#syncSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-syncValue"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-syncValue">syncValue</a></b>()\r
840     :\r
841                                         void<div class="mdesc"><div class="short">Protected method that will not generally be called directly. Syncs the contents&#13;\r
842 of the editor iframe with the textar...</div><div class="long">Protected method that will not generally be called directly. Syncs the contents\r
843 of the editor iframe with the textarea.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-toggleSourceEdit"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-toggleSourceEdit">toggleSourceEdit</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Boolean&nbsp;sourceEdit</code>]</span>&nbsp;)\r
844     :\r
845                                         void<div class="mdesc"><div class="short">Toggles the editor between standard and source edit mode.</div><div class="long">Toggles the editor between standard and source edit mode.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>sourceEdit</code> : Boolean<div class="sub-desc">(optional) True for source edit, false for standard</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)\r
846     :\r
847                                         void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-updateBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-updateBox">updateBox</a></b>(&nbsp;<code>Object&nbsp;box</code>&nbsp;)\r
848     :\r
849                                         Ext.BoxComponent<div class="mdesc"><div class="short">Sets the current box measurements of the component's underlying element.</div><div class="long">Sets the current box measurements of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#updateBox" ext:member="#updateBox" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-updateToolbar"></a><b><a href="source/HtmlEditor.html#method-Ext.form.HtmlEditor-updateToolbar">updateToolbar</a></b>()\r
850     :\r
851                                         void<div class="mdesc"><div class="short">Protected method that will not generally be called directly. It triggers&#13;\r
852 a toolbar update by reading the markup stat...</div><div class="long">Protected method that will not generally be called directly. It triggers\r
853 a toolbar update by reading the markup state of the current selection in the editor.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr></tbody></table><a id="Ext.form.HtmlEditor-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-activate"></a><b><a href="source/HtmlEditor.html#event-Ext.form.HtmlEditor-activate">activate</a></b> :\r
854                                       (&nbsp;<code>HtmlEditor&nbsp;this</code>&nbsp;)\r
855     <div class="mdesc"><div class="short">Fires when the editor is first receives the focus. Any insertion must wait&#13;\r
856 until after this event.</div><div class="long">Fires when the editor is first receives the focus. Any insertion must wait\r
857 until after this event.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : HtmlEditor<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-afterrender"></a><b><a href="source/Component.html#event-Ext.Component-afterrender">afterrender</a></b> :\r
858                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
859     <div class="mdesc"><div class="short">Fires after the component rendering is finished.\r
860 The afterrender event is fired after this Component has been rendere...</div><div class="long"><p>Fires after the component rendering is finished.</p>
861 <p>The afterrender event is fired after this Component has been <a href="output/Ext.Component.html#Ext.Component-rendered" ext:member="rendered" ext:cls="Ext.Component">rendered</a>, been postprocesed
862 by any afterRender method defined for the Component, and, if <a href="output/Ext.Component.html#Ext.Component-stateful" ext:member="stateful" ext:cls="Ext.Component">stateful</a>, after state
863 has been restored.</p><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#afterrender" ext:member="#afterrender" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforedestroy"></a><b><a href="source/Component.html#event-Ext.Component-beforedestroy">beforedestroy</a></b> :\r
864                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
865     <div class="mdesc"><div class="short">Fires before the component is destroyed. Return false from an event handler to stop the destroy.</div><div class="long">Fires before the component is <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">destroy</a>ed. Return false from an event handler to stop the <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">destroy</a>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforedestroy" ext:member="#beforedestroy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforehide"></a><b><a href="source/Component.html#event-Ext.Component-beforehide">beforehide</a></b> :\r
866                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
867     <div class="mdesc"><div class="short">Fires before the component is hidden by calling the hide method.\r
868 Return false from an event handler to stop the hide.</div><div class="long">Fires before the component is hidden by calling the <a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a> method.
869 Return false from an event handler to stop the hide.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforehide" ext:member="#beforehide" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-beforepush"></a><b><a href="source/HtmlEditor.html#event-Ext.form.HtmlEditor-beforepush">beforepush</a></b> :\r
870                                       (&nbsp;<code>HtmlEditor&nbsp;this</code>,&nbsp;<code>String&nbsp;html</code>&nbsp;)\r
871     <div class="mdesc"><div class="short">Fires before the iframe editor is updated with content from the textarea. Return false&#13;\r
872 to cancel the push.</div><div class="long">Fires before the iframe editor is updated with content from the textarea. Return false\r
873 to cancel the push.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : HtmlEditor<div class="sub-desc"></div></li><li><code>html</code> : String<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforerender"></a><b><a href="source/Component.html#event-Ext.Component-beforerender">beforerender</a></b> :\r
874                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
875     <div class="mdesc"><div class="short">Fires before the component is rendered. Return false from an\r
876 event handler to stop the render.</div><div class="long">Fires before the component is <a href="output/Ext.Component.html#Ext.Component-rendered" ext:member="rendered" ext:cls="Ext.Component">rendered</a>. Return false from an
877 event handler to stop the <a href="output/Ext.Component.html#Ext.Component-render" ext:member="render" ext:cls="Ext.Component">render</a>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforerender" ext:member="#beforerender" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforeshow"></a><b><a href="source/Component.html#event-Ext.Component-beforeshow">beforeshow</a></b> :\r
878                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
879     <div class="mdesc"><div class="short">Fires before the component is shown by calling the show method.\r
880 Return false from an event handler to stop the show.</div><div class="long">Fires before the component is shown by calling the <a href="output/Ext.Component.html#Ext.Component-show" ext:member="show" ext:cls="Ext.Component">show</a> method.
881 Return false from an event handler to stop the show.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforeshow" ext:member="#beforeshow" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforestaterestore"></a><b><a href="source/Component.html#event-Ext.Component-beforestaterestore">beforestaterestore</a></b> :\r
882                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Object&nbsp;state</code>&nbsp;)\r
883     <div class="mdesc"><div class="short">Fires before the state of the component is restored. Return false from an event handler to stop the restore.</div><div class="long">Fires before the state of the component is restored. Return false from an event handler to stop the restore.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values returned from the StateProvider. If this
884 event is not vetoed, then the state object is passed to <b><tt>applyState</tt></b>. By default,
885 that simply copies property values into this Component. The method maybe overriden to
886 provide custom state restoration.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforestaterestore" ext:member="#beforestaterestore" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-beforestatesave"></a><b><a href="source/Component.html#event-Ext.Component-beforestatesave">beforestatesave</a></b> :\r
887                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Object&nbsp;state</code>&nbsp;)\r
888     <div class="mdesc"><div class="short">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.</div><div class="long">Fires before the state of the component is saved to the configured state provider. Return false to stop the save.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values. This is determined by calling
889 <b><tt>getState()</tt></b> on the Component. This method must be provided by the
890 developer to return whetever representation of state is required, by default, Ext.Component
891 has a null implementation.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#beforestatesave" ext:member="#beforestatesave" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-beforesync"></a><b><a href="source/HtmlEditor.html#event-Ext.form.HtmlEditor-beforesync">beforesync</a></b> :\r
892                                       (&nbsp;<code>HtmlEditor&nbsp;this</code>,&nbsp;<code>String&nbsp;html</code>&nbsp;)\r
893     <div class="mdesc"><div class="short">Fires before the textarea is updated with content from the editor iframe. Return false&#13;\r
894 to cancel the sync.</div><div class="long">Fires before the textarea is updated with content from the editor iframe. Return false\r
895 to cancel the sync.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : HtmlEditor<div class="sub-desc"></div></li><li><code>html</code> : String<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-destroy"></a><b><a href="source/Component.html#event-Ext.Component-destroy">destroy</a></b> :\r
896                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
897     <div class="mdesc"><div class="short">Fires after the component is destroyed.</div><div class="long">Fires after the component is <a href="output/Ext.Component.html#Ext.Component-destroy" ext:member="destroy" ext:cls="Ext.Component">destroy</a>ed.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#destroy" ext:member="#destroy" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-disable"></a><b><a href="source/Component.html#event-Ext.Component-disable">disable</a></b> :\r
898                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
899     <div class="mdesc"><div class="short">Fires after the component is disabled.</div><div class="long">Fires after the component is disabled.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#disable" ext:member="#disable" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-editmodechange"></a><b><a href="source/HtmlEditor.html#event-Ext.form.HtmlEditor-editmodechange">editmodechange</a></b> :\r
900                                       (&nbsp;<code>HtmlEditor&nbsp;this</code>,&nbsp;<code>Boolean&nbsp;sourceEdit</code>&nbsp;)\r
901     <div class="mdesc"><div class="short">Fires when the editor switches edit modes</div><div class="long">Fires when the editor switches edit modes<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : HtmlEditor<div class="sub-desc"></div></li><li><code>sourceEdit</code> : Boolean<div class="sub-desc">True if source edit, false if standard editing.</div></li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-enable"></a><b><a href="source/Component.html#event-Ext.Component-enable">enable</a></b> :\r
902                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
903     <div class="mdesc"><div class="short">Fires after the component is enabled.</div><div class="long">Fires after the component is enabled.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#enable" ext:member="#enable" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-hide"></a><b><a href="source/Component.html#event-Ext.Component-hide">hide</a></b> :\r
904                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
905     <div class="mdesc"><div class="short">Fires after the component is hidden.\r
906 Fires after the component is hidden when calling the hide method.</div><div class="long">Fires after the component is hidden.
907 Fires after the component is hidden when calling the <a href="output/Ext.Component.html#Ext.Component-hide" ext:member="hide" ext:cls="Ext.Component">hide</a> method.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#hide" ext:member="#hide" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-initialize"></a><b><a href="source/HtmlEditor.html#event-Ext.form.HtmlEditor-initialize">initialize</a></b> :\r
908                                       (&nbsp;<code>HtmlEditor&nbsp;this</code>&nbsp;)\r
909     <div class="mdesc"><div class="short">Fires when the editor is fully initialized (including the iframe)</div><div class="long">Fires when the editor is fully initialized (including the iframe)<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : HtmlEditor<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.Field-invalid"></a><b><a href="source/Field.html#event-Ext.form.Field-invalid">invalid</a></b> :\r
910                                       (&nbsp;<code>Ext.form.Field&nbsp;this</code>,&nbsp;<code>String&nbsp;msg</code>&nbsp;)\r
911     <div class="mdesc"><div class="short">Fires after the field has been marked as invalid.</div><div class="long">Fires after the field has been marked as invalid.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.form.Field<div class="sub-desc"></div></li><li><code>msg</code> : String<div class="sub-desc">The validation message</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#invalid" ext:member="#invalid" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-move"></a><b><a href="source/BoxComponent.html#event-Ext.BoxComponent-move">move</a></b> :\r
912                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Number&nbsp;x</code>,&nbsp;<code>Number&nbsp;y</code>&nbsp;)\r
913     <div class="mdesc"><div class="short">Fires after the component is moved.</div><div class="long">Fires after the component is moved.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>x</code> : Number<div class="sub-desc">The new x position</div></li><li><code>y</code> : Number<div class="sub-desc">The new y position</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#move" ext:member="#move" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-push"></a><b><a href="source/HtmlEditor.html#event-Ext.form.HtmlEditor-push">push</a></b> :\r
914                                       (&nbsp;<code>HtmlEditor&nbsp;this</code>,&nbsp;<code>String&nbsp;html</code>&nbsp;)\r
915     <div class="mdesc"><div class="short">Fires when the iframe editor is updated with content from the textarea.</div><div class="long">Fires when the iframe editor is updated with content from the textarea.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : HtmlEditor<div class="sub-desc"></div></li><li><code>html</code> : String<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-render"></a><b><a href="source/Component.html#event-Ext.Component-render">render</a></b> :\r
916                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
917     <div class="mdesc"><div class="short">Fires after the component markup is rendered.</div><div class="long">Fires after the component markup is <a href="output/Ext.Component.html#Ext.Component-rendered" ext:member="rendered" ext:cls="Ext.Component">rendered</a>.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#render" ext:member="#render" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.BoxComponent-resize"></a><b><a href="source/BoxComponent.html#event-Ext.BoxComponent-resize">resize</a></b> :\r
918                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Number&nbsp;adjWidth</code>,&nbsp;<code>Number&nbsp;adjHeight</code>,&nbsp;<code>Number&nbsp;rawWidth</code>,&nbsp;<code>Number&nbsp;rawHeight</code>&nbsp;)\r
919     <div class="mdesc"><div class="short">Fires after the component is resized.</div><div class="long">Fires after the component is resized.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>adjWidth</code> : Number<div class="sub-desc">The box-adjusted width that was set</div></li><li><code>adjHeight</code> : Number<div class="sub-desc">The box-adjusted height that was set</div></li><li><code>rawWidth</code> : Number<div class="sub-desc">The width that was originally specified</div></li><li><code>rawHeight</code> : Number<div class="sub-desc">The height that was originally specified</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#resize" ext:member="#resize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-show"></a><b><a href="source/Component.html#event-Ext.Component-show">show</a></b> :\r
920                                       (&nbsp;<code>Ext.Component&nbsp;this</code>&nbsp;)\r
921     <div class="mdesc"><div class="short">Fires after the component is shown when calling the show method.</div><div class="long">Fires after the component is shown when calling the <a href="output/Ext.Component.html#Ext.Component-show" ext:member="show" ext:cls="Ext.Component">show</a> method.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#show" ext:member="#show" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-staterestore"></a><b><a href="source/Component.html#event-Ext.Component-staterestore">staterestore</a></b> :\r
922                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Object&nbsp;state</code>&nbsp;)\r
923     <div class="mdesc"><div class="short">Fires after the state of the component is restored.</div><div class="long">Fires after the state of the component is restored.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values returned from the StateProvider. This is passed
924 to <b><tt>applyState</tt></b>. By default, that simply copies property values into this
925 Component. The method maybe overriden to provide custom state restoration.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#staterestore" ext:member="#staterestore" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Component-statesave"></a><b><a href="source/Component.html#event-Ext.Component-statesave">statesave</a></b> :\r
926                                       (&nbsp;<code>Ext.Component&nbsp;this</code>,&nbsp;<code>Object&nbsp;state</code>&nbsp;)\r
927     <div class="mdesc"><div class="short">Fires after the state of the component is saved to the configured state provider.</div><div class="long">Fires after the state of the component is saved to the configured state provider.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>state</code> : Object<div class="sub-desc">The hash of state values. This is determined by calling
928 <b><tt>getState()</tt></b> on the Component. This method must be provided by the
929 developer to return whetever representation of state is required, by default, Ext.Component
930 has a null implementation.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#statesave" ext:member="#statesave" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.form.HtmlEditor-sync"></a><b><a href="source/HtmlEditor.html#event-Ext.form.HtmlEditor-sync">sync</a></b> :\r
931                                       (&nbsp;<code>HtmlEditor&nbsp;this</code>,&nbsp;<code>String&nbsp;html</code>&nbsp;)\r
932     <div class="mdesc"><div class="short">Fires when the textarea is updated with content from the editor iframe.</div><div class="long">Fires when the textarea is updated with content from the editor iframe.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : HtmlEditor<div class="sub-desc"></div></li><li><code>html</code> : String<div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">HtmlEditor</td></tr></tbody></table></div>