Print Friendly

Class Ext.form.Field

Package:Ext.form
Class:Field
Extends:Ext.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

This class has no public properties.

Public Methods

Method Defined By
  Field(Object config) Field
Creates a new Field
  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().
  clearInvalid() : void Field
Clear any invalid styles/messages for this field
  getName() : String Field
Returns the name attribute of the field if available
  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.
  getValue() : Mixed Field
Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getRa...
  initComponent() : void Field
*
  isDirty() : void Field
Returns true if this field has ben changed since it was originally loaded and is not disabled.
  isValid(Boolean preventMark) : Boolean Field
Returns whether or not the field value is currently valid
  markInvalid(String msg) : void Field
Mark this field as invalid
  reset() : void Field
Resets the current field value to the originally-loaded value and clears any validation messages
  setRawValue(Mixed value) : void Field
Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.
  setValue(Mixed value) : void Field
Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.
  validate() : Boolean Field
Validates the field value

Public Events

Event Defined By
  blur : (Ext.form.Field this) Field
Fires when this field loses input focus.
  change : (Ext.form.Field this, Mixed value, Mixed value) Field
Fires just before the field blurs if the field value has changed.
  focus : (Ext.form.Field this) Field
Fires when this field receives input focus.
  invalid : (Ext.form.Field this, String msg) Field
Fires after the field has been marked as invalid.
  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...
  valid : (Ext.form.Field this) Field
Fires after the field has been validated with no errors.

Config Options

Config Options Defined By
  autoCreate : String/Object Field
A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", au...
  fieldClass : String Field
The default CSS class for the field (defaults to "x-form-field")
  focusClass : String Field
The CSS class to use when the field receives focus (defaults to "x-form-focus")
  inputType : String Field
The type attribute for input fields - e.g. radio, text, password. (defaults to "text")
  invalidClass : String Field
The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
  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...
  msgFx : String Field
Experimental The effect used when displaying a validation message under the field (defaults to 'normal').
  msgTarget : String Field
The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value Desc...
  name : String Field
The field's HTML name attribute
  readOnly : Boolean Field
True to mark the field as readOnly in HTML - Note: this only sets the readOnly attribute.
  validateOnBlur : String/Boolean Field
Defaults to true.
  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

Constructor Details

Field

public function Field(Object config)
Creates a new Field
Parameters:
  • config : Object
    Configuration options

Method Details

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.

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.

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.

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.

initComponent

public function initComponent()
*
Parameters:
  • None.
Returns:
  • void
This method is defined by Field.

isDirty

public function isDirty()
Returns true if this field has ben 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.

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.

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.

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.

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.

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

blur

public event blur
Fires when this field loses input focus.
Subscribers will be called with the following parameters:
  • this : Ext.form.Field
This event is defined by Field.

change

public event change
Fires just before the field blurs if the field value has changed.
Subscribers will be called with the following parameters:
  • this : Ext.form.Field
  • value : Mixed
    The changed value
  • value : Mixed
    The original value
This event is defined by Field.

focus

public event focus
Fires when this field receives input focus.
Subscribers will be called with the following parameters:
  • this : Ext.form.Field
This event is defined by Field.

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.

specialkey

public event specialkey
Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check Ext.EventObject.getKey to determine which key was pressed.
Subscribers will be called with the following parameters:
  • this : Ext.form.Field
  • e : Ext.EventObject
    The event object
This event is defined by Field.

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

autoCreate

autoCreate : String/Object
A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"})
This config option is defined by Field.

fieldClass

fieldClass : String
The default CSS class for the field (defaults to "x-form-field")
This config option is defined by Field.

focusClass

focusClass : String
The CSS class to use when the field receives focus (defaults to "x-form-focus")
This config option is defined by Field.

inputType

inputType : String
The type attribute for input fields - e.g. radio, text, password. (defaults to "text")
This config option is defined by Field.

invalidClass

invalidClass : String
The CSS class to use when marking a field invalid (defaults to "x-form-invalid")
This config option is defined by Field.

invalidText

invalidText : String
The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid")
This config option is defined by Field.

msgFx

msgFx : String
Experimental The effect used when displaying a validation message under the field (defaults to 'normal').
This config option is defined by Field.

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 - Note: this only sets the readOnly attribute.
This config option is defined by Field.

validateOnBlur

validateOnBlur : String/Boolean
Defaults to true.
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.