Class Ext.Editor

Package:	Ext
Class:	Editor
Extends:	Component
Defined In:	Editor.js

A base editor field that handles displaying/hiding on demand and has some built-in sizing and event handling logic.

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	disabled : Object	Component
	true if this component is disabled. Read-only.	Component
	disabledClass : Object	Component
	CSS class added to the component when it is disabled.	Component
	hidden : Object	Component
	true if this component is hidden. Read-only.	Component
	rendered : Object	Component
	true if this component has been rendered. Read-only.	Component

Public Methods

Method		Defined By
	Editor(`Object config`)	Editor
	Create a new Editor	Editor
	addEvents(`Object object`) : void	Observable
	Copies any events from the passed object onto this object if they do not already exist. The passed object must also ...	Observable
	addListener(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this component	Observable
	cancelEdit(`Boolean remainVisible`) : void	Editor
	Cancels the editing process and hides the editor without persisting any changes. The field value will be reverted to...	Editor
	completeEdit(`Boolean remainVisible`) : void	Editor
	Ends the editing process, persist the changed value to the underlying field and hides the editor.	Editor
	disable() : void	Component
	Disable this component	Component
	enable() : void	Component
	Enable this component	Component
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	focus(`Boolean selectText`) : void	Component
	Try to focus this component	Component
	getEl() : Ext.Element	Component
	Returns the underlying Ext.Element	Component
	getValue() : Mixed	Editor
	Gets the data value of the editor	Editor
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object is currently listening for a specified event	Observable
	hide() : void	Component
	Hide this component	Component
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this element (shorthand for addListener)	Observable
	purgeListeners() : void	Observable
	Removes all listeners for this object	Observable
	realign() : void	Editor
	Realigns the editor to the bound field based on the current alignment config value.	Editor
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	render(`String/HTMLElement/Element container`) : void	Component
	If this is a lazy rendering component, render it to it's container element	Component
	setDisabled(`Boolean disabled`) : void	Component
	Convenience function for setting disabled/enabled by boolean	Component
	setSize(`Number width`, `Number height`) : void	Editor
	Sets the height and width of this editor	Editor
	setValue(`Mixed value`) : void	Editor
	Sets the data value of the editor	Editor
	setVisible(`Boolean visible`) : void	Component
	Convenience function to hide or show this component by boolean	Component
	show() : void	Component
	Show this component	Component
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable

Public Events

Event		Defined By
	beforecomplete : (`Editor this`, `Mixed value`, `Mixed startValue`)	Editor
	Fires after a change has been made to the field, but before the change is reflected in the underlying field. Saving ...	Editor
	beforedestroy : (`Ext.Component this`)	Component
	Fires before the component is destroyed	Component
	beforehide : (`Ext.Component this`)	Component
	Fires before the component is hidden	Component
	beforerender : (`Ext.Component this`)	Component
	Fires before the component is rendered	Component
	beforeshow : (`Ext.Component this`)	Component
	Fires before the component is shown	Component
	beforestartedit : (`Editor this`, `Ext.Element boundEl`, `Mixed value`)	Editor
	Fires when editing is initiated, but before the value changes. Editing can be canceled by returning false from the h...	Editor
	complete : (`Editor this`, `Mixed value`, `Mixed startValue`)	Editor
	Fires after editing is complete and any changed value has been written to the underlying field.	Editor
	destroy : (`Ext.Component this`)	Component
	Fires after the component is destroyed	Component
	disable : (`Ext.Component this`)	Component
	Fires after the component is disabled	Component
	enable : (`Ext.Component this`)	Component
	Fires after the component is enabled	Component
	hide : (`Ext.Component this`)	Component
	Fires after the component is hidden	Component
	render : (`Ext.Component this`)	Component
	Fires after the component is rendered	Component
	show : (`Ext.Component this`)	Component
	Fires after the component is shown	Component
	specialkey : ()	Editor
	Fires when special key is pressed	Editor
	startedit : (`Ext.Element boundEl`, `Mixed value`)	Editor
	Fires when this editor is displayed	Editor

Config Options

Config Options		Defined By
	alignment : String	Editor
	The position to align to (see Ext.Element.alignTo for more details, defaults to "c-c?").	Editor
	autosize : Boolean/String	Editor
	True for the editor to automatically adopt the size of the underlying field, "width" to adopt the width only, or "hei...	Editor
	ignoreNoChange : Boolean	Editor
	True to skip the the edit completion process (no save, no events fired) if the user completes an edit and the value h...	Editor
	revertInvalid : Boolean	Editor
	True to automatically revert the field value and cancel the edit when the user completes an edit and the field valida...	Editor
	shadow : Boolean/String	Editor
	"sides" for sides/bottom only, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to "frame")	Editor
	value : Mixed	Editor
	The data value of the underlying field (defaults to "")	Editor

Property Details

disabled

public Object disabled

true if this component is disabled. Read-only.

This property is defined by Component.

disabledClass

public Object disabledClass

CSS class added to the component when it is disabled.

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.

Constructor Details

Editor

public function Editor(Object config)

Create a new Editor

Parameters:

config : Object
The config object

Method Details

addEvents

public function addEvents(Object object)

Copies any events from the passed object onto this object if they do not already exist. The passed object must also inherit from Observable for this method to have any effect.

Parameters:

object : Object
The object from which to copy events

Returns:

void

This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [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
options : Object
(optional)

Returns:

void

This method is defined by Observable.

cancelEdit

public function cancelEdit(Boolean remainVisible)

Cancels the editing process and hides the editor without persisting any changes. The field value will be reverted to the original starting value.

Parameters:

remainVisible : Boolean
Override the default behavior and keep the editor visible after cancel (defaults to false)

Returns:

void

This method is defined by Editor.

completeEdit

public function completeEdit(Boolean remainVisible)

Ends the editing process, persist the changed value to the underlying field and hides the editor.

Parameters:

remainVisible : Boolean
Override the default behavior and keep the editor visible after edit (defaults to false)

Returns:

void

This method is defined by Editor.

disable

public function disable()

Disable this component

Parameters:

None.

Returns:

void

This method is defined by Component.

enable

public function enable()

Enable this component

Parameters:

None.

Returns:

void

This method is defined by Component.

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:

void

This method is defined by Component.

getEl

public function getEl()

Returns the underlying Ext.Element

Parameters:

None.

Returns:

Ext.Element
The element

This method is defined by Component.

getValue

public function getValue()

Gets the data value of the editor

Parameters:

None.

Returns:

Mixed
value The data value

This method is defined by Editor.

hasListener

public function hasListener(String eventName)

Checks to see if this object is currently listening 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:

void

This method is defined by Component.

on

public function on(String eventName, Function handler, [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
options : Object
(optional)

Returns:

void

This method is defined by Observable.

purgeListeners

public function purgeListeners()

Removes all listeners for this object

Parameters:

None.

Returns:

void

This method is defined by Observable.

realign

public function realign()

Realigns the editor to the bound field based on the current alignment config value.

Parameters:

None.

Returns:

void

This method is defined by Editor.

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 it's container element

Parameters:

container : String/HTMLElement/Element
The element this component should be rendered into

Returns:

void

This method is defined by Component.

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.

setSize

public function setSize(Number width, Number height)

Sets the height and width of this editor

Parameters:

width : Number
The new width
height : Number
The new height

Returns:

void

This method is defined by Editor.

setValue

public function setValue(Mixed value)

Sets the data value of the editor

Parameters:

value : Mixed
Any valid value supported by the underlying field

Returns:

void

This method is defined by Editor.

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:

void

This method is defined by Component.

show

public function show()

Show this component

Parameters:

None.

Returns:

void

This method is defined by Component.

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.

Event Details

beforecomplete

public event beforecomplete

Fires after a change has been made to the field, but before the change is reflected in the underlying field. Saving the change to the field can be canceled by returning false from the handler of this event. Note that if the value has not changed and ignoreNoChange = true, the editing will still end but this event will not fire since no edit actually occurred.