Class Ext.form.Field

Package:	Ext.form
Class:	Field
Extends:	BoxComponent
Subclasses:	Checkbox, HtmlEditor, TextField
Defined In:	Field.js

Base class for form fields that provides default event handling, sizing, value handling and other functionality.

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	disabled : Object	Component
	true if this component is disabled. Read-only.	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
	Field( `Object config` )	Field
	Creates a new Field	Field
	addEvents( `Object object` ) : void	Observable
	Used to define events on this Observable	Observable
	addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void	Observable
	Appends an event handler to this component	Observable
	applyTo( `String/HTMLElement/Element el` ) : Ext.form.Field	Field
	Apply the behaviors of this component to an existing element. This is used instead of render().	Field
	clearInvalid() : void	Field
	Clear any invalid styles/messages for this field	Field
	destroy() : void	Component
	Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the c...	Component
	disable() : Ext.Component	Component
	Disable this component.	Component
	enable() : Ext.Component	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` ) : Ext.Component	Component
	Try to focus this component.	Component
	getBox( [`Boolean local`] ) : s	BoxComponent
	Gets the current box measurements of the component's underlying element.	BoxComponent
	getEl() : Ext.Element	Component
	Returns the underlying Ext.Element.	Component
	getId() : String	Component
	Returns the id of this component.	Component
	getName() : String	Field
	Returns the name attribute of the field if available	Field
	getPosition( [`Boolean local`] ) : Array	BoxComponent
	Gets the current XY position of the component's underlying element.	BoxComponent
	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.	Field
	getSize() : Object	BoxComponent
	Gets the current size of the component's underlying element.	BoxComponent
	getValue() : Mixed	Field
	Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRa...	Field
	hasListener( `String eventName` ) : Boolean	Observable
	Checks to see if this object has any listeners for a specified event	Observable
	hide() : Ext.Component	Component
	Hide this component.	Component
	isDirty() : void	Field
	Returns true if this field has been changed since it was originally loaded and is not disabled.	Field
	isValid( `Boolean preventMark` ) : Boolean	Field
	Returns whether or not the field value is currently valid	Field
	isVisible() : void	Component
	Returns true if this component is visible.	Component
	markInvalid( `String msg` ) : void	Field
	Mark this field as invalid	Field
	on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void	Observable
	Appends an event handler to this element (shorthand for addListener)	Observable
	onPosition( `Number 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...	BoxComponent
	onResize( `Number 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...	BoxComponent
	purgeListeners() : void	Observable
	Removes all listeners for this object	Observable
	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 its container element.	Component
	reset() : void	Field
	Resets the current field value to the originally loaded value and clears any validation messages	Field
	setDisabled( `Boolean disabled` ) : void	Component
	Convenience function for setting disabled/enabled by boolean.	Component
	setPagePosition( `Number 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 ...	BoxComponent
	setPosition( `Number 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 ...	BoxComponent
	setRawValue( `Mixed value` ) : void	Field
	Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.	Field
	setSize( `Number/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...	BoxComponent
	setValue( `Mixed value` ) : void	Field
	Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.	Field
	setVisible( `Boolean visible` ) : Ext.Component	Component
	Convenience function to hide or show this component by boolean.	Component
	show() : Ext.Component	Component
	Show this component.	Component
	syncSize() : s	BoxComponent
	Force the component's size to recalculate based on the underlying element's current height and width.	BoxComponent
	un( `String eventName`, `Function handler`, [`Object scope`] ) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable
	updateBox( `Object box` ) : s	BoxComponent
	Sets the current box measurements of the component's underlying element.	BoxComponent
	validate() : Boolean	Field
	Validates the field value	Field

Public Events

Event		Defined By
	beforedestroy : ( `Ext.Component this` )	Component
	Fires before the component is destroyed. Return false to stop the destroy.	Component
	beforehide : ( `Ext.Component this` )	Component
	Fires before the component is hidden. Return false to stop the hide.	Component
	beforerender : ( `Ext.Component this` )	Component
	Fires before the component is rendered. Return false to stop the render.	Component
	beforeshow : ( `Ext.Component this` )	Component
	Fires before the component is shown. Return false to stop the show.	Component
	blur : ( `Ext.form.Field this` )	Field
	Fires when this field loses input focus.	Field
	change : ( `Ext.form.Field this`, `Mixed newValue`, `Mixed oldValue` )	Field
	Fires just before the field blurs if the field value has changed.	Field
	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
	focus : ( `Ext.form.Field this` )	Field
	Fires when this field receives input focus.	Field
	hide : ( `Ext.Component this` )	Component
	Fires after the component is hidden.	Component
	invalid : ( `Ext.form.Field this`, `String msg` )	Field
	Fires after the field has been marked as invalid.	Field
	move : ( `Ext.Component this`, `Number x`, `Number y` )	BoxComponent
	Fires after the component is moved.	BoxComponent
	render : ( `Ext.Component this` )	Component
	Fires after the component is rendered.	Component
	resize : ( `Ext.Component this`, `Number adjWidth`, `Number adjHeight`, `Number rawWidth`, `Number rawHeight` )	BoxComponent
	Fires after the component is resized.	BoxComponent
	show : ( `Ext.Component this` )	Component
	Fires after the component is shown.	Component
	specialkey : ( `Ext.form.Field this`, `Ext.EventObject e` )	Field
	Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check Ext.EventObject.g...	Field
	valid : ( `Ext.form.Field this` )	Field
	Fires after the field has been validated with no errors.	Field

Config Options

Config Options		Defined By
	allowDomMove : Boolean	Component
	Whether the component can move the Dom node when rendering (defaults to true).	Component
	autoCreate : String/Object	Field
	A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", au...	Field
	cls : String	Field
	A CSS class to apply to the field's underlying element.	Field
	disableClass : String	Component
	CSS class added to the component when it is disabled (defaults to "x-item-disabled").	Component
	disabled : Boolean	Field
	True to disable the field (defaults to false).	Field
	fieldClass : String	Field
	The default CSS class for the field (defaults to "x-form-field")	Field
	focusClass : String	Field
	The CSS class to use when the field receives focus (defaults to "x-form-focus")	Field
	hideMode : String	Component
	How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset posi...	Component
	inputType : String	Field
	The type attribute for input fields -- e.g. radio, text, password (defaults to "text").	Field
	invalidClass : String	Field
	The CSS class to use when marking a field invalid (defaults to "x-form-invalid")	Field
	invalidText : String	Field
	The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field i...	Field
	msgFx : String	Field
	Experimental The effect used when displaying a validation message under the field (defaults to 'normal').	Field
	msgTarget : String	Field
	The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value ...	Field
	name : String	Field
	The field's HTML name attribute.	Field
	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...	Field
	tabIndex : Number	Field
	The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyT...	Field
	validateOnBlur : Boolean	Field
	Whether the field should validate when it loses focus (defaults to true).	Field
	validationDelay : Number	Field
	The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)	Field
	validationEvent : String/Boolean	Field
	The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup").	Field
	value : Mixed	Field
	A value to initialize this field with.	Field

Property Details

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.

Constructor Details

Field

public function Field( Object config )

Creates a new Field

Parameters:

config : Object
Configuration options

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.

clearInvalid

public function clearInvalid()

Clear any invalid styles/messages for this field

Parameters:

None.

Returns:

void

This method is defined by Field.

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.

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.

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.

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.

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.

markInvalid

public function markInvalid( String msg )

Mark this field as invalid

Parameters:

msg : String
The validation message

Returns:

void

This method is defined by Field.

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.

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.

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.

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.