Properties

Methods

Events

Config Options

Direct Link

Observable
  Component
    BoxComponent
      Field
        HtmlEditor

Class Ext.form.HtmlEditor

Package:	Ext.form
Defined In:	HtmlEditor.js
Class:	HtmlEditor
Extends:	Field

* Provides a lightweight HTML Editor component. Some toolbar features are not supported by Safari and will be automatically hidden when needed. These are noted in the config options where appropriate.

The editor's toolbar buttons have tooltips defined in the buttonTips property, but they are not enabled by default unless the global Ext.QuickTips singleton is initialized.

Note: The focus/blur and validation marking functionality inherited from Ext.form.Field is NOT supported by this editor.

An Editor is a sensitive component that can't be used in all spots standard fields can be used. Putting an Editor within any element that has display set to 'none' can cause problems in Safari and Firefox due to their default iframe reloading bugs.

Example usage:

// Simple example rendered with default options:
Ext.QuickTips.init();  // enable tooltips
new Ext.form.HtmlEditor({
    renderTo: Ext.getBody(),
    width: 800,
    height: 300
});

// Passed via xtype into a container and with custom options:
Ext.QuickTips.init();  // enable tooltips
new Ext.Panel({
    title: 'HTML Editor',
    renderTo: Ext.getBody(),
    width: 600,
    height: 300,
    frame: true,
    layout: 'fit',
    items: {
        xtype: 'htmleditor',
        enableColors: false,
        enableAlignments: false
    }
});

Config Options

Config Options		Defined By
	autoEl : String/Object A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inlin... A tag name or DomHelper spec to create an element with. This is intended to create shorthand utility components inline via JSON. It should not be used for higher level components which already create their own elements. Example usage: `{xtype:'box', autoEl: 'div', cls:'my-class'} {xtype:'box', autoEl: {tag:'blockquote', html:'autoEl is cool!'}} // with DomHelper`	Component
	autoShow : Boolean True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render... True if the component should check for hidden classes (e.g. 'x-hidden' or 'x-hide-display') and remove them on render (defaults to false).	Component
	clearCls : String The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Co... The CSS class used to provide field clearing (defaults to 'x-form-clear-left'). This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager.	Component
	createLinkText : String The default text for the create link prompt	HtmlEditor
	ctCls : String An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for... An optional extra CSS class that will be added to this component's container (defaults to ''). This can be useful for adding customized styles to the container or any of its children using standard CSS rules.	Component
	defaultLinkValue : String The default value for the create link prompt (defaults to http:/ /)	HtmlEditor
	enableAlignments : Boolean Enable the left, center, right alignment buttons (defaults to true)	HtmlEditor
	enableColors : Boolean Enable the fore/highlight color buttons (defaults to true)	HtmlEditor
	enableFont : Boolean Enable font selection. Not available in Safari. (defaults to true)	HtmlEditor
	enableFontSize : Boolean Enable the increase/decrease font size buttons (defaults to true)	HtmlEditor
	enableFormat : Boolean Enable the bold, italic and underline buttons (defaults to true)	HtmlEditor
	enableLinks : Boolean Enable the create link button. Not available in Safari. (defaults to true)	HtmlEditor
	enableLists : Boolean Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)	HtmlEditor
	enableSourceEdit : Boolean Enable the switch to source edit button. Not available in Safari. (defaults to true)	HtmlEditor
	fieldLabel : String The label text to display next to this Component (defaults to '') This config is only used when this Component is ren... The label text to display next to this Component (defaults to '') This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield', fieldLabel: 'Name' }] });`	Component
	fontFamilies : Array An array of available font families	HtmlEditor
	height : Number The height of this component in pixels (defaults to auto).	BoxComponent
	hidden : Boolean Render this component hidden (default is false).	Component
	hideLabel : Boolean True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel th... True to completely hide the label element (defaults to false). By default, even if you do not specify a fieldLabel the space will still be reserved so that the field will line up with other fields that do have labels. Setting this to true will cause the field to not reserve that space. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield' hideLabel: true }] });`	Component
	hideMode : String How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset p... How this component should be hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display". For Containers which may be hidden and shown as part of a card layout Container such as a TabPanel, it is recommended that hideMode is configured as "offsets". This ensures that hidden Components still have height and width so that layout managers can perform measurements when calculating layouts.	Component
	hideParent : Boolean True to hide and show the component's container when hide/show is called on the component, false to hide and show the... True to hide and show the component's container when hide/show is called on the component, false to hide and show the component itself (defaults to false). For example, this can be used as a shortcut for a hide button on a window by setting hide:true on the button when adding it to its parent container.	Component
	id : String The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to ... The unique id of this component (defaults to an auto-assigned id). You should assign an id if you need to be able to access the component later and you do not have an object reference available (e.g., using Ext.ComponentMgr.getCmp). Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.	Component
	itemCls : String An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCl... An additional CSS class to apply to the wrapper's form item element of this field (defaults to the container's itemCls value if set, or ''). Since it is applied to the item wrapper, it allows you to write standard CSS rules that can apply to the field, the label (if specified) or any other element within the markup for the field. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `// Apply a style to the field's label: <style> .required .x-form-item-label {font-weight:bold;color:red;} </style> new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield', fieldLabel: 'Name', itemCls: 'required' //this label will be styled },{ xtype: 'textfield', fieldLabel: 'Favorite Color' }] });`	Component
	labelSeparator : String The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.l... The standard separator to display after the text of each form label (defaults to the value of Ext.layout.FormLayout.labelSeparator, which is a colon ':' by default). To display no separator for this field's label specify empty string ''. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield', fieldLabel: 'Name', labelSeparator: '...' }] });`	Component
	labelStyle : String A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if se... A CSS style specification to apply directly to this field's label (defaults to the container's labelStyle value if set, or '').. This config is only used when this Component is rendered by a Container which has been configured to use the FormLayout layout manager. Example use: `new Ext.FormPanel({ height: 100, renderTo: Ext.getBody(), items: [{ xtype: 'textfield', fieldLabel: 'Name', labelStyle: 'font-weight:bold;' }] });`	Component
	listeners : Object (optional) A config object containing one or more event handlers to be added to this object during initialization. Th... (optional) A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.	Observable
	name : String The field's HTML name attribute (defaults to "").	Field
	overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and... An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized "active" or "hover" styles to the component or any of its children using standard CSS rules.	Component
	pageX : Number The page level x coordinate for this component if contained within a positioning container.	BoxComponent
	pageY : Number The page level y coordinate for this component if contained within a positioning container.	BoxComponent
	plugins : Object/Array An object or array of objects that will provide custom functionality for this component. The only requirement for a v... An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.	Component
	renderTo : Mixed The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using... The id of the node, a DOM node or an existing Element that will be the container to render this component into. Using this config, a call to render() is not required.	Component
	stateEvents : Array An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be... An array of events that, when fired, should trigger this component to save its state (defaults to none). These can be any types of events supported by this component, including browser or custom events (e.g., ['click', 'customerchange']). See stateful for an explanation of saving and restoring Component state.	Component
	stateId : String The unique id for this component to use for state management purposes (defaults to the component id if one was set, o... The unique id for this component to use for state management purposes (defaults to the component id if one was set, otherwise null if the component is using a generated id). See stateful for an explanation of saving and restoring Component state.	Component
	stateful : Boolean A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startu... A flag which causes the Component to attempt to restore the state of internal properties from a saved state on startup. The component must have either a stateId or id assigned for state to be managed. Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a component. For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available. To set the state provider for the current page: `Ext.state.Manager.setProvider(new Ext.state.CookieProvider());` Components attempt to save state when one of the events listed in the stateEvents configuration fires. You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events	Component
	value : Mixed A value to initialize this field with (defaults to undefined).	Field
	width : Number The width of this component in pixels (defaults to auto).	BoxComponent
	x : Number The local x (left) coordinate for this component if contained within a positioning container.	BoxComponent
	xtype : String The registered xtype to create. This config option is not used when passing a config object into a constructor. This ... The registered xtype to create. This config option is not used when passing a config object into a constructor. This config option is used only when lazy instantiation is being used, and a child item of a Container is being specified not as a fully instantiated Component, but as a Component config object. The xtype will be looked up at render time up to determine what type of child Component to create. The predefined xtypes are listed here. If you subclass Components to create your own Components, you may register them using Ext.ComponentMgr.registerType in order to be able to take advantage of lazy instantiation and rendering.	Component
	y : Number The local y (top) coordinate for this component if contained within a positioning container.	BoxComponent

Public Properties

Property		Defined By
	buttonTips : Object Object collection of toolbar tooltips for the buttons in the editor. The key is the command id associated with that b... Object collection of toolbar tooltips for the buttons in the editor. The key is the command id associated with that button and the value is a valid QuickTips object. For example: `{ bold : { title: 'Bold (Ctrl+B)', text: 'Make the selected text bold.', cls: 'x-html-editor-tip' }, italic : { title: 'Italic (Ctrl+I)', text: 'Make the selected text italic.', cls: 'x-html-editor-tip' }, ...`	HtmlEditor
	hidden : Boolean True if this component is hidden. Read-only.	Component
	initialConfig : Object This Component's initial configuration specification. Read-only.	Component
	ownerCt : Ext.Container The component's owner Ext.Container (defaults to undefined, and is set automatically when the component is added to a... The component's owner Ext.Container (defaults to undefined, and is set automatically when the component is added to a container). Read-only.	Component
	rendered : Boolean True if this component has been rendered. Read-only.	Component

Public Methods

Method		Defined By
	HtmlEditor( `Object config` ) Create a new HtmlEditor Create a new HtmlEditor Parameters: `config` : Object Returns:	HtmlEditor
	addClass( `string cls` ) : void Adds a CSS class to the component's underlying element. Adds a CSS class to the component's underlying element. Parameters: `cls` : string The CSS class name to add Returns: `void`	Component
	addEvents( `Object object` ) : void Used to define events on this Observable Used to define events on this Observable Parameters: `object` : Object The object with the events defined Returns: `void`	Observable
	addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this component Appends an event handler to this component Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) An object containing handler configuration properties. This may contain any of the following properties: scope : Object The scope in which to execute the handler function. The handler function's "this" context. delay : Number The number of milliseconds to delay the invocation of the handler after the event fires. single : Boolean True to add a handler to handle just the next firing of the event, and then remove itself. buffer : Number Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) `el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. `foo.on({ 'click' : { fn: this.onClick, scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver, scope: this }, 'mouseout' : { fn: this.onMouseOut, scope: this } });` Or a shorthand syntax: `foo.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut, scope: this });` Returns: `void`	Observable
	cleanHtml( `String html` ) : String Protected method that will not generally be called directly. If you need/want custom HTML cleanup, this is the method... Protected method that will not generally be called directly. If you need/want custom HTML cleanup, this is the method you should override. Parameters: `html` : String The HTML to be cleaned Returns: `String` The cleaned HTML	HtmlEditor
	cloneConfig( `Object overrides` ) : Ext.Component Clone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. Parameters: `overrides` : Object A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates. Returns: `Ext.Component` clone The cloned copy of this component	Component
	destroy() : void Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the c... Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its Ext.Container (if applicable) and unregistering it from Ext.ComponentMgr. Destruction is generally handled automatically by the framework and this method should usually not need to be called directly. Parameters: None. Returns: `void`	Component
	execCmd( `String cmd`, [`String/Boolean value`] ) : void Executes a Midas editor command directly on the editor document. For visual commands, you should use relayCmd instead... Executes a Midas editor command directly on the editor document. For visual commands, you should use relayCmd instead. This should only be called after the editor is initialized. Parameters: `cmd` : String The Midas command `value` : String/Boolean (optional) The value to pass to the command (defaults to null) Returns: `void`	HtmlEditor
	findParentBy( `Function fcn`, [`Object scope`] ) : Ext.Container Find a container above this component at any level by a custom function. If the passed function returns true, the con... Find a container above this component at any level by a custom function. If the passed function returns true, the container will be returned. The passed function is called with the arguments (container, this component). Parameters: `fcn` : Function `scope` : Object (optional) Returns: `Ext.Container` The first Container for which the custom function returns true	Component
	findParentByType( `String/Class xtype` ) : Ext.Container Find a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters: `xtype` : String/Class The xtype string for a component, or the class of the component directly Returns: `Ext.Container` The first Container which matches the given xtype or class	Component
	fireEvent( `String eventName`, `Object... args` ) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: `eventName` : String `args` : Object... Variable number of parameters are passed to handlers Returns: `Boolean` returns false if any of the handlers return false otherwise it returns true	Observable
	focus( [`Boolean selectText`], [`Boolean/Number delay`] ) : Ext.Component Try to focus this component. Try to focus this component. Parameters: `selectText` : Boolean (optional) If applicable, true to also select the text in this component `delay` : Boolean/Number (optional) Delay the focus this number of milliseconds (true for 10 milliseconds) Returns: `Ext.Component` this	Component
	getBox( [`Boolean local`] ) : Object Gets the current box measurements of the component's underlying element. Gets the current box measurements of the component's underlying element. Parameters: `local` : Boolean (optional) If true the element's left and top are returned instead of page XY (defaults to false) Returns: `Object` box An object in the format {x, y, width, height}	BoxComponent
	getDocMarkup() : void Protected method that will not generally be called directly. It is called when the editor initializes the iframe with... Protected method that will not generally be called directly. It is called when the editor initializes the iframe with HTML contents. Override this method if you want to change the initialization markup of the iframe (e.g. to add stylesheets). Parameters: None. Returns: `void`	HtmlEditor
	getEl() : Ext.Element Returns the underlying Ext.Element. Returns the underlying Ext.Element. Parameters: None. Returns: `Ext.Element` The element	Component
	getId() : String Returns the id of this component. Returns the id of this component. Parameters: None. Returns: `String`	Component
	getItemId() : String Returns the item id of this component. Returns the item id of this component. Parameters: None. Returns: `String`	Component
	getName() : String Returns the name attribute of the field if available Returns the name attribute of the field if available Parameters: None. Returns: `String` name The field name	Field
	getPosition( [`Boolean local`] ) : Array Gets the current XY position of the component's underlying element. Gets the current XY position of the component's underlying element. Parameters: `local` : Boolean (optional) If true the element's left and top are returned instead of page XY (defaults to false) Returns: `Array` The XY position of the element (e.g., [100, 200])	BoxComponent
	getRawValue() : Mixed Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue. Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue. Parameters: None. Returns: `Mixed` value The field value	Field
	getSize() : Object Gets the current size of the component's underlying element. Gets the current size of the component's underlying element. Parameters: None. Returns: `Object` An object containing the element's size {width: (element width), height: (element height)}	BoxComponent
	getToolbar() : Ext.Toolbar Returns the editor's toolbar. This is only available after the editor has been rendered. Returns the editor's toolbar. This is only available after the editor has been rendered. Parameters: None. Returns: `Ext.Toolbar`	HtmlEditor
	getValue() : Mixed Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRa... Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRawValue. Parameters: None. Returns: `Mixed` value The field value	Field
	getXType() : String Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ex... Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ext.Component header. Example usage: `var t = new Ext.form.TextField(); alert(t.getXType()); // alerts 'textfield'` Parameters: None. Returns: `String` The xtype	Component
	getXTypes() : String Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext... Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header. If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. Example usage: `var t = new Ext.form.TextField(); alert(t.getXTypes()); // alerts 'component/box/field/textfield'` Parameters: None. Returns: `String` The xtype hierarchy string	Component
	hasListener( `String eventName` ) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: `eventName` : String The name of the event to check for Returns: `Boolean` True if the event is being listened for, else false	Observable
	hide() : Ext.Component Hide this component. Hide this component. Parameters: None. Returns: `Ext.Component` this	Component
	insertAtCursor( `String text` ) : void Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated to insert ... Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated to insert text. Parameters: `text` : String Returns: `void`	HtmlEditor
	isDirty() : void Returns true if this field has been changed since it was originally loaded and is not disabled. Returns true if this field has been changed since it was originally loaded and is not disabled. Parameters: None. Returns: `void`	Field
	isValid( `Boolean preventMark` ) : Boolean Returns whether or not the field value is currently valid Returns whether or not the field value is currently valid Parameters: `preventMark` : Boolean True to disable marking the field invalid Returns: `Boolean` True if the value is valid, else false	Field
	isVisible() : void Returns true if this component is visible. Returns true if this component is visible. Parameters: None. Returns: `void`	Component
	isXType( `String xtype`, [`Boolean shallow`] ) : void Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes. For a list of all available xtypes, see the Ext.Component header. Example usage: `var t = new Ext.form.TextField(); var isText = t.isXType('textfield'); // true var isBoxSubclass = t.isXType('box'); // true, descended from BoxComponent var isBoxInstance = t.isXType('box', true); // false, not a direct BoxComponent instance` Parameters: `xtype` : String The xtype to check for this Component `shallow` : Boolean (optional) False to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype. Returns: `void`	Component
	on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) Returns: `void`	Observable
	purgeListeners() : void Removes all listeners for this object Removes all listeners for this object Parameters: None. Returns: `void`	Observable
	pushValue() : void Protected method that will not generally be called directly. Pushes the value of the textarea into the iframe editor. Protected method that will not generally be called directly. Pushes the value of the textarea into the iframe editor. Parameters: None. Returns: `void`	HtmlEditor
	relayCmd( `String cmd`, [`String/Boolean value`] ) : void Executes a Midas editor command on the editor document and performs necessary focus and toolbar updates. This should ... Executes a Midas editor command on the editor document and performs necessary focus and toolbar updates. This should only be called after the editor is initialized. Parameters: `cmd` : String The Midas command `value` : String/Boolean (optional) The value to pass to the command (defaults to null) Returns: `void`	HtmlEditor
	relayEvents( `Object o`, `Array events` ) : void Relays selected events from the specified Observable as if the events were fired by `this`. Relays selected events from the specified Observable as if the events were fired by `this`. Parameters: `o` : Object The Observable whose events this object is to relay. `events` : Array Array of event names to relay. Returns: `void`	Observable
	removeClass( `string cls` ) : void Removes a CSS class from the component's underlying element. Removes a CSS class from the component's underlying element. Parameters: `cls` : string The CSS class name to remove Returns: `void`	Component
	removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener Removes a listener Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void`	Observable
	render( [`Element/HTMLElement/String container`], [`String/Number position`] ) : void Render this Component into the passed HTML element. If you are using a Container object to house this Component, then... Render this Component into the passed HTML element. If you are using a Container object to house this Component, then do not use the render method. A Container's child Components are rendered by that Container's layout manager when the Container is first rendered. Certain layout managers allow dynamic addition of child components. Those that do include Ext.layout.CardLayout, Ext.layout.AnchorLayout, Ext.layout.FormLayout, Ext.layout.TableLayout. If the Container is already rendered when a new child Component is added, you may need to call the Container's doLayout to refresh the view which causes any unrendered child Components to be rendered. This is required so that you can add multiple child components if needed while only refreshing the layout once. When creating complex UIs, it is important to remember that sizing and positioning of child items is the responsibility of the Container's layout manager. If you expect child items to be sized in response to user interactions, you must configure the Container with a layout manager which creates and manages the type of layout you have in mind. Omitting the Container's layout config means that a basic layout manager is used which does nothing but render child components sequentially into the Container. No sizing or positioning will be performed in this situation. Parameters: `container` : Element/HTMLElement/String (optional) The element this Component should be rendered into. If it is being created from existing markup, this should be omitted. `position` : String/Number (optional) The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container) Returns: `void`	Component
	reset() : void Resets the current field value to the originally loaded value and clears any validation messages Resets the current field value to the originally loaded value and clears any validation messages Parameters: None. Returns: `void`	Field
	resumeEvents() : void Resume firing events. (see suspendEvents) Resume firing events. (see suspendEvents) Parameters: None. Returns: `void`	Observable
	setHeight( `Number height` ) : Ext.BoxComponent Sets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters: `height` : Number The new height to set Returns: `Ext.BoxComponent` this	BoxComponent
	setPagePosition( `Number x`, `Number y` ) : Ext.BoxComponent Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the ... Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the move event. Parameters: `x` : Number The new x position `y` : Number The new y position Returns: `Ext.BoxComponent` this	BoxComponent
	setPosition( `Number left`, `Number top` ) : Ext.BoxComponent Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires ... Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires the move event. Parameters: `left` : Number The new left `top` : Number The new top Returns: `Ext.BoxComponent` this	BoxComponent
	setRawValue( `Mixed value` ) : Mixed Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue. Parameters: `value` : Mixed The value to set Returns: `Mixed` value The field value that is set	Field
	setSize( `Number/Object width`, `Number height` ) : Ext.BoxComponent Sets the width and height of the component. This method fires the resize event. This method can accept either width... Sets the width and height of the component. This method fires the resize event. This method can accept either width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}. Parameters: `width` : Number/Object The new width to set, or a size object in the format {width, height} `height` : Number The new height to set (not required if a size object is passed as the first arg) Returns: `Ext.BoxComponent` this	BoxComponent
	setValue( `Mixed value` ) : void Sets a data value into the field and validates it. To set the value directly without validation see setRawValue. Sets a data value into the field and validates it. To set the value directly without validation see setRawValue. Parameters: `value` : Mixed The value to set Returns: `void`	Field
	setVisible( `Boolean visible` ) : Ext.Component Convenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters: `visible` : Boolean True to show, false to hide Returns: `Ext.Component` this	Component
	setWidth( `Number width` ) : Ext.BoxComponent Sets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters: `width` : Number The new width to set Returns: `Ext.BoxComponent` this	BoxComponent
	show() : Ext.Component Show this component. Show this component. Parameters: None. Returns: `Ext.Component` this	Component
	suspendEvents() : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: None. Returns: `void`	Observable
	syncSize() : Ext.BoxComponent Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters: None. Returns: `Ext.BoxComponent` this	BoxComponent
	syncValue() : void Protected method that will not generally be called directly. Syncs the contents of the editor iframe with the textarea. Protected method that will not generally be called directly. Syncs the contents of the editor iframe with the textarea. Parameters: None. Returns: `void`	HtmlEditor
	toggleSourceEdit( [`Boolean sourceEdit`] ) : void Toggles the editor between standard and source edit mode. Toggles the editor between standard and source edit mode. Parameters: `sourceEdit` : Boolean (optional) True for source edit, false for standard Returns: `void`	HtmlEditor
	un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void`	Observable
	updateBox( `Object box` ) : Ext.BoxComponent Sets the current box measurements of the component's underlying element. Sets the current box measurements of the component's underlying element. Parameters: `box` : Object An object in the format {x, y, width, height} Returns: `Ext.BoxComponent` this	BoxComponent
	updateToolbar() : void Protected method that will not generally be called directly. It triggers a toolbar update by reading the markup state... Protected method that will not generally be called directly. It triggers a toolbar update by reading the markup state of the current selection in the editor. Parameters: None. Returns: `void`	HtmlEditor

Public Events

Event		Defined By
	activate : ( `HtmlEditor this` ) Fires when the editor is first receives the focus. Any insertion must wait until after this event. Fires when the editor is first receives the focus. Any insertion must wait until after this event. Listeners will be called with the following arguments: `this` : HtmlEditor	HtmlEditor
	beforedestroy : ( `Ext.Component this` ) Fires before the component is destroyed. Return false to stop the destroy. Fires before the component is destroyed. Return false to stop the destroy. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	beforehide : ( `Ext.Component this` ) Fires before the component is hidden. Return false to stop the hide. Fires before the component is hidden. Return false to stop the hide. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	beforepush : ( `HtmlEditor this`, `String html` ) Fires before the iframe editor is updated with content from the textarea. Return false to cancel the push. Fires before the iframe editor is updated with content from the textarea. Return false to cancel the push. Listeners will be called with the following arguments: `this` : HtmlEditor `html` : String	HtmlEditor
	beforerender : ( `Ext.Component this` ) Fires before the component is rendered. Return false to stop the render. Fires before the component is rendered. Return false to stop the render. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	beforeshow : ( `Ext.Component this` ) Fires before the component is shown. Return false to stop the show. Fires before the component is shown. Return false to stop the show. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	beforestaterestore : ( `Ext.Component this`, `Object state` ) Fires before the state of the component is restored. Return false to stop the restore. Fires before the state of the component is restored. Return false to stop the restore. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values	Component
	beforestatesave : ( `Ext.Component this`, `Object state` ) Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Fires before the state of the component is saved to the configured state provider. Return false to stop the save. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values	Component
	beforesync : ( `HtmlEditor this`, `String html` ) Fires before the textarea is updated with content from the editor iframe. Return false to cancel the sync. Fires before the textarea is updated with content from the editor iframe. Return false to cancel the sync. Listeners will be called with the following arguments: `this` : HtmlEditor `html` : String	HtmlEditor
	destroy : ( `Ext.Component this` ) Fires after the component is destroyed. Fires after the component is destroyed. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	disable : ( `Ext.Component this` ) Fires after the component is disabled. Fires after the component is disabled. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	editmodechange : ( `HtmlEditor this`, `Boolean sourceEdit` ) Fires when the editor switches edit modes Fires when the editor switches edit modes Listeners will be called with the following arguments: `this` : HtmlEditor `sourceEdit` : Boolean True if source edit, false if standard editing.	HtmlEditor
	enable : ( `Ext.Component this` ) Fires after the component is enabled. Fires after the component is enabled. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	hide : ( `Ext.Component this` ) Fires after the component is hidden. Fires after the component is hidden. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	initialize : ( `HtmlEditor this` ) Fires when the editor is fully initialized (including the iframe) Fires when the editor is fully initialized (including the iframe) Listeners will be called with the following arguments: `this` : HtmlEditor	HtmlEditor
	invalid : ( `Ext.form.Field this`, `String msg` ) Fires after the field has been marked as invalid. Fires after the field has been marked as invalid. Listeners will be called with the following arguments: `this` : Ext.form.Field `msg` : String The validation message	Field
	move : ( `Ext.Component this`, `Number x`, `Number y` ) Fires after the component is moved. Fires after the component is moved. Listeners will be called with the following arguments: `this` : Ext.Component `x` : Number The new x position `y` : Number The new y position	BoxComponent
	push : ( `HtmlEditor this`, `String html` ) Fires when the iframe editor is updated with content from the textarea. Fires when the iframe editor is updated with content from the textarea. Listeners will be called with the following arguments: `this` : HtmlEditor `html` : String	HtmlEditor
	render : ( `Ext.Component this` ) Fires after the component is rendered. Fires after the component is rendered. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	resize : ( `Ext.Component this`, `Number adjWidth`, `Number adjHeight`, `Number rawWidth`, `Number rawHeight` ) Fires after the component is resized. Fires after the component is resized. Listeners will be called with the following arguments: `this` : Ext.Component `adjWidth` : Number The box-adjusted width that was set `adjHeight` : Number The box-adjusted height that was set `rawWidth` : Number The width that was originally specified `rawHeight` : Number The height that was originally specified	BoxComponent
	show : ( `Ext.Component this` ) Fires after the component is shown. Fires after the component is shown. Listeners will be called with the following arguments: `this` : Ext.Component	Component
	staterestore : ( `Ext.Component this`, `Object state` ) Fires after the state of the component is restored. Fires after the state of the component is restored. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values	Component
	statesave : ( `Ext.Component this`, `Object state` ) Fires after the state of the component is saved to the configured state provider. Fires after the state of the component is saved to the configured state provider. Listeners will be called with the following arguments: `this` : Ext.Component `state` : Object The hash of state values	Component
	sync : ( `HtmlEditor this`, `String html` ) Fires when the textarea is updated with content from the editor iframe. Fires when the textarea is updated with content from the editor iframe. Listeners will be called with the following arguments: `this` : HtmlEditor `html` : String	HtmlEditor