Class Ext.form.TriggerField

Package:	Ext.form
Class:	TriggerField
Extends:	TextField
Subclasses:	ComboBox, DateField
Defined In:	TriggerField.js

Provides a convenient wrapper for TextFields that adds a clickable trigger button (looks like a combobox by default). The trigger has no default action, so you must assign a function to implement the trigger click handler by overriding onTriggerClick. You can create a TriggerField directly, as it renders exactly like a combobox for which you can provide a custom implementation. For example:

var trigger = new Ext.form.TriggerField();
trigger.onTriggerClick = myTriggerFn;
trigger.applyTo('my-field');

However, in general you will most likely want to use TriggerField as the base class for a reusable component. Ext.form.DateField and Ext.form.ComboBox are perfect examples of this.

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
	TriggerField(`Object config`)	TriggerField
	Create a new TriggerField.	TriggerField
	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
	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
	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
	getName() : String	Field
	Returns the name attribute of the field if available	Field
	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
	getValue() : Mixed	Field
	Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getVa...	Field
	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
	isValid() : Boolean	Field
	Returns whether or not the field value is currently valid	Field
	markInvalid(`String msg`) : void	Field
	Mark this field as invalid	Field
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this element (shorthand for addListener)	Observable
	onTriggerClick(`EventObject e`) : void	TriggerField
	The function that should handle the trigger's click event. This method does nothing by default until overridden by a...	TriggerField
	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 it's container element	Component
	reset() : void	Field
	Resets the current field value to the originally-loaded value and clears any validation messages	Field
	selectText([`Number start`], [`Number end`]) : void	TextField
	Selects text in this field	TextField
	setDisabled(`Boolean disabled`) : void	Component
	Convenience function for setting disabled/enabled by boolean	Component
	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 width`, `Number height`) : void	Field
	Sets the height and width of the field	Field
	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`) : 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
	validate() : Boolean	Field
	Validates the field value	Field
	validateValue(`Mixed value`) : Boolean	TextField
	Validates a value according to the field's validation rules and marks the field as invalid if the validation fails	TextField

Public Events

Event		Defined By
	autosize : (`Ext.form.Field this`, `Number width`)	TextField
	Fires when the autosize function is triggered. The field may or may not have actually changed size according to the ...	TextField
	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
	blur : (`Ext.form.Field this`)	Field
	Fires when	Field
	change : (`Ext.form.Field this`, `Mixed value`, `Mixed value`)	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
	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 : (`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
	allowBlank : Boolean	TextField
	False to validate that the value length > 0 (defaults to true)	TextField
	autoCreate : String/Object	TriggerField
	A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "16", au...	TriggerField
	blankText : String	TextField
	Error text to display if the allow blank validation fails (defaults to "This field is required")	TextField
	disableKeyFilter : Boolean	TextField
	True to disable input keystroke filtering (defaults to false)	TextField
	emptyClass : String	TextField
	The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is aut...	TextField
	emptyText : String	TextField
	The default text to display in an empty field (defaults to null).	TextField
	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
	grow : Boolean	TextField
	True if this field should automatically grow and shrink to it's content	TextField
	growMax : Number	TextField
	The maximum width to allow when grow = true (defaults to 800)	TextField
	growMin : Number	TextField
	The minimum width to allow when grow = true (defaults to 30)	TextField
	hideTrigger : Boolean	TriggerField
	True to hide the trigger element and display only the base text field (defaults to false)	TriggerField
	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
	maskRe : String	TextField
	An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)	TextField
	maxLength : Number	TextField
	Maximum input field length allowed (defaults to Number.MAX_VALUE)	TextField
	maxLengthText : String	TextField
	Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxL...	TextField
	minLength : Number	TextField
	Minimum input field length required (defaults to 0)	TextField
	minLengthText : String	TextField
	Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minL...	TextField
	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 Desc...	Field
	regex : RegExp	TextField
	A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, t...	TextField
	regexText : String	TextField
	The error text to display if regex is used and the test fails during validation (defaults to "")	TextField
	selectOnFocus : Boolean	TextField
	True to automatically select any existing field text when the field receives input focus (defaults to false)	TextField
	triggerClass : String	TriggerField
	An additional CSS class used to style the trigger button. The trigger will always get the class 'x-form-trigger' by d...	TriggerField
	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
	validator : Function	TextField
	A custom validation function to be called during field validation (defaults to null). If available, this function wil...	TextField
	vtype : String	TextField
	A validation type name as defined in Ext.form.VTypes (defaults to null)	TextField

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

TriggerField

public function TriggerField(Object config)

Create a new TriggerField.

Parameters:

config : Object
Configuration options (valid {@Ext.form.TextField} config options will also be applied to the base TextField)

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.

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.

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.

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 getValue.

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 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.

isValid

public function isValid()

Returns whether or not the field value is currently valid

Parameters:

None.

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.

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.

onTriggerClick

public function onTriggerClick(EventObject e)

The function that should handle the trigger's click event. This method does nothing by default until overridden by a handler implementation.

Parameters:

e : EventObject

Returns:

void

This method is defined by TriggerField.

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 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.

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.

selectText

public function selectText([Number start], [Number end])

Selects text in this field

Parameters:

start : Number
(optional) The index where the selection should start (defaults to 0)
end : Number
(optional) The index where the selection should end (defaults to the text length)

Returns:

void

This method is defined by TextField.

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.

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 width, Number height)

Sets the height and width of the field

Parameters:

width : Number
The new field width in pixels
height : Number
The new field height in pixels

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.

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.

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.

validateValue

public function validateValue(Mixed value)

Validates a value according to the field's validation rules and marks the field as invalid if the validation fails

Parameters:

value : Mixed
The value to validate

Returns:

Boolean
True if the value is valid, else false

This method is defined by TextField.

Event Details

autosize

public event autosize

Fires when the autosize function is triggered. The field may or may not have actually changed size according to the default logic, but this event provides a hook for the developer to apply additional logic at runtime to resize the field if needed.

Subscribers will be called with the following parameters:

this : Ext.form.Field
This text field
width : Number
The new field width

This event is defined by TextField.

beforedestroy

public event beforedestroy

Fires before the component is destroyed

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

beforehide

public event beforehide

Fires before the component is hidden

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

beforerender

public event beforerender

Fires before the component is rendered

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

beforeshow

public event beforeshow

Fires before the component is shown

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

blur

public event blur

Fires when

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.

destroy

public event destroy

Fires after the component is destroyed

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

disable

public event disable

Fires after the component is disabled

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

enable

public event enable

Fires after the component is enabled

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

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.

hide

public event hide

Fires after the component is hidden

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

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.

render

public event render

Fires after the component is rendered

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

show

public event show

Fires after the component is shown

Subscribers will be called with the following parameters:

this : Ext.Component

This event is defined by Component.

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

allowBlank

allowBlank : Boolean

False to validate that the value length > 0 (defaults to true)

This config option is defined by TextField.

autoCreate

autoCreate : String/Object

A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "16", autocomplete: "off"})

This config option is defined by TriggerField.

blankText

blankText : String

Error text to display if the allow blank validation fails (defaults to "This field is required")

This config option is defined by TextField.

disableKeyFilter

disableKeyFilter : Boolean

True to disable input keystroke filtering (defaults to false)

This config option is defined by TextField.

emptyClass

emptyClass : String

The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is automatically added and removed as needed depending on the current field value.

This config option is defined by TextField.

emptyText

emptyText : String

The default text to display in an empty field (defaults to null).

This config option is defined by TextField.

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.

grow

grow : Boolean

True if this field should automatically grow and shrink to it's content

This config option is defined by TextField.

growMax

growMax : Number

The maximum width to allow when grow = true (defaults to 800)

This config option is defined by TextField.

growMin

growMin : Number

The minimum width to allow when grow = true (defaults to 30)

This config option is defined by TextField.

hideTrigger

hideTrigger : Boolean

True to hide the trigger element and display only the base text field (defaults to false)

This config option is defined by TriggerField.

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.

maskRe

maskRe : String

An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)

This config option is defined by TextField.

maxLength

maxLength : Number

Maximum input field length allowed (defaults to Number.MAX_VALUE)

This config option is defined by TextField.

maxLengthText

maxLengthText : String

Error text to display if the maximum length validation fails (defaults to "The maximum length for this field is {maxLength}")

This config option is defined by TextField.

minLength

minLength : Number

Minimum input field length required (defaults to 0)

This config option is defined by TextField.

minLengthText

minLengthText : String

Error text to display if the minimum length validation fails (defaults to "The minimum length for this field is {minLength}")

This config option is defined by TextField.

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.

regex

regex : RegExp

A JavaScript RegExp object to be tested against the field value during validation (defaults to null). If available, this regex will be evaluated only after the basic validators all return true, and will be passed the current field value. If the test fails, the field will be marked invalid using regexText.

This config option is defined by TextField.

regexText

regexText : String

The error text to display if regex is used and the test fails during validation (defaults to "")

This config option is defined by TextField.

selectOnFocus

selectOnFocus : Boolean

True to automatically select any existing field text when the field receives input focus (defaults to false)

This config option is defined by TextField.

triggerClass

triggerClass : String

An additional CSS class used to style the trigger button. The trigger will always get the class 'x-form-trigger' by default and triggerClass will be appended if specified.

This config option is defined by TriggerField.

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.

validator

validator : Function

A custom validation function to be called during field validation (defaults to null). If available, this function will be called only after the basic validators all return true, and will be passed the current field value and expected to return boolean true if the value is valid or a string error message if invalid.

This config option is defined by TextField.

vtype

vtype : String

A validation type name as defined in Ext.form.VTypes (defaults to null)

This config option is defined by TextField.