+ + + +

+ +

+ + + + +

Roo.BoxComponent
+Roo.form.Field 
+
+

+ + + + +

+ + Class Roo.form.Field +

+ + + + + + + + + + + + + + +

Package:	Roo.form
Defined In:	+ + Roo/form/Field.js. + +
Class:	Field
Extends:	+ Roo.BoxComponent + +

+ + + +

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

+ + + + +

+ Class Comments / Notes => + [Add Your comment/notes about this class] +
+ +

+ + + + + + + + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Config Options (Usually are also Properties)
Options		Defined By
	+ + + + autoCreate : String/Object + + + + + + A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"}) + + + + A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", autocomplete: "off"}) + + + + +	+ + Roo.form.Field + +
	+ + + + cls : String + + + + + + A CSS class to apply to the field's underlying element. + + + + A CSS class to apply to the field's underlying element. + + + + +	+ + Roo.form.Field + +
	+ + + + disabled : Boolean + + + + + + True to disable the field (defaults to false). + + + + True to disable the field (defaults to false). + + + + +	+ + Roo.form.Field + +
	+ + + + fieldClass : String + + + + + + The default CSS class for the field (defaults to "x-form-field") + + + + The default CSS class for the field (defaults to "x-form-field") + + + + +	+ + Roo.form.Field + +
	+ + + + fieldLabel : String + + + + + + Label to use when rendering a form. + + + + Label to use when rendering a form. + + + + +	+ + Roo.form.Field + +
	+ + + + focusClass : String + + + + + + The CSS class to use when the field receives focus (defaults to "x-form-focus") + + + + The CSS class to use when the field receives focus (defaults to "x-form-focus") + + + + +	+ + Roo.form.Field + +
	+ + + + inputType : String + + + + + + The type attribute for input fields -- e.g. + + + + The type attribute for input fields -- e.g. radio, text, password (defaults to "text"). + + + + +	+ + Roo.form.Field + +
	+ + + + invalidClass : String + + + + + + The CSS class to use when marking a field invalid (defaults to "x-form-invalid") + + + + The CSS class to use when marking a field invalid (defaults to "x-form-invalid") + + + + +	+ + Roo.form.Field + +
	+ + + + 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") + + + + The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field is invalid") + + + + +	+ + Roo.form.Field + +
	+ + + + msgFx : String + + + + + + Experimental The effect used when displaying a validation message under the field (defaults to 'normal'). + + + + Experimental The effect used when displaying a validation message under the field (defaults to 'normal'). + + + + +	+ + Roo.form.Field + +
	+ + + + msgTarget : String + + + + + + The location where error text should display. + + + + 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 + + + + +	+ + Roo.form.Field + +
	+ + + + name : String + + + + + + The field's HTML name attribute. + + + + The field's HTML name attribute. + + + + +	+ + Roo.form.Field + +
	+ + + + qtip : String + + + + + + Mouse over tip + + + + Mouse over tip + + + + +	+ + Roo.form.Field + +
	+ + + + readOnly : Boolean + + + + + + True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute. + + + + True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute. + + + + +	+ + Roo.form.Field + +
	+ + + + tabIndex : Number + + + + + + The tabIndex for this field. + + + + The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined). + + + + +	+ + Roo.form.Field + +
	+ + + + validateOnBlur : Boolean + + + + + + Whether the field should validate when it loses focus (defaults to true). + + + + Whether the field should validate when it loses focus (defaults to true). + + + + +	+ + Roo.form.Field + +
	+ + + + validationDelay : Number + + + + + + The length of time in milliseconds after user input begins until validation is initiated (defaults to 250) + + + + The length of time in milliseconds after user input begins until validation is initiated (defaults to 250) + + + + +	+ + Roo.form.Field + +
	+ + + + validationEvent : String/Boolean + + + + + + The event that should initiate field validation. + + + + The event that should initiate field validation. Set to false to disable automatic validation (defaults to "keyup"). + + + + +	+ + Roo.form.Field + +
	+ + + + value : Mixed + + + + + + A value to initialize this field with. + + + + A value to initialize this field with. + + + + +	+ + Roo.form.Field + +

+ + + + + + + + + + + + + + + + + + + + + +

Public Methods
Method		Defined By
	+ + + new Roo.form.Field + + (Object *config) + + + + + + + + Create a new Roo.form.Field + + + + + + + Create a new Roo.form.Field + + + + Parameters: + + + Object config* + + + Configuration options + + + + + + + + + + + + + + + + +	+ +
	+ + + applyTo + + (String/HTMLElement/Element el) + + + : + + + Roo.form.Field + + + + + + + + + Apply the behaviors of this component to an existing element. + + + + + + Apply the behaviors of this component to an existing element. This is used instead of render(). + + + + + + + + Parameters: + + + String/HTMLElement/Element el + + + The id of the node, a DOM node or an existing Element + + + + + + + + + Returns: + + Roo.form.Field this + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + clearInvalid + + () + + + + + + + Clear any invalid styles/messages for this field + + + + + + Clear any invalid styles/messages for this field + + + + + + + + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + getName + + () + + + : + + + String + + + + + + + + + Returns the name attribute of the field if available + + + + + + Returns the name attribute of the field if available + + + + + + + + + + + + Returns: + + String name The field name + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + getRawValue + + () + + + : + + + Mixed + + + + + + + + + Returns the raw data value which may or may not be a valid, defined value. + + + + + + Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {link getValue}. + + + + + + + + + + + + Returns: + + Mixed value The field value + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + getValue + + () + + + : + + + Mixed + + + + + + + + + Returns the normalized data value (undefined or emptyText will be returned as ''). + + + + + + Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {link getRawValue}. + + + + + + + + + + + + Returns: + + Mixed value The field value + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + isDirty + + () + + + + + + + Returns true if this field has been changed since it was originally loaded and is not disabled. + + + + + + Returns true if this field has been changed since it was originally loaded and is not disabled. + + + + + + + + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + isValid + + (Boolean *preventMark) + + + : + + + Boolean + + + + + + + + + Returns whether or not the field value is currently valid + + + + + + Returns whether or not the field value is currently valid + + + + + + + + Parameters: + + + Boolean preventMark* + + + True to disable marking the field invalid + + + + + + + + + Returns: + + Boolean True if the value is valid, else false + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + markInvalid + + (String *msg) + + + + + + + Mark this field as invalid + + + + + + Mark this field as invalid + + + + + + + + Parameters: + + + String msg* + + + The validation message + + + + + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + reset + + () + + + + + + + Resets the current field value to the originally loaded value and clears any validation messages + + + + + + Resets the current field value to the originally loaded value and clears any validation messages + + + + + + + + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + setRawValue + + (Mixed *value) + + + + + + + Sets the underlying DOM field's value directly, bypassing validation. + + + + + + Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {link* setValue}. + + + + + + + + Parameters: + + + Mixed value + + + The value to set + + + + + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + setValue + + (Mixed *value) + + + + + + + Sets a data value into the field and validates it. + + + + + + Sets a data value into the field and validates it. To set the value directly without validation see {link* setRawValue}. + + + + + + + + Parameters: + + + Mixed value + + + The value to set + + + + + + + + + + + + + + + + +	+ + Roo.form.Field + +
	+ + + validate + + () + + + : + + + Boolean + + + + + + + + + Validates the field value + + + + + + Validates the field value + + + + + + + + + + + + Returns: + + Boolean True if the value is valid, else false + + + + + + + + + + + + +	+ + Roo.form.Field + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Events
Event		Defined By
	+ + + + blur (Roo.form.Field *this) + + + + + + Fires when this field loses input focus. + + + + + + Fires when this field loses input focus. + + + + + + + Parameters: + + + Roo.form.Field this* + + + + + + + + + + + + + + + + + + + +	+ Roo.form.Field +
	+ + + + change (Roo.form.Field *this, Mixed newValue, Mixed oldValue) + + + + + + Fires just before the field blurs if the field value has changed. + + + + + + Fires just before the field blurs if the field value has changed. + + + + + + + Parameters: + + + Roo.form.Field this* + + + + + + Mixed newValue + + + The new value + + + Mixed oldValue + + + The original value + + + + + + + + + + + + + + + + +	+ Roo.form.Field +
	+ + + + focus (Roo.form.Field *this) + + + + + + Fires when this field receives input focus. + + + + + + Fires when this field receives input focus. + + + + + + + Parameters: + + + Roo.form.Field this* + + + + + + + + + + + + + + + + + + + +	+ Roo.form.Field +
	+ + + + invalid (Roo.form.Field *this, String msg) + + + + + + Fires after the field has been marked as invalid. + + + + + + Fires after the field has been marked as invalid. + + + + + + + Parameters: + + + Roo.form.Field this* + + + + + + String msg + + + The validation message + + + + + + + + + + + + + + + + +	+ Roo.form.Field +
	+ + + + specialkey (Roo.form.Field *this, Roo.EventObject e) + + + + + + Fires when any key related to navigation (arrows, tab, enter, esc, etc. + + + + + + Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check {link* Roo.EventObjectgetKey} to determine which key was pressed. + + + + + + + Parameters: + + + Roo.form.Field this + + + + + + Roo.EventObject e + + + The event object + + + + + + + + + + + + + + + + +	+ Roo.form.Field +
	+ + + + valid (Roo.form.Field *this) + + + + + + Fires after the field has been validated with no errors. + + + + + + Fires after the field has been validated with no errors. + + + + + + + Parameters: + + + Roo.form.Field this* + + + + + + + + + + + + + + + + + + + +	+ Roo.form.Field +

+ + + + + + +

+ + Documentation generated by Introspection Doc Generator on Fri Jul 16 2010 15:55:27 GMT+0800 (HKT) + Based on + JsDoc Toolkit +

+ +