Print Friendly

Class Ext.form.HtmlEditor

Package:Ext.form
Class:HtmlEditor
Extends:Field
Defined In:HtmlEditor.js
Provides a lightweight HTML Editor component.

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.

Note: In Ext 1.1 there can only be one HtmlEditor on a page at a time. This restriction does not apply in Ext 2.0+.

Properties   -  Methods   -  Events   -  Config Options

Public Properties

Property Defined By
  buttonTips : Object HtmlEditor
Object collection of toolbar tooltips for the buttons in the editor. The key is the command id associated with that b...
  disabled : Object Component
true if this component is disabled. Read-only.
  hidden : Object Component
true if this component is hidden. Read-only.
  rendered : Object Component
true if this component has been rendered. Read-only.

Public Methods

Method Defined By
  addEventsObject object ) : void Observable
Used to define events on this Observable
  addListenerString eventName, Function handler, [Object scope], [Object options] ) : void Observable
Appends an event handler to this component
  applyToString/HTMLElement/Element el ) : Ext.form.Field Field
Apply the behaviors of this component to an existing element. This is used instead of render().
  cleanHtmlString html ) : void HtmlEditor
Protected method that will not generally be called directly. If you need/want custom HTML cleanup, this is the method...
  createToolbarHtmlEditor editor ) : void HtmlEditor
Protected method that will not generally be called directly. It is called when the editor creates its toolbar. Overri...
  destroy() : void Component
Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the c...
  disable() : Ext.Component Component
Disable this component.
  enable() : Ext.Component Component
Enable this component.
  execCmdString cmd, [String/Boolean value] ) : void HtmlEditor
Executes a Midas editor command directly on the editor document. For visual commands, you should use relayCmd instead...
  fireEventString eventName, Object... args ) : Boolean Observable
Fires the specified event with the passed parameters (minus the event name).
  focusBoolean selectText ) : Ext.Component Component
Try to focus this component.
  getBox[Boolean local] ) : s BoxComponent
Gets the current box measurements of the component's underlying element.
  getDocMarkup() : void HtmlEditor
Protected method that will not generally be called directly. It is called when the editor initializes the iframe with...
  getEl() : Ext.Element Component
Returns the underlying Ext.Element.
  getId() : String Component
Returns the id of this component.
  getName() : String Field
Returns the name attribute of the field if available
  getPosition[Boolean local] ) : Array BoxComponent
Gets the current XY position of the component's underlying element.
  getRawValue() : Mixed Field
Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.
  getSize() : Object BoxComponent
Gets the current size of the component's underlying element.
  getToolbar() : Ext.Toolbar HtmlEditor
Returns the editor's toolbar. This is only available after the editor has been rendered.
  getValue() : Mixed Field
Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRa...
  hasListenerString eventName ) : Boolean Observable
Checks to see if this object has any listeners for a specified event
  hide() : Ext.Component Component
Hide this component.
  insertAtCursorString text ) : void HtmlEditor
Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated to insert ...
  isDirty() : void Field
Returns true if this field has been changed since it was originally loaded and is not disabled.
  isValidBoolean preventMark ) : Boolean Field
Returns whether or not the field value is currently valid
  isVisible() : void Component
Returns true if this component is visible.
  onString eventName, Function handler, [Object scope], [Object options] ) : void Observable
Appends an event handler to this element (shorthand for addListener)
  onPositionNumber x, Number y ) : void BoxComponent
Called after the component is moved, this method is empty by default but can be implemented by any subclass that need...
  onResizeNumber adjWidth, Number adjHeight, Number rawWidth, Number rawHeight ) : void BoxComponent
Called after the component is resized, this method is empty by default but can be implemented by any subclass that ne...
  purgeListeners() : void Observable
Removes all listeners for this object
  pushValue() : void HtmlEditor
Protected method that will not generally be called directly. Pushes the value of the textarea into the iframe editor.
  relayCmdString cmd, [String/Boolean value] ) : void HtmlEditor
Executes a Midas editor command on the editor document and performs necessary focus and toolbar updates. This should ...
  removeListenerString eventName, Function handler, [Object scope] ) : void Observable
Removes a listener
  render[String/HTMLElement/Element container] ) : void Component
If this is a lazy rendering component, render it to its container element.
  reset() : void Field
Resets the current field value to the originally loaded value and clears any validation messages
  setDisabledBoolean disabled ) : void Component
Convenience function for setting disabled/enabled by boolean.
  setPagePositionNumber x, Number y ) : s BoxComponent
Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the ...
  setPositionNumber left, Number top ) : s BoxComponent
Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires ...
  setRawValueMixed value ) : void Field
Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.
  setSizeNumber/Object width, Number height ) : Ext.BoxComponent BoxComponent
Sets the width and height of the component. This method fires the resize event. This method can accept either width...
  setValueMixed value ) : void Field
Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.
  setVisibleBoolean visible ) : Ext.Component Component
Convenience function to hide or show this component by boolean.
  show() : Ext.Component Component
Show this component.
  syncSize() : s BoxComponent
Force the component's size to recalculate based on the underlying element's current height and width.
  syncValue() : void HtmlEditor
Protected method that will not generally be called directly. Syncs the contents of the editor iframe with the textarea.
  toggleSourceEdit[Boolean sourceEdit] ) : void HtmlEditor
Toggles the editor between standard and source edit mode.
  unString eventName, Function handler, [Object scope] ) : void Observable
Removes a listener (shorthand for removeListener)
  updateBoxObject box ) : s BoxComponent
Sets the current box measurements of the component's underlying element.
  updateToolbar() : void HtmlEditor
Protected method that will not generally be called directly. It triggers a toolbar update by reading the markup state...
  validate() : Boolean Field
Validates the field value

Public Events

Event Defined By
  activate : ( HtmlEditor this ) HtmlEditor
Fires when the editor is first receives the focus. Any insertion must wait until after this event.
  beforedestroy : ( Ext.Component this ) Component
Fires before the component is destroyed. Return false to stop the destroy.
  beforehide : ( Ext.Component this ) Component
Fires before the component is hidden. Return false to stop the hide.
  beforepush : ( HtmlEditor this, String html ) HtmlEditor
Fires before the iframe editor is updated with content from the textarea. Return false to cancel the push.
  beforerender : ( Ext.Component this ) Component
Fires before the component is rendered. Return false to stop the render.
  beforeshow : ( Ext.Component this ) Component
Fires before the component is shown. Return false to stop the show.
  beforesync : ( HtmlEditor this, String html ) HtmlEditor
Fires before the textarea is updated with content from the editor iframe. Return false to cancel the sync.
  destroy : ( Ext.Component this ) Component
Fires after the component is destroyed.
  disable : ( Ext.Component this ) Component
Fires after the component is disabled.
  editmodechange : ( HtmlEditor this, Boolean sourceEdit ) HtmlEditor
Fires when the editor switches edit modes
  enable : ( Ext.Component this ) Component
Fires after the component is enabled.
  hide : ( Ext.Component this ) Component
Fires after the component is hidden.
  initialize : ( HtmlEditor this ) HtmlEditor
Fires when the editor is fully initialized (including the iframe)
  invalid : ( Ext.form.Field this, String msg ) Field
Fires after the field has been marked as invalid.
  move : ( Ext.Component this, Number x, Number y ) BoxComponent
Fires after the component is moved.
  push : ( HtmlEditor this, String html ) HtmlEditor
Fires when the iframe editor is updated with content from the textarea.
  render : ( Ext.Component this ) Component
Fires after the component is rendered.
  resize : ( Ext.Component this, Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight ) BoxComponent
Fires after the component is resized.
  show : ( Ext.Component this ) Component
Fires after the component is shown.
  sync : ( HtmlEditor this, String html ) HtmlEditor
Fires when the textarea is updated with content from the editor iframe.
  valid : ( Ext.form.Field this ) Field
Fires after the field has been validated with no errors.

Config Options

Config Options Defined By
  allowDomMove : Boolean Component
Whether the component can move the Dom node when rendering (defaults to true).
  cls : String Field
A CSS class to apply to the field's underlying element.
  createLinkText : String HtmlEditor
The default text for the create link prompt
  defaultLinkValue : String HtmlEditor
The default value for the create link prompt (defaults to http:/ /)
  disableClass : String Component
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
  disabled : Boolean Field
True to disable the field (defaults to false).
  enableAlignments : Boolean HtmlEditor
Enable the left, center, right alignment buttons (defaults to true)
  enableColors : Boolean HtmlEditor
Enable the fore/highlight color buttons (defaults to true)
  enableFont : Boolean HtmlEditor
Enable font selection. Not available in Safari. (defaults to true)
  enableFontSize : Boolean HtmlEditor
Enable the increase/decrease font size buttons (defaults to true)
  enableFormat : Boolean HtmlEditor
Enable the bold, italic and underline buttons (defaults to true)
  enableLinks : Boolean HtmlEditor
Enable the create link button. Not available in Safari. (defaults to true)
  enableLists : Boolean HtmlEditor
Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)
  enableSourceEdit : Boolean HtmlEditor
Enable the switch to source edit button. Not available in Safari. (defaults to true)
  fontFamilies : Array HtmlEditor
An array of available font families
  hideMode : String Component
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi...
  msgTarget : String Field
The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value ...
  name : String Field
The field's HTML name attribute.
  readOnly : Boolean Field
True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM att...
  tabIndex : Number Field
The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyT...
  validationDelay : Number Field
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
  validationEvent : String/Boolean Field
The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").
  value : Mixed Field
A value to initialize this field with.

Property Details

buttonTips

public Object buttonTips
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'
    },
    ...
This property is defined by HtmlEditor.

disabled

public Object disabled
true if this component is disabled. Read-only.
This property is defined by Component.

hidden

public Object hidden
true if this component is hidden. Read-only.
This property is defined by Component.

rendered

public Object rendered
true if this component has been rendered. Read-only.
This property is defined by Component.

Method Details

addEvents

public function addEvents( Object object )
Used to define events on this Observable
Parameters:
  • object : Object
    The object with the events defined
Returns:
  • void
This method is defined by Observable.

addListener

public function addListener( String eventName, Function handler, [Object scope], [Object options] )
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 te 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.

    el.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 which passes the same scope object to all handlers:

    el.on({
    			'click': this.onClick,
        		'mouseover': this.onMouseOver,
        		'mouseout': this.onMouseOut,
        		scope: this
    		});
Returns:
  • void
This method is defined by Observable.

applyTo

public function applyTo( String/HTMLElement/Element el )
Apply the behaviors of this component to an existing element. This is used instead of render().
Parameters:
  • el : String/HTMLElement/Element
    The id of the node, a DOM node or an existing Element
Returns:
  • Ext.form.Field
    this
This method is defined by Field.

cleanHtml

public function cleanHtml( String html )
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 return {String} The cleaned HTML
Returns:
  • void
This method is defined by HtmlEditor.

createToolbar

public function createToolbar( HtmlEditor editor )
Protected method that will not generally be called directly. It is called when the editor creates its toolbar. Override this method if you need to add custom toolbar buttons.
Parameters:
  • editor : HtmlEditor
Returns:
  • void
This method is defined by HtmlEditor.

destroy

public function destroy()
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.
Parameters:
  • None.
Returns:
  • void
This method is defined by Component.

disable

public function disable()
Disable this component.
Parameters:
  • None.
Returns:
  • Ext.Component
    this
This method is defined by Component.

enable

public function enable()
Enable this component.
Parameters:
  • None.
Returns:
  • Ext.Component
    this
This method is defined by Component.

execCmd

public function execCmd( String cmd, [String/Boolean value] )
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
This method is defined by HtmlEditor.

fireEvent

public function fireEvent( String eventName, Object... args )
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
This method is defined by Observable.

focus

public function focus( Boolean selectText )
Try to focus this component.
Parameters:
  • selectText : Boolean
    True to also select the text in this component (if applicable)
Returns:
  • Ext.Component
    this
This method is defined by Component.

getBox

public function getBox( [Boolean local] )
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:
  • s
    {Object} box An object in the format {x, y, width, height}
This method is defined by BoxComponent.

getDocMarkup

public function getDocMarkup()
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
This method is defined by HtmlEditor.

getEl

public function getEl()
Returns the underlying Ext.Element.
Parameters:
  • None.
Returns:
  • Ext.Element
    The element
This method is defined by Component.

getId

public function getId()
Returns the id of this component.
Parameters:
  • None.
Returns:
  • String
This method is defined by Component.

getName

public function getName()
Returns the name attribute of the field if available
Parameters:
  • None.
Returns:
  • String
    name The field name
This method is defined by Field.

getPosition

public function getPosition( [Boolean local] )
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])
This method is defined by BoxComponent.

getRawValue

public function getRawValue()
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
This method is defined by Field.

getSize

public function getSize()
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)}
This method is defined by BoxComponent.

getToolbar

public function getToolbar()
Returns the editor's toolbar. This is only available after the editor has been rendered.
Parameters:
  • None.
Returns:
  • Ext.Toolbar
This method is defined by HtmlEditor.

getValue

public function getValue()
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
This method is defined by Field.

hasListener

public function hasListener( String eventName )
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
This method is defined by Observable.

hide

public function hide()
Hide this component.
Parameters:
  • None.
Returns:
  • Ext.Component
    this
This method is defined by Component.

insertAtCursor

public function insertAtCursor( String text )
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
This method is defined by HtmlEditor.

isDirty

public function isDirty()
Returns true if this field has been changed since it was originally loaded and is not disabled.
Parameters:
  • None.
Returns:
  • void
This method is defined by Field.

isValid

public function isValid( Boolean preventMark )
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
This method is defined by Field.

isVisible

public function isVisible()
Returns true if this component is visible.
Parameters:
  • None.
Returns:
  • void
This method is defined by Component.

on

public function on( String eventName, Function handler, [Object scope], [Object options] )
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
This method is defined by Observable.

onPosition

public function onPosition( Number x, Number y )
Called after the component is moved, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a move occurs.
Parameters:
  • x : Number
    The new x position
  • y : Number
    The new y position
Returns:
  • void
This method is defined by BoxComponent.

onResize

public function onResize( Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight )
Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
Parameters:
  • 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
Returns:
  • void
This method is defined by BoxComponent.

purgeListeners

public function purgeListeners()
Removes all listeners for this object
Parameters:
  • None.
Returns:
  • void
This method is defined by Observable.

pushValue

public function pushValue()
Protected method that will not generally be called directly. Pushes the value of the textarea into the iframe editor.
Parameters:
  • None.
Returns:
  • void
This method is defined by HtmlEditor.

relayCmd

public function relayCmd( String cmd, [String/Boolean value] )
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
This method is defined by HtmlEditor.

removeListener

public function removeListener( String eventName, Function handler, [Object scope] )
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
This method is defined by Observable.

render

public function render( [String/HTMLElement/Element container] )
If this is a lazy rendering component, render it to its container element.
Parameters:
  • container : String/HTMLElement/Element
    (optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.
Returns:
  • void
This method is defined by Component.

reset

public function reset()
Resets the current field value to the originally loaded value and clears any validation messages
Parameters:
  • None.
Returns:
  • void
This method is defined by Field.

setDisabled

public function setDisabled( Boolean disabled )
Convenience function for setting disabled/enabled by boolean.
Parameters:
  • disabled : Boolean
Returns:
  • void
This method is defined by Component.

setPagePosition

public function setPagePosition( Number x, Number y )
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:
  • s
    {Ext.BoxComponent} this
This method is defined by BoxComponent.

setPosition

public function setPosition( Number left, Number top )
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:
  • s
    {Ext.BoxComponent} this
This method is defined by BoxComponent.

setRawValue

public function setRawValue( Mixed value )
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:
  • void
This method is defined by Field.

setSize

public function setSize( Number/Object width, Number height )
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
This method is defined by BoxComponent.

setValue

public function setValue( Mixed value )
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
This method is defined by Field.

setVisible

public function setVisible( Boolean visible )
Convenience function to hide or show this component by boolean.
Parameters:
  • visible : Boolean
    True to show, false to hide
Returns:
  • Ext.Component
    this
This method is defined by Component.

show

public function show()
Show this component.
Parameters:
  • None.
Returns:
  • Ext.Component
    this
This method is defined by Component.

syncSize

public function syncSize()
Force the component's size to recalculate based on the underlying element's current height and width.
Parameters:
  • None.
Returns:
  • s
    {Ext.BoxComponent} this
This method is defined by BoxComponent.

syncValue

public function syncValue()
Protected method that will not generally be called directly. Syncs the contents of the editor iframe with the textarea.
Parameters:
  • None.
Returns:
  • void
This method is defined by HtmlEditor.

toggleSourceEdit

public function toggleSourceEdit( [Boolean sourceEdit] )
Toggles the editor between standard and source edit mode.
Parameters:
  • sourceEdit : Boolean
    (optional) True for source edit, false for standard
Returns:
  • void
This method is defined by HtmlEditor.

un

public function un( String eventName, Function handler, [Object scope] )
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
This method is defined by Observable.

updateBox

public function updateBox( Object box )
Sets the current box measurements of the component's underlying element.
Parameters:
  • box : Object
    An object in the format {x, y, width, height}
Returns:
  • s
    {Ext.BoxComponent} this
This method is defined by BoxComponent.

updateToolbar

public function updateToolbar()
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
This method is defined by HtmlEditor.

validate

public function validate()
Validates the field value
Parameters:
  • None.
Returns:
  • Boolean
    True if the value is valid, else false
This method is defined by Field.

Event Details

activate

public event activate
Fires when the editor is first receives the focus. Any insertion must wait until after this event.
Subscribers will be called with the following parameters:
  • this : HtmlEditor
This event is defined by HtmlEditor.

beforedestroy

public event beforedestroy
Fires before the component is destroyed. Return false to stop the destroy.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforehide

public event beforehide
Fires before the component is hidden. Return false to stop the hide.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforepush

public event beforepush
Fires before the iframe editor is updated with content from the textarea. Return false to cancel the push.
Subscribers will be called with the following parameters:
  • this : HtmlEditor
  • html : String
This event is defined by HtmlEditor.

beforerender

public event beforerender
Fires before the component is rendered. Return false to stop the render.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforeshow

public event beforeshow
Fires before the component is shown. Return false to stop the show.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

beforesync

public event beforesync
Fires before the textarea is updated with content from the editor iframe. Return false to cancel the sync.
Subscribers will be called with the following parameters:
  • this : HtmlEditor
  • html : String
This event is defined by HtmlEditor.

destroy

public event destroy
Fires after the component is destroyed.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

disable

public event disable
Fires after the component is disabled.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

editmodechange

public event editmodechange
Fires when the editor switches edit modes
Subscribers will be called with the following parameters:
  • this : HtmlEditor
  • sourceEdit : Boolean
    True if source edit, false if standard editing.
This event is defined by HtmlEditor.

enable

public event enable
Fires after the component is enabled.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

hide

public event hide
Fires after the component is hidden.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

initialize

public event initialize
Fires when the editor is fully initialized (including the iframe)
Subscribers will be called with the following parameters:
  • this : HtmlEditor
This event is defined by HtmlEditor.

invalid

public event invalid
Fires after the field has been marked as invalid.
Subscribers will be called with the following parameters:
  • this : Ext.form.Field
  • msg : String
    The validation message
This event is defined by Field.

move

public event move
Fires after the component is moved.
Subscribers will be called with the following parameters:
  • this : Ext.Component
  • x : Number
    The new x position
  • y : Number
    The new y position
This event is defined by BoxComponent.

push

public event push
Fires when the iframe editor is updated with content from the textarea.
Subscribers will be called with the following parameters:
  • this : HtmlEditor
  • html : String
This event is defined by HtmlEditor.

render

public event render
Fires after the component is rendered.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

resize

public event resize
Fires after the component is resized.
Subscribers will be called with the following parameters:
  • 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
This event is defined by BoxComponent.

show

public event show
Fires after the component is shown.
Subscribers will be called with the following parameters:
  • this : Ext.Component
This event is defined by Component.

sync

public event sync
Fires when the textarea is updated with content from the editor iframe.
Subscribers will be called with the following parameters:
  • this : HtmlEditor
  • html : String
This event is defined by HtmlEditor.

valid

public event valid
Fires after the field has been validated with no errors.
Subscribers will be called with the following parameters:
  • this : Ext.form.Field
This event is defined by Field.

Config Details

allowDomMove

allowDomMove : Boolean
Whether the component can move the Dom node when rendering (defaults to true).
This config option is defined by Component.

cls

cls : String
A CSS class to apply to the field's underlying element.
This config option is defined by Field.

createLinkText

createLinkText : String
The default text for the create link prompt
This config option is defined by HtmlEditor.

defaultLinkValue

defaultLinkValue : String
The default value for the create link prompt (defaults to http:/ /)
This config option is defined by HtmlEditor.

disableClass

disableClass : String
CSS class added to the component when it is disabled (defaults to "x-item-disabled").
This config option is defined by Component.

disabled

disabled : Boolean
True to disable the field (defaults to false).
This config option is defined by Field.

enableAlignments

enableAlignments : Boolean
Enable the left, center, right alignment buttons (defaults to true)
This config option is defined by HtmlEditor.

enableColors

enableColors : Boolean
Enable the fore/highlight color buttons (defaults to true)
This config option is defined by HtmlEditor.

enableFont

enableFont : Boolean
Enable font selection. Not available in Safari. (defaults to true)
This config option is defined by HtmlEditor.

enableFontSize

enableFontSize : Boolean
Enable the increase/decrease font size buttons (defaults to true)
This config option is defined by HtmlEditor.

enableFormat

enableFormat : Boolean
Enable the bold, italic and underline buttons (defaults to true)
This config option is defined by HtmlEditor.

enableLinks

enableLinks : Boolean
Enable the create link button. Not available in Safari. (defaults to true)
This config option is defined by HtmlEditor.

enableLists

enableLists : Boolean
Enable the bullet and numbered list buttons. Not available in Safari. (defaults to true)
This config option is defined by HtmlEditor.

enableSourceEdit

enableSourceEdit : Boolean
Enable the switch to source edit button. Not available in Safari. (defaults to true)
This config option is defined by HtmlEditor.

fontFamilies

fontFamilies : Array
An array of available font families
This config option is defined by HtmlEditor.

hideMode

hideMode : String
How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display".
This config option is defined by Component.

msgTarget

msgTarget : String
The location where error text should display. Should be one of the following values (defaults to 'qtip'):
Value         Description
-----------   ----------------------------------------------------------------------
qtip          Display a quick tip when the user hovers over the field
title         Display a default browser title attribute popup
under         Add a block div beneath the field containing the error text
side          Add an error icon to the right of the field with a popup on hover
[element id]  Add the error text directly to the innerHTML of the specified element
This config option is defined by Field.

name

name : String
The field's HTML name attribute.
This config option is defined by Field.

readOnly

readOnly : Boolean
True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.
This config option is defined by Field.

tabIndex

tabIndex : Number
The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).
This config option is defined by Field.

validationDelay

validationDelay : Number
The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)
This config option is defined by Field.

validationEvent

validationEvent : String/Boolean
The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").
This config option is defined by Field.

value

value : Mixed
A value to initialize this field with.
This config option is defined by Field.

Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.