Ext.form.Field

The name of the field (defaults to undefined). This is used as the parameter name when including the field value in a form submit(). If no name is configured, it falls back to the inputId. To prevent the field from being included in the form submit, set submitValue to false.

Setting this to false will prevent the field from being submitted even when it is not disabled. Defaults to true.

Specifies whether this field should be validated immediately whenever a change in its value is detected. Defaults to true. If the validation results in a change in the field's validity, a validitychange event will be fired. This allows the field to show feedback about the validity of its contents immediately as the user is typing.

When set to false, feedback will not be immediate. However the form will still be validated before submitting if the clientValidation option to Ext.form.Basic.doAction is enabled, or if the field or form are validated manually.

See also Ext.form.BaseField.checkChangeEventsfor controlling how changes to the field's value are detected.

A value to initialize this field with (defaults to undefined).

The original value of the field as configured in the value configuration, or as loaded by the last form load operation if the form's trackResetOnLoad setting is true.

Checks the isDirty state of the field and if it has changed since the last time it was checked, fires the dirtychange event.

Validates the field and if its validity has changed since the last time it was checked, fires the validitychange event.

Runs this field's validators and returns an array of error messages for any validation failures. This is called internally during validation and would not usually need to be used manually.

Each subclass should override or augment the return value to provide their own errors.

Parameters

• value : Mixed
  The value to get errors for (defaults to the current field value)

Returns

• Array   All error messages for this field; an empty Array if none.

Returns the name attribute of the field. This is used as the parameter name when including the field value in a form submit().

Returns the raw value of the field, without performing any normalization, conversion, or validation. To get a normalized and converted value see getValue.

Returns the value that would be included in a standard form submit for this field. This will be combined with the field's name to form a name=value pair in the submitted parameters. If an empty string is returned then just the name= will be submitted; if null is returned then nothing will be submitted.

Note that the value returned will have been processed but may or may not have been successfully validated.

Returns the current data value of the field. The type of value returned is particular to the type of the particular field (e.g. a Date object for Ext.form.Date), as the result of calling rawToValue on the field's processed String value. To return the raw String value, see getRawValue.

Initializes this Field mixin on the current instance. Components using this mixin should call this method during their own initialization process.

Returns true if the value of this Field has been changed from its originalValue. Will always return false if the field is disabled.

Note that if the owning form was configured with trackResetOnLoad then the {@lnk #originalValue} is updated when the values are loaded by Ext.form.Basic.setValues.

Returns whether or not the field value is currently valid by validating the field's current value. Note: disabled fields are always treated as valid.

Logically this is identical to the validate method, but implementations are encouraged to ensure that this method does not have side-effects such as triggering error message display.

Performs any necessary manipulation of a raw field value to prepare it for conversion and/or validation, for instance stripping out ignored characters. In the base implementation it does nothing; individual subclasses may override this as needed.

Parameters

• value : Mixed
  The unprocessed string value

Returns

• Mixed   The processed string value

Converts a raw input field value into a mixed-type value that is suitable for this particular field type. This allows controlling the normalization and conversion of user-entered values into field-type-appropriate values, e.g. a Date object for Ext.form.Date, and is invoked by getValue.

It is up to individual implementations to decide how to handle raw values that cannot be successfully converted to the desired object type.

See valueToRaw for the opposite conversion.

The base implementation does no conversion, returning the raw value untouched.

Parameters

• rawValue : Mixed

Returns

• Mixed   The converted value.

Resets the current field value to the originally loaded value and clears any validation messages. See Ext.form.Basic.trackResetOnLoad

Sets the field's raw value directly, bypassing value conversion, change detection, and validation. To set the value with these additional inspections see setValue.

Parameters

• value : Mixed
  The value to set

Returns

• Mixed   value The field value that is set

Sets a data value into the field and runs the change detection and validation. To set the value directly without these inspections see setRawValue.

Parameters

• value : Mixed
  The value to set

Returns

• Ext.form.Field   this

Returns whether or not the field value is currently valid by validating the field's current value. Note: disabled fields are always treated as valid.

Logically this is identical to the isValid method, but unlike that method this one may have side-effects such as triggering error message display.

Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows controlling how value objects passed to setValue are shown to the user, including localization. For instance, for a Ext.form.Date, this would control how a Date object passed to setValue would be converted to a String for display in the field.

See rawToValue for the opposite conversion.

The base implementation simply does a standard toString conversion, and converts empty values to an empty string.

Parameters

• value : Mixed
  The mixed-type value to convert to the raw representation.

Returns

• Mixed   The converted raw value.

Fires when a change in the field's isDirty state is detected.

Parameters

• this : Ext.form.Field
• isDirty : Boolean
  Whether or not the field is now dirty

Returns

• Void

Fires when a change in the field's validity is detected.

Parameters

• this : Ext.form.Field
• isValid : Boolean
  Whether or not the field is now valid

Returns

• Void