Ext.form.Number xtype: numberfield

activeError : String

If specified, then the component will be displayed with this value as its active error when first rendered. Defaults ...

If specified, then the component will be displayed with this value as its active error when first rendered. Defaults to undefined. Use setActiveError or unsetActiveError to change it after component creation.

allowBlank : Boolean

Specify false to validate that the value's length is > 0 (defaults to true)

allowDecimals : Boolean

False to disallow decimal values (defaults to true)

autoEl : Mixed

A tag name or DomHelper spec used to create the Element which will encapsulate this Component. You do not normally ne...

A tag name or DomHelper spec used to create the Element which will encapsulate this Component.

You do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container, this defaults to 'div'. The more complex Sencha classes use a more complex DOM structure specified by their own renderTpls.

This is intended to allow the developer to create application-specific utility Components encapsulated by different DOM elements. Example usage:

{
    xtype: 'component',
    autoEl: {
        tag: 'img',
        src: 'http://www.example.com/example.jpg'
    }
}, {
    xtype: 'component',
    autoEl: {
        tag: 'blockquote',
        html: 'autoEl is cool!'
    }
}, {
    xtype: 'container',
    autoEl: 'ul',
    cls: 'ux-unordered-list',
    items: {
        xtype: 'component',
        autoEl: 'li',
        html: 'First list item'
    }
}

autoFitErrors : Boolean

Whether to adjust the component's body area to make room for 'side' or 'under' error messages. Defaults to true.

autoRender : Mixed

This config is intended mainly for floating Components which may or may not be shown. Instead of using renderTo in th...

This config is intended mainly for floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a Component to render itself upon first show.

Specify as true to have this Component render to the document body upon first show.

Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.

This defaults to true for the Window class.

autoScroll : Boolean

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false...

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false to clip any overflowing content (defaults to false).

autoStripChars : Boolean

True to automatically strip not allowed characters from the field. Defaults to false

baseBodyCls : String

The CSS class to be applied to the body content element. Defaults to 'x-form-item-body'.

baseChars : String

The base set of characters to evaluate as valid numbers (defaults to '0123456789').

baseCls : String

The base CSS class to apply to this components's element. This will also be prepended to elements within this compone...

The base CSS class to apply to this components's element. This will also be prepended to elements within this component like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and you want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this component.

blankText : String

The error text to display if the allowBlank validation fails (defaults to 'This field is required')

border : Number/String

Specifies the border for this component. The border can be a single numeric value to apply to all sides or it can be ...

Specifies the border for this component. The border can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

checkChangeBuffer : Number

Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession. Defaults to 50 milli...

Defines a timeout in milliseconds for buffering checkChangeEvents that fire in rapid succession. Defaults to 50 milliseconds.

checkChangeEvents : Array

A list of event names that will be listened for on the field's input element, which will cause the field's value to b...

A list of event names that will be listened for on the field's input element, which will cause the field's value to be checked for changes. If a change is detected, the change event will be fired, followed by validation if the validateOnChange option is enabled.

Defaults to ['change', 'propertychange'] in Internet Explorer, and ['change', 'input', 'textInput', 'keyup', 'dragdrop'] in other browsers. This catches all the ways that field values can be changed in most supported browsers; the only known exceptions at the time of writing are:

Safari 3.2 and older: cut/paste in textareas via the context menu, and dragging text into textareas
Opera 10 and 11: dragging text into text fields and textareas, and cut via the context menu in text fields and textareas
Opera 9: Same as Opera 10 and 11, plus paste from context menu in text fields and textareas

If you need to guarantee on-the-fly change notifications including these edge cases, you can call the checkChange method on a repeating interval, e.g. using Ext.TaskMgr, or if the field is within a Ext.form.FormPanel, you can use the FormPanel's Ext.form.FormPanel-pollForChanges configuration to set up such a task automatically.

clearCls : String

The CSS class to be applied to the special clearing div rendered directly after the field contents wrapper to provide...

The CSS class to be applied to the special clearing div rendered directly after the field contents wrapper to provide field clearing (defaults to 'x-clear').

cls : String

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for ...

An optional extra CSS class that will be added to this component's Element (defaults to ''). This can be useful for adding customized styles to the component or any of its children using standard CSS rules.

componentCls : String

CSS Class to be added to a components root level element to give distinction to it via styling.

componentLayout : String/Object

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout manager...

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.

Generally, developers will not use this configuration as all provided Components which need their internal elements sizing (Such as input fields) come with their own componentLayout managers.

The default layout manager will be used on instances of the base Ext.Component class which simply sizes the Component's encapsulating element to the height and width specified in the setSize method.

contentEl : String

Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content for this comp...

Optional. Specify an existing HTML element, or the id of an existing HTML element to use as the content for this component.

Description :
This config option is used to take an existing HTML element and place it in the layout element of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.
Notes :
The specified HTML element is appended to the layout element of the component after any configured HTML has been inserted, and so the document will not contain this element at the time the render event is fired.

The specified HTML element used will not participate in any layout scheme that the Component may use. It is just HTML. Layouts operate on child items.

Add either the x-hidden or the x-hide-display CSS class to prevent a brief flicker of the content before it is rendered to the panel.

data : Mixed

The initial set of data to apply to the tpl to update the content area of the Component.

decimalPrecision : Number

The maximum precision to display after the decimal separator (defaults to 2)

decimalSeparator : String

Character(s) to allow as the decimal separator (defaults to '.')

dirtyCls : String

The CSS class to use when the field value is dirty.

disableKeyFilter : Boolean

Specify true to disable input keystroke filtering (defaults to false)

disabled : Boolean

Defaults to false.

disabled : Boolean

True to disable the field (defaults to false). Disabled Fields will not be submitted.

disabledCls : String

CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.

draggable : Mixed

Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle...

Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle.

This may also be specified as a config object for the ComponentDragger which is instantiated to perform dragging.

For example to create a Component which may only be dragged around using a certain internal element as the drag handle, use the delegate option:

new Ext.Component({
    constrain: true,
    floating:true,
    style: {
        backgroundColor: '#fff',
        border: '1px solid black'
    },
    html: '"cursor:move">The title
The content',
    draggable: {
        delegate: 'h1'
    }
}).show();

emptyCls : String

The CSS class to apply to an empty field to style the emptyText (defaults to 'x-form-empty-field'). This class is au...

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.

emptyText : String

The default text to place into an empty field (defaults to undefined). Note that normally this value will be submitte...

The default text to place into an empty field (defaults to undefined).

Note that normally this value will be submitted to the server if this field is enabled; to prevent this you can set the submitEmptyText option of Ext.form.Basic-submit to false.

Also note that if you use inputType:'file', emptyText is not supported and should be avoided.

enableKeyEvents : Boolean

true to enable the proxying of key events for the HTML input field (defaults to false)

enforceMaxLength : Boolean

True to set the maxLength property on the underlying input field. Defaults to false

errorMsgCls : String

The CSS class to be applied to the error message element. Defaults to 'x-form-error-msg'.

fieldBodyCls : String

An extra CSS class to be applied to the body content element in addition to fieldBodyCls. Defaults to empty.

fieldCls : String

The default CSS class for the field input (defaults to 'x-form-field')

fieldLabel : String

The label for the field. It gets appended with the labelSeparator, and its position and sizing is determined by the l...

The label for the field. It gets appended with the labelSeparator, and its position and sizing is determined by the labelAlign, labelWidth, and labelPad configs. Defaults to undefined.

fieldSubTpl : Ext.XTemplate

The template that is used to create the contents of the field. The base implementation creates a HTML input element. ...

The template that is used to create the contents of the field. The base implementation creates a HTML input element. The argument data for this template is created by the getSubTplData method.

floating : Boolean

Specify as true to float the Component outside of the document flow using CSS absolute positioning. Components such a...

Specify as true to float the Component outside of the document flow using CSS absolute positioning.

Components such as Windows and Menus are floating by default.

Floating Components that are programatically rendered will register themselves with the global ZIndexManager

Floating Components as child items of a Container

A floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by examining the ownerCt chain.

When configured as floating, Components acquire, at render time, a ZIndexManager which manages a stack of related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when the Component's toFront method is called.

The ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is floating. This is so that descendant floating Components of floating Containers (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative to any siblings, but always above that floating ancestor Container.

If no floating ancestor is found, a floating Component registers itself with the default ZIndexManager.

Floating components do not participate in the Container's layout. Because of this, they are not rendered until you explicitly show them.

After rendering, the ownerCt reference is deleted, and the floatParent property is set to the found floating ancestor Container. If no floating ancestor Container was found the floatParent property will not be set.

focusCls : String

The CSS class to use when the field receives focus (defaults to 'x-form-focus')

focusOnToFront : Boolean

Specifies whether the floated component should be automatically focused when it is brought to the front. Defaults to ...

Specifies whether the floated component should be automatically focused when it is brought to the front. Defaults to true.

formItemCls : String

A CSS class to be applied to the outermost element to denote that it is participating in the form field layout. Defau...

A CSS class to be applied to the outermost element to denote that it is participating in the form field layout. Defaults to 'x-form-item'.

frame : Boolean

Specify as true to have the Component inject framing elements within the Component at render time to provide a graphi...

Specify as true to have the Component inject framing elements within the Component at render time to provide a graphical rounded frame around the Component content.

This is only necessary when running on outdated, or non standard-compliant browsers such as Microsoft's Internet Explorer prior to version 9 which do not support rounded corners natively.

The extra space taken up by this framing is available from the read only property frameSize.

grow : Boolean

true if this field should automatically grow and shrink to its content (defaults to false)

growAppend : String

A string that will be appended to the field's current value for the purposes of calculating the target field size. On...

A string that will be appended to the field's current value for the purposes of calculating the target field size. Only used when the grow config is true. Defaults to a single capital "W" (the widest character in common fonts) to leave enough space for the next typed character and avoid the field value shifting before the width is adjusted.

growMax : Number

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

growMin : Number

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

height : Number

The height of this component in pixels.

hidden : Boolean

Defaults to false.

hideLabel : Boolean

Set to true to completely hide the label element (label and separator). Defaults to false. By default, even if you do...

Set to true to completely hide the label element (label and separator). Defaults to false.

By default, even if you do not specify a fieldLabel the space will still be reserved so that the field will line up with other fields that do have labels. Setting hideLabel to true will cause the field to not reserve that space.

hideMode : String

A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be<div class="mdet...

A String which specifies how this Component's encapsulating DOM element will be hidden. Values may be

'display' : The Component will be hidden using the display: none style.
'visibility' : The Component will be hidden using the visibility: hidden style.
'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document. This is useful when a hidden Component must maintain measurable dimensions. Hiding using display results in a Component having zero dimensions.

Defaults to 'display'.

html : String/Object

An HTML fragment, or a DomHelper specification to use as the layout element content (defaults to ''). The HTML conten...

An HTML fragment, or a DomHelper specification to use as the layout element content (defaults to ''). The HTML content is added after the component is rendered, so the document will not contain this HTML at the time the render event is fired. This content is inserted into the body before any configured contentEl is appended.

id : String

The unique id of this component instance (defaults to an auto-assigned id). It should not be necessary to use this co...

The unique id of this component instance (defaults to an auto-assigned id).

It should not be necessary to use this configuration except for singleton objects in your application. Components created with an id may be accessed globally using Ext.getCmp.

Instead of using assigned ids, use the itemId config, and ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The Container class contains shortcut methods to query its descendant Components by selector.

Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.

Note: to avoid complications imposed by a unique id also see itemId.

Note: to access the container of a Component see ownerCt.

inputId : String

The id that will be given to the generated input DOM element. Defaults to an automatically generated id. If you confi...

The id that will be given to the generated input DOM element. Defaults to an automatically generated id. If you configure this manually, you must make sure it is unique in the document.

inputType : String

The type attribute for input fields -- e.g. radio, text, password, file (defaults to 'text'). The extended types supp...

The type attribute for input fields -- e.g. radio, text, password, file (defaults to 'text'). The extended types supported by HTML5 inputs (url, email, etc.) may also be used, though using them will cause older browsers to fall back to 'text'.

The types 'file' and 'password' must be used to render those field types currently -- there are no separate Ext components for those.

invalidCls : String

The CSS class to use when marking the component invalid (defaults to 'x-form-invalid')

invalidText : String

The error text to use when marking a field invalid and no message is provided (defaults to 'The value in this field i...

The error text to use when marking a field invalid and no message is provided (defaults to 'The value in this field is invalid')

itemId : String

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. ...

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. Instead of using an id with Ext.getCmp, use itemId with Ext.container.Container.getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal MixedCollection, the itemId is scoped locally to the container -- avoiding potential conflicts with Ext.ComponentMgr which requires a unique id.

var c = new Ext.panel.Panel({ //
    height: 300,
    renderTo: document.body,
    layout: 'auto',
    items: [
        {
            itemId: 'p1',
            title: 'Panel 1',
            height: 150
        },
        {
            itemId: 'p2',
            title: 'Panel 2',
            height: 150
        }
    ]
})
p1 = c.getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling

Also see id, query, down and child.

Note: to access the container of an item see ownerCt.

labelAlign : String

Controls the position and alignment of the fieldLabel. Valid values are: "left" (the default) - The label is positio...

Controls the position and alignment of the fieldLabel. Valid values are:

"left" (the default) - The label is positioned to the left of the field, with its text aligned to the left. Its width is determined by the labelWidth config.
"top" - The label is positioned above the field.
"right" - The label is positioned to the left of the field, with its text aligned to the right. Its width is determined by the labelWidth config.

labelCls : String

The CSS class to be applied to the label element. Defaults to 'x-form-item-label'.

labelPad : Number

The amount of space in pixels between the fieldLabel and the input field. Defaults to 5.

labelSeparator : String

Character(s) to be inserted at the end of the label text.

labelStyle : String

A CSS style specification string to apply directly to this field's label. Defaults to undefined.

labelWidth : Number

The width of the fieldLabel in pixels. Only applicable if the labelAlign is set to "left" or "right". Defaults to 100...

The width of the fieldLabel in pixels. Only applicable if the labelAlign is set to "left" or "right". Defaults to 100.

labelableRenderTpl : Array/String/Ext.XTemplate

The rendering template for the field decorations. Component classes using this mixin should include logic to use this...

The rendering template for the field decorations. Component classes using this mixin should include logic to use this as their renderTpl.

listeners : Object

A config object containing one or more event handlers to be added to this object during initialization. This should ...

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from ExtJs Components

While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's click event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

loader : Ext.ComponentLoader/Object

A configuration object or an instance of a Ext.ComponentLoader to load remote content for this Component.

maintainFlex : Boolean

Only valid when a sibling element of a Splitter within a VBox or HBox layout. Specifies that if an immediate sibling ...

Only valid when a sibling element of a Splitter within a VBox or HBox layout.

Specifies that if an immediate sibling Splitter is moved, the Component on the other side is resized, and this Component maintains its configured flex value.

margin : Number/String

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be ...

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

maxHeight : Number

The maximum value in pixels which this Component will set its height to. Warning: This will override any size managem...

The maximum value in pixels which this Component will set its height to.

Warning: This will override any size management applied by layout managers.

maxLength : Number

Maximum input field length allowed by validation (defaults to Number.MAX_VALUE). This behavior is intended to provide...

Maximum input field length allowed by validation (defaults to Number.MAX_VALUE). This behavior is intended to provide instant feedback to the user by improving usability to allow pasting and editing or overtyping and back tracking. To restrict the maximum number of characters that can be entered into the field use the enforceMaxLength option.

maxLengthText : String

Error text to display if the maximum length validation fails (defaults to 'The maximum length for this field is {maxL...

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

maxText : String

Error text to display if the maximum value validation fails (defaults to 'The maximum value for this field is {maxVal...

Error text to display if the maximum value validation fails (defaults to 'The maximum value for this field is {maxValue}')

maxValue : Number

The maximum allowed value (defaults to Number.MAX_VALUE). Will be used by the field's validation logic, and for enabl...

The maximum allowed value (defaults to Number.MAX_VALUE). Will be used by the field's validation logic, and for enabling/disabling the up spinner button.

maxWidth : Number

The maximum value in pixels which this Component will set its width to. Warning: This will override any size manageme...

The maximum value in pixels which this Component will set its width to.

Warning: This will override any size management applied by layout managers.

minHeight : Number

The minimum value in pixels which this Component will set its height to. Warning: This will override any size managem...

The minimum value in pixels which this Component will set its height to.

Warning: This will override any size management applied by layout managers.

minLength : Number

Minimum input field length required (defaults to 0)

minLengthText : String

Error text to display if the minimum length validation fails (defaults to 'The minimum length for this field is {minL...

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

minText : String

Error text to display if the minimum value validation fails (defaults to 'The minimum value for this field is {minVal...

Error text to display if the minimum value validation fails (defaults to 'The minimum value for this field is {minValue}')

minValue : Number

The minimum allowed value (defaults to Number.NEGATIVE_INFINITY). Will be used by the field's validation logic, and f...

The minimum allowed value (defaults to Number.NEGATIVE_INFINITY). Will be used by the field's validation logic, and for enabling/disabling the down spinner button.

minWidth : Number

The minimum value in pixels which this Component will set its width to. Warning: This will override any size manageme...

The minimum value in pixels which this Component will set its width to.

Warning: This will override any size management applied by layout managers.

msgTarget : String

The location where the error message text should display. Must be one of the following values: <div class="mdetail-pa...

The location where the error message text should display. Must be one of the following values:

qtip Display a quick tip containing the message when the user hovers over the field. This is the default.
Ext.tip.QuickTips.init must have been called for this setting to work.
title Display the message in a default browser title attribute popup.
under Add a block div beneath the field containing the error message.
side Add an error icon to the right of the field, displaying the message in a popup on hover.
none Don't display any error message. This might be useful if you are implementing custom error display.
[element id] Add the error message directly to the innerHTML of the specified element.

name : String

The name of the field (defaults to undefined). This is used as the parameter name when including the field value in a...

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.

name : String

The name of the field (defaults to undefined). By default this is used as the parameter name when including the field...

The name of the field (defaults to undefined). By default this is used as the parameter name when including the field value in a form submit(). To prevent the field from being included in the form submit, set submitValue to false.

nanText : String

Error text to display if the value is not a valid number. For example, this can happen if a valid character like '.'...

Error text to display if the value is not a valid number. For example, this can happen if a valid character like '.' or '-' is left in the field with no number (defaults to '{value} is not a valid number')

negativeText : String

Error text to display if the value is negative and minValue is set to 0. This is used instead of the minText in that ...

Error text to display if the value is negative and minValue is set to 0. This is used instead of the minText in that circumstance only.

overCls : String

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. (defaults to ''). This can be useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.

padding : Number/String

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can b...

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10'.

plugins : Object/Array

An object or array of objects that will provide custom functionality for this component. The only requirement for a ...

An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

preventMark : Boolean

true to disable displaying any error message set on this object. Defaults to false.

readOnly : Boolean

true to mark the field as readOnly in HTML (defaults to false). Note: this only sets the element's readOnly DOM attri...

true to mark the field as readOnly in HTML (defaults to false).

Note: this only sets the element's readOnly DOM attribute. Setting readOnly=true, for example, will not disable triggering a ComboBox or Date; it gives you the option of forcing the user to choose via the trigger without typing in the text box. To hide the trigger use hideTrigger.

regex : RegExp

A JavaScript RegExp object to be tested against the field value during validation (defaults to undefined). If the tes...

A JavaScript RegExp object to be tested against the field value during validation (defaults to undefined). If the test fails, the field will be marked invalid using regexText.

regexText : String

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

renderSelectors : Object

An object containing properties specifying DomQuery selectors which identify child elements created by the render pro...

An object containing properties specifying DomQuery selectors which identify child elements created by the render process.

After the Component's internal structure is rendered according to the renderTpl, this object is iterated through, and the found Elements are added as properties to the Component using the renderSelector property name.

For example, a Component which rendered an image, and description into its element might use the following properties coded into its prototype:

renderTpl: '<img src="{imageUrl}" class="x-image-component-img"><div class="x-image-component-desc">{description}>/div<',

renderSelectors: {
    image: 'img.x-image-component-img',
    descEl: 'div.x-image-component-desc'
}

After rendering, the Component would have a property image referencing its child img Element, and a property descEl referencing the div Element which contains the description.

renderTo : Mixed

Specify the id of the element, a DOM element or an existing Element that this component will be rendered into. Notes ...

Specify the id of the element, a DOM element or an existing Element that this component will be rendered into.

Notes :

See render also.

renderTpl : Mixed

An XTemplate used to create the internal structure inside this Component's encapsulating Element. You do not normally...

An XTemplate used to create the internal structure inside this Component's encapsulating Element.

You do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container, this defaults to null which means that they will be initially rendered with no internal structure; they render their Element empty. The more specialized ExtJS and Touch classes which use a more complex DOM structure, provide their own template definitions.

This is intended to allow the developer to create application-specific utility Components with customized internal structure.

Upon rendering, any created child elements may be automatically imported into object properties using the renderSelectors option.

resizable : Mixed

Specify as true to apply a Resizer to this Component after rendering. May also be specified as a config object to be ...

Specify as true to apply a Resizer to this Component after rendering.

May also be specified as a config object to be passed to the constructor of Resizer to override any defaults. By default the Component passes its minimum and maximum size, and uses Ext.resizer.Resizer-dynamic: false

resizeHandles : String

A valid Ext.resizer.Resizer handles config string (defaults to 'all'). Only applies when resizable = true.

selectOnFocus : Boolean

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

shadow : String/Boolean

Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow,...

Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow-mode. Set to false to disable the shadow. (Defaults to 'sides'.)

step : Number

Specifies a numeric interval by which the field's value will be incremented or decremented when the user invokes the ...

Specifies a numeric interval by which the field's value will be incremented or decremented when the user invokes the spinner. Defaults to 1.

style : String

A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.core.Eleme...

A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.core.Element-applyStyles.

new Ext.panel.Panel({
            title: 'Some Title',
            renderTo: Ext.getBody(),
            width: 400, height: 300,
            layout: 'form',
            items: [{
                xtype: 'textarea',
                style: {
                    width: '95%',
                    marginBottom: '10px'
                }
            },
            new Ext.button.Button({
                text: 'Send',
                minWidth: '100',
                style: {
                    marginBottom: '10px'
                }
            })
            ]
        });

styleHtmlCls : String

The class that is added to the content target when you set styleHtmlContent to true. Defaults to 'x-html'

styleHtmlContent : String

True to automatically style the html inside the content target of this component (body for panels). Defaults to false...

True to automatically style the html inside the content target of this component (body for panels). Defaults to false.

submitValue : Boolean

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

tabIndex : Number

The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyT...

The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).

tpl : Mixed

An Ext.Template, Ext.XTemplate or an array of strings to form an Ext.XTemplate. Used in conjunction with the data and...

An Ext.Template, Ext.XTemplate or an array of strings to form an Ext.XTemplate. Used in conjunction with the data and tplWriteMode configurations.

tplWriteMode : String

The Ext.(X)Template method to use when updating the content area of the Component. Defaults to 'overwrite' (see Ext.X...

The Ext.(X)Template method to use when updating the content area of the Component. Defaults to 'overwrite' (see Ext.XTemplate-overwrite).

ui : String

A set of predefined ui styles for individual components. Most components support 'light' and 'dark'. Extra string add...

A set of predefined ui styles for individual components. Most components support 'light' and 'dark'. Extra string added to the baseCls with an extra '-'.

new Ext.panel.Panel({
          title: 'Some Title',
          baseCls: 'x-component'
          ui: 'green'
      });

The ui configuration in this example would add 'x-component-green' as an additional class.

validateOnChange : Boolean

Specifies whether this field should be validated immediately whenever a change in its value is detected. Defaults to ...

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.

validator : Function

A custom validation function to be called during field validation (getErrors) (defaults to undefined). If specified, ...

A custom validation function to be called during field validation (getErrors) (defaults to undefined). If specified, this function will be called first, allowing the developer to override the default validation process.

This function will be passed the following Parameters:

value: Mixed
The current field value

This function is to Return:

true: Boolean
true if the value is valid
msg: String
An error message if the value is invalid

value : Mixed

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

vtype : String

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

vtypeText : String

A custom error message to display in place of the default message provided for the vtype currently set for this field...

A custom error message to display in place of the default message provided for the vtype currently set for this field (defaults to undefined). Note: only applies if vtype is set, else ignored.

width : Number

The width of this component in pixels.

Defined By

Properties

bodyEl : Ext.core.Element The div Element wrapping the component's contents. Only available after the component has been rendered.

draggable : Boolean

Read-only property indicating whether or not the component can be dragged

errorEl : Ext.core.Element The div Element that will contain the component's error message(s). Note that depending on the configured {@link #msgTarget}, this element may be hidden in favor of some other form of presentation, but will always be present in the DOM for use by assistive technologies.

frameSize : Object

Read-only property indicating the width of any framing elements which were added within the encapsulating element to ...

Read-only property indicating the width of any framing elements which were added within the encapsulating element to provide graphical, rounded borders. See the frame config.

This is an object containing the frame width in pixels for all four sides of the Component containing the following properties:

top The width of the top framing element in pixels.
right The width of the right framing element in pixels.
bottom The width of the bottom framing element in pixels.
left The width of the left framing element in pixels.

inputEl : Ext.core.Element The input Element for this Field. Only available after the field has been rendered.

isFieldLabelable : Boolean Flag denoting that this object is labelable as a field. Always true.

isFormField : Boolean} Flag denoting that this component is a Field. Always true.

labelEl : Ext.core.Element The label Element for this component. Only available after the component has been rendered.

originalValue : Mixed The original value of the field as configured in the {@link #value} configuration, or as loaded by the last form load operation if the form's {@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad} setting is <code>true</code>.

ownerCt : Ext.Container

This Component's owner Container (defaults to undefined, and is set automatically when this Component is added to a C...

This Component's owner Container (defaults to undefined, and is set automatically when this Component is added to a Container). Read-only.

Note: to access items within the Container see itemId.

rendered : Boolean

Read-only property indicating whether or not the component has been rendered.

{Ext.Container} : Object

floatParent Optional. Only present for floating Components which were inserted as descendant items of floating Contai...

floatParent

Optional. Only present for floating Components which were inserted as descendant items of floating Containers.

Floating Components that are programatically rendered will not have a floatParent property.

For floating Components which are child items of a Container, the floatParent will be the floating ancestor Container which is responsible for the base z-index value of all its floating descendants. It provides a ZIndexManager which provides z-indexing services for all its descendant floating Components.

For example, the dropdown BoundList of a ComboBox which is in a Window will have the Window as its floatParent

See floating and zIndexManager

{Ext.ZIndexManager} : Object

zIndexManager Optional. Only present for floating Components after they have been rendered. A reference to the ZIndex...

zIndexManager

Optional. Only present for floating Components after they have been rendered.

A reference to the ZIndexManager which is managing this Component's z-index.

The ZIndexManager maintains a stack of floating Component z-indices, and also provides a single modal mask which is insert just beneath the topmost visible modal floating Component.

Floating Components may be brought to the front or sent to the back of the z-index stack.

This defaults to the global ZIndexManager for floating Components that are programatically rendered.

For floating Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found which is floating, or if not found the global ZIndexManager is used.

See floating and floatParent

Defined By

Methods

new Ext.form.Number( Object config) : Void

Creates a new Number field

Parameters

config : Object
Configuration options

Returns

Void

Ext.util.Observable.capture( Observable o, Function fn, [Object scope]) : Void

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

Parameters

o : Observable
The Observable to capture events from.
fn : Function
The function to call when an event is fired.
scope : Object
(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

Returns

Void

Ext.util.Observable.observe( Function c, Object listeners) : Void

Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

Ext.util.Observable.observe(Ext.data.Connection);
Ext.data.Connection.on('beforerequest', function(con, options) {
    console.log('Ajax request made to ' + options.url);
});

Parameters

c : Function
The class constructor to make observable.
listeners : Object
An object containing a series of listeners to add. See addListener.

Returns

Void

Ext.util.Observable.releaseCapture( Observable o) : Void

Removes all added captures from the Observable.

Removes all added captures from the Observable.

Parameters

o : Observable
The Observable to release

Returns

Void

addCls : Void

Adds a CSS class to the top level element representing this component.

Returns

Void

addEvents( Object|String o, string Optional.) : Void

Adds the specified events to the list of events which this Observable may fire.

Parameters

o : Object|String
Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.
Optional. : string
Event name if multiple event names are being passed as separate parameters. Usage:
```
this.addEvents('storeloaded', 'storecleared');
```

Returns

Void

addListener( String eventName, Function handler, [Object scope], [Object options]) : Void

Appends an event handler to this object.

Parameters

eventName : String
The name of the event to listen for. May also be an object who's property names are event names. See
handler : Function
The method the event invokes.
scope : Object
(optional) The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
options : Object
(optional) An object containing handler configuration. properties. This may contain any of the following properties:
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the 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.
- target : Observable
  Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
- element : String
  This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.
  This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
```
new Ext.panel.Panel({
    title: 'The title',
    listeners: {
        click: this.handlePanelClick,
        element: 'body'
    }
});
```
  When added in this way, the options available are the options applicable to Ext.core.Element-addListener
Combining Options
Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.
```
myPanel.on('hide', this.handleClick, this, {
single: true,
delay: 100
});
```
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 events. For example:
```
myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});
```
.

Returns

Void

addManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope, Object opt) : Void

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed...

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Parameters

item : Observable|Element
The item to which to add a listener/listeners.
ename : Object|String
The event name, or an object containing event name properties.
fn : Function
Optional. If the ename parameter was an event name, this is the handler function.
scope : Object
Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.
opt : Object
Optional. If the ename parameter was an event name, this is the addListener options.

Returns

Void

afterComponentLayout( Ext.Component this, Number adjWidth, Number adjHeight) : Void

Parameters

this : Ext.Component
adjWidth : Number
The box-adjusted width that was set
adjHeight : Number
The box-adjusted height that was set

Returns

Void

alignTo( Mixed element, String position, [Array offsets]) : Component

Aligns this floating Component to the specified element

Parameters

element : Mixed
The element to align to.
position : String
(optional, defaults to "tl-bl?") The position to align to (see Ext.core.Element-alignTo for more details).
offsets : Array
(optional) Offset the positioning by [x, y]

Returns

Component this

animate( Ext.fx.Anim animObj) : Ext.core.Element

Perform custom animation on this element.

Parameters

animObj : Ext.fx.Anim
An Ext.fx Anim object

Returns

Ext.core.Element this

applyFieldDefaults( Object defaults) : Void

Applies a set of default configuration values to this Labelable instance. For each of the properties in the given obj...

Applies a set of default configuration values to this Labelable instance. For each of the properties in the given object, check if this component hasOwnProperty that config; if not then it's inheriting a default value from its prototype and we should apply the default value.

Parameters

defaults : Object
The defaults to apply to the object.

Returns

Void

applyToMarkup( String/HTMLElement el) : Void

Apply this component to existing markup that is valid. With this function, no call to render() is required.

Parameters

el : String/HTMLElement

Returns

Void

areValuesEqual( Mixed value1, Mixed value2) : Boolean

Returns whether two field values are logically equal. Field implementations may override this to provide custom compa...

Returns whether two field values are logically equal. Field implementations may override this to provide custom comparison logic appropriate for the particular field's data type.

Parameters

value1 : Mixed
The first value to compare
value2 : Mixed
The second value to compare

Returns

Boolean True if the values are equal, false if inequal.

autoSize : Void

Automatically grows the field to accomodate the width of the text up to the maximum field width allowed. This only ta...

Automatically grows the field to accomodate the width of the text up to the maximum field width allowed. This only takes effect if grow = true, and fires the autosize event if the width changes.

Returns

Void

batchChanges( fn A) : Void

A utility for grouping a set of modifications which may trigger value changes into a single transaction, to prevent e...

A utility for grouping a set of modifications which may trigger value changes into a single transaction, to prevent excessive firing of change events. This is useful for instance if the field has sub-fields which are being updated as a group; you don't want the container field to check its own changed state for each subfield change.

Parameters

A : fn
function containing the transaction code

Returns

Void

bubble( Function fn, [Object scope], [Array args]) : Ext.Component

Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of...

Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of function call will be the scope provided or the current component. The arguments to the function will be the args provided or the current component. If the function returns false at any point, the bubble is stopped.

Parameters

fn : Function
The function to call
scope : Object
(optional) The scope of the function (defaults to current node)
args : Array
(optional) The args to call the function with (default to passing the current component)

Returns

Ext.Component this

center : Component

Center this Component in its container.

Returns

Component this

checkChange : Void

Checks whether the value of the field has changed since the last time it was checked. If the value has changed, it: ...

Checks whether the value of the field has changed since the last time it was checked. If the value has changed, it:

Fires the change event,
Performs validation if the validateOnChange config is enabled, firing the validationchange event if the validity has changed, and
Checks the dirty state of the field and fires the dirtychange event if it has changed.

Returns

Void

checkDirtyChange : Void

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

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

Returns

Void

clearInvalid : Void

Clear any invalid styles/messages for this field

Returns

Void

clearListeners : Void

Removes all listeners for this object including the managed listeners

Returns

Void

clearManagedListeners : Void

Removes all managed listeners for this object.

Returns

Void

cloneConfig( Object overrides) : Ext.Component

Clone the current component using the original config values passed into this instance by default.

Parameters

overrides : Object
A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates.

Returns

Ext.Component clone The cloned copy of this component

constructor( config undefined) : Void

Construction of a floating Component involves transforming the el into a Layer based around that el.

Parameters

: config

Returns

Void

destroy : Void

Destroys the Component.

Returns

Void

disable( Boolean silent) : Void

Disable the component.

Parameters

silent : Boolean
Passing true, will supress the 'disable' event from being fired.

Returns

Void

doAutoRender : Void

Handles autoRender. Floating Components may have an ownerCt. If they are asking to be constrained, constrain them wit...

Handles autoRender. Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body

Returns

Void

doComponentLayout : Ext.container.Container

This method needs to be called whenever you change something on this component that requires the Component's layout t...

This method needs to be called whenever you change something on this component that requires the Component's layout to be recalculated.

Returns

Ext.container.Container this

doConstrain( Mixed constrainTo) : Void

Moves this floating Component into a constrain region. By default, this Component is constrained to be within the con...

Moves this floating Component into a constrain region.

By default, this Component is constrained to be within the container it was added to, or the element it was rendered to.

An alternative constraint may be passed.

Parameters

constrainTo : Mixed
Optional. The Element or Region into which this Component is to be constrained.

Returns

Void

enable( Boolean silent) : Void

Enable the component

Parameters

silent : Boolean
Passing false will supress the 'enable' event from being fired.

Returns

Void

enableBubble( String/Array events) : Void

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present....

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component-getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.override(Ext.form.Field, {
//  Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.Field.prototype.initComponent, function() {
    this.enableBubble('change');
}),

//  We know that we want Field's events to bubble directly to the FormPanel.
getBubbleTarget : function() {
    if (!this.formPanel) {
        this.formPanel = this.findParentByType('form');
    }
    return this.formPanel;
}
});

var myForm = new Ext.formPanel({
title: 'User Details',
items: [{
    ...
}],
listeners: {
    change: function() {
        // Title goes red if form has been modified.
        myForm.header.setStyle('color', 'red');
    }
}
});

Parameters

events : String/Array
The event name to bubble, or an Array of event names.

Returns

Void

findLayoutController : Void

This method finds the topmost active layout who's processing will eventually determine the size and position of this ...

This method finds the topmost active layout who's processing will eventually determine the size and position of this Component.

This method is useful when dynamically adding Components into Containers, and some processing must take place after the final sizing and positioning of the Component has been performed.

Returns

Void

findParentBy( Function fn) : Ext.container.Container

Find a container above this component at any level by a custom function. If the passed function returns true, the con...

Find a container above this component at any level by a custom function. If the passed function returns true, the container will be returned.

Parameters

fn : Function
The custom function to call with the arguments (container, this component).

Returns

Ext.container.Container The first Container for which the custom function returns true

findParentByType( String/Class xtype) : Ext.container.Container

Find a container above this component at any level by xtype or class See also the up method.

Find a container above this component at any level by xtype or class

Parameters

xtype : String/Class
The xtype string for a component, or the class of the component directly

Returns

Ext.container.Container The first Container which matches the given xtype or class

fireEvent( String eventName, Object... args) : Boolean

Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Obse...

Fires the specified event with the passed parameters (minus the event name).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component-getBubbleTarget) by calling enableBubble.

Parameters

eventName : String
The name of the event to fire.
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.

focus( [Boolean selectText], [Boolean/Number delay]) : Ext.Component

Try to focus this component.

Parameters

selectText : Boolean
(optional) If applicable, true to also select the text in this component
delay : Boolean/Number
(optional) Delay the focus this number of milliseconds (true for 10 milliseconds).

Returns

Ext.Component this

getActiveError : String

Gets the active error message for this component, if any. This does not trigger validation on its own, it merely retu...

Gets the active error message for this component, if any. This does not trigger validation on its own, it merely returns any message that the component may already hold.

Returns

String The active error message on the component; if there is no error, an empty string is returned.

getBox( [Boolean local]) : Object

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

Object box An object in the format {x, y, width, height}

getBubbleTarget : Ext.container.Container

Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.

Returns

Ext.container.Container the Container which owns this Component.

getEl : Void

Retrieves the top level element representing this component.

Returns

Void

getErrors( Mixed value) : Array

Runs all of Number's validations and returns an array of any errors. Note that this first runs Text's validations, so...

Runs all of Number's validations and returns an array of any errors. Note that this first runs Text's validations, so the returned array is an amalgamation of all field errors. The additional validations run test that the value is a number, and that it is within the configured min and max values.

Parameters

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

Returns

Array All validation errors for this field

getErrors( Mixed value) : Array

Runs this field's validators and returns an array of error messages for any validation failures. This is called inter...

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.

getFieldLabel : String

Returns the label for the field. Defaults to simply returning the fieldLabel config. Can be overridden to provide

Returns

String The configured field label, or empty string if not defined

getHeight : Number

Gets the current height of the component's underlying element.

Returns

Number

getId : Void

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Returns

Void

getInputId : Void

Returns the input id for this field. If none was specified via the inputId config, then an id will be automatically g...

Returns the input id for this field. If none was specified via the inputId config, then an id will be automatically generated.

Returns

Void

getInputId : String

Get the input id, if any, for this component. This is used as the "for" attribute on the label element. Implementing ...

Get the input id, if any, for this component. This is used as the "for" attribute on the label element. Implementing subclasses may also use this as e.g. the id for their own input element.

Returns

String The input id

getInsertPosition( String/Number/Element/HTMLElement position) : HTMLElement

This function takes the position argument passed to onRender and returns a DOM element that you can use in the insert...

This function takes the position argument passed to onRender and returns a DOM element that you can use in the insertBefore.

Parameters

position : String/Number/Element/HTMLElement
Index, element id or element you want to put this component before.

Returns

HTMLElement DOM element that you can use in the insertBefore

getLabelableRenderData : Object

Returns

Object The template arguments

getLabelableSelectors : Void

Returns

Void

getLoader : Ext.ComponentLoader

Gets the Ext.ComponentLoader for this Component.

Returns

Ext.ComponentLoader The loader instance, null if it doesn't exist.

getName : String

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

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

Returns

String name The field {@link Ext.form.Field#name name}

getPlugin : Void

Retrieves a plugin by its pluginId which has been bound to this component.

Returns

Void

getPosition( [Boolean local]) : Array

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])

getRawValue : String

Returns the raw String value of the field, without performing any normalization, conversion, or validation. Gets the ...

Returns the raw String value of the field, without performing any normalization, conversion, or validation. Gets the current value of the input element if the field has been rendered, ignoring the value if it is the emptyText. To get a normalized and converted value see getValue.

Returns

String value The raw String value of the field

getSize : Object

Gets the current size of the component's underlying element.

Returns

Object An object containing the element's size {width: (element width), height: (element height)}

getSubTplData : Object

Returns

Object The template data

getSubTplMarkup : String

Returns

String The markup to be inserted

getSubTplMarkup : Void

Returns

Void

getSubmitData : Object

Returns the parameter(s) that would be included in a standard form submit for this field. Typically this will be an o...

Returns the parameter(s) that would be included in a standard form submit for this field. Typically this will be an object with a single name-value pair, the name being this field's name and the value being its current value. More advanced field implementations may return more than one name-value pair.

Note that the values returned from this method are not guaranteed to have been successfully validated.

Returns

Object A mapping of submit parameter names to values; each value should be a string, or an array of strings if that particular name has multiple values. It can also return null if there are no parameters to be be submitted.

getSubmitValue : String

Returns the value that would be included in a standard form submit for this field. This will be combined with the fie...

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

String The value to be submitted, or null.

getValue : Mixed

Returns the current data value of the field. The type of value returned is particular to the type of the particular f...

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.

Returns

Mixed value The field value

getValue : Mixed

Returns the current data value of the field. The type of value returned is particular to the type of the particular f...

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

Returns

Mixed value The field value

getWidth : Number

Gets the current width of the component's underlying element.

Returns

Number

getXType : String

Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ex...

Gets the xtype for this component as registered with Ext.ComponentMgr. For a list of all available xtypes, see the Ext.Component header. Example usage:

var t = new Ext.form.Text();
alert(t.getXType());  // alerts 'textfield'

Returns

String The xtype

getXTypes : String

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext...

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header.

If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.

Example usage:

var t = new Ext.form.Text();
alert(t.getXTypes());  // alerts 'component/field/textfield'

Returns

String The xtype hierarchy string

hasActiveError : Boolean

Tells whether the field currently has an active error message. This does not trigger validation on its own, it merely...

Tells whether the field currently has an active error message. This does not trigger validation on its own, it merely looks for any message that the component may already hold.

Returns

Boolean

hasActiveFx : Mixed

Returns thq current animation if the element has any effects actively running or queued, else returns false.

Returns

Mixed anim if element has active effects, else false

hasListener( String eventName) : Boolean

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

initField : Void

Initializes this Field mixin on the current instance. Components using this mixin should call this method during thei...

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

Returns

Void

initLabelable : Void

Performs initialization of this mixin. Component classes using this mixin should call this method during their own in...

Performs initialization of this mixin. Component classes using this mixin should call this method during their own initialization.

Returns

Void

initValue : Void

Returns

Void

isDirty : Boolean

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

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 originalValue is updated when the values are loaded by Ext.form.Basic.setValues.

Returns

Boolean True if this field has been changed from its original value (and is not disabled), false otherwise.

isDisabled : Boolean

Method to determine whether this Component is currently disabled.

Returns

Boolean the disabled state of this Component.

isDraggable : Boolean

Method to determine whether this Component is draggable.

Returns

Boolean the draggable state of this component.

isDroppable : Boolean

Method to determine whether this Component is droppable.

Returns

Boolean the droppable state of this component.

isFloating : Boolean

Method to determine whether this Component is floating.

Returns

Boolean the floating state of this component.

isHidden : Boolean

Method to determine whether this Component is currently set to hidden.

Returns

Boolean the hidden state of this Component.

isValid : Boolean

Returns whether or not the field value is currently valid by validating the field's current value. The validitychange...

Returns whether or not the field value is currently valid by validating the field's current value. The validitychange event will not be fired; use validate instead if you want the event to fire. Note: disabled fields are always treated as valid.

Implementations are encouraged to ensure that this method does not have side-effects such as triggering error message display.

Returns

Boolean True if the value is valid, else false

isValid : Boolean

Returns whether or not the field value is currently valid by validating the processed raw value of the field. Note: d...

Returns whether or not the field value is currently valid by validating the processed raw value of the field. Note: disabled fields are always treated as valid.

Returns

Boolean True if the value is valid, else false

isVisible( Boolean deep.) : Boolean

Returns true if this component is visible.

Parameters

deep. : Boolean
Optional. Pass true to interrogate the visibility status of all parent Containers to determine whether this Component is truly visible to the user.

Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating dynamically laid out UIs in a hidden Container before showing them.

Returns

Boolean True if this component is visible, false otherwise.

isXType( String xtype, [Boolean shallow]) : Boolean

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from th...

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true).

If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.

For a list of all available xtypes, see the Ext.Component header.

Example usage:

var t = new Ext.form.Text();
var isText = t.isXType('textfield');        // true
var isBoxSubclass = t.isXType('field');       // true, descended from Ext.form.Field
var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.Field instance

Parameters

xtype : String
The xtype to check for this Component
shallow : Boolean
(optional) False to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype.

Returns

Boolean True if this component descends from the specified xtype, false otherwise.

markInvalid( [String msg]) : Void

Display an error message associated with this field, using msgTarget to determine how to display the message and appl...

Display an error message associated with this field, using msgTarget to determine how to display the message and applying invalidCls to the field's UI element.

Note: this method does not cause the Field's validate method to return false if the value does pass validation. So simply marking a Field as invalid will not prevent submission of forms submitted with the Ext.form.action.Submit-clientValidation option set.

invalid.

Parameters

msg : String
(optional) The validation message (defaults to invalidText)

Returns

Void

nextSibling( selector Optional.) : Void

Returns the next sibling of this Component. Optionally selects the next sibling which matches the passed ComponentQue...

Returns the next sibling of this Component.

Optionally selects the next sibling which matches the passed ComponentQuery selector.

May also be refered to as prev()

Parameters

Optional. : selector
A ComponentQuery selector to filter the following items.

Returns

Void

on( String eventName, Function handler, [Object scope], [Object options]) : Void

Appends an event handler to this object (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 (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
options : Object
(optional) An object containing handler configuration.

Returns

Void

previousSibling( selector Optional.) : Void

Returns the previous sibling of this Component. Optionally selects the previous sibling which matches the passed Comp...

Returns the previous sibling of this Component.

Optionally selects the previous sibling which matches the passed ComponentQuery selector.

May also be refered to as prev()

Parameters

Optional. : selector
A ComponentQuery selector to filter the preceding items.

Returns

Void

processRawValue( String value) : String

Performs any necessary manipulation of a raw String value to prepare it for conversion and/or validation. For text fi...

Performs any necessary manipulation of a raw String value to prepare it for conversion and/or validation. For text fields this applies the configured stripCharsRe to the raw value.

Parameters

value : String
The unprocessed string value

Returns

String The processed string value

rawToValue( Mixed rawValue) : Mixed

Converts a raw input field value into a mixed-type value that is suitable for this particular field type. This allows...

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.

relayEvents( Object origin, Array events) : Void

Relays selected events from the specified Observable as if the events were fired by this.

Relays selected events from the specified Observable as if the events were fired by this.

Parameters

origin : Object
The Observable whose events this object is to relay.
events : Array
Array of event names to relay.

Returns

Void

removeCls : Void

Removes a CSS class from the top level element representing this component.

Returns

Void

removeListener( String eventName, Function handler, [Object scope]) : Void

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object
(optional) The scope originally specified for the handler.

Returns

Void

removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope) : Void

Removes listeners that were added by the mon method.

Parameters

item : Observable|Element
The item from which to remove a listener/listeners.
ename : Object|String
The event name, or an object containing event name properties.
fn : Function
Optional. If the ename parameter was an event name, this is the handler function.
scope : Object
Optional. If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Returns

Void

reset : Void

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

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

Returns

Void

reset : Void

Resets the current field value to the originally-loaded value and clears any validation messages. Also adds emptyText...

Resets the current field value to the originally-loaded value and clears any validation messages. Also adds emptyText and emptyCls if the original value was blank.

Returns

Void

resetOriginalValue : Void

Resets the field's originalValue property so it matches the current value. This is called by Ext.form.Basic.setValues...

Resets the field's originalValue property so it matches the current value. This is called by Ext.form.Basic.setValues if the form's trackResetOnLoad property is set to true.

Returns

Void

resumeEvents : Void

Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...

Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

Returns

Void

selectText( [Number start], [Number end]) : Void

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

sequenceFx : Ext.core.Element

Ensures that all effects queued after sequenceFx is called on the element are run in sequence. This is the opposite ...

Ensures that all effects queued after sequenceFx is called on the element are run in sequence. This is the opposite of syncFx.

Returns

Ext.core.Element The Element

setActive( Boolean active) : Void

Makes this the active Component by showing its shadow, or deactivates it by hiding its shadow. This method also fire...

Makes this the active Component by showing its shadow, or deactivates it by hiding its shadow. This method also fires the activate or deactivate event depending on which action occurred. This method is called internally by Ext.ZIndexManager.

Parameters

active : Boolean
True to activate the Component, false to deactivate it (defaults to false)

Returns

Void

setActiveError( String msg) : Void

Sets the active error message to the given string.

Parameters

msg : String
The error message

Returns

Void

setAutoScroll( Boolean scroll) : Ext.Component

Sets the overflow on the content element of the component.

Parameters

scroll : Boolean
True to allow the Component to auto scroll.

Returns

Ext.Component this

setDisabled( Boolean disabled) : Void

Enable or disable the component.

Parameters

disabled : Boolean

Returns

Void

setDocked : Component

Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part of ...

Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part of the dockedItems collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default)

Returns

Component this

setHeight( Number height) : Ext.Component

Sets the height of the component. This method fires the resize event.

Parameters

height : Number
The new height to set. This may be one of:
- A Number specifying the new height in the Element's Ext.core.Element-defaultUnits (by default, pixels).
- A String used to set the CSS height style.
- undefined to leave the height unchanged.

Returns

Ext.Component this

setLoading( Boolean/Object load, Boolean targetEl) : Ext.LoadMask

This method allows you to show or hide a LoadMask on top of this component.

Parameters

load : Boolean/Object
True to show the default LoadMask or a config object that will be passed to the LoadMask constructor. False to hide the current LoadMask.
targetEl : Boolean
True to mask the targetEl of this Component instead of the this.el. For example, setting this to true on a Panel will cause only the body to be masked. (defaults to false)

Returns

Ext.LoadMask The LoadMask instance that has just been shown.

setMaxValue( Number value) : Void

Replaces any existing maxValue with the new value.

Parameters

value : Number
The maximum value

Returns

Void

setMinValue( Number value) : Void

Replaces any existing minValue with the new value.

Parameters

value : Number
The minimum value

Returns

Void

setPagePosition( Number x, Number y, Mixed animate) : Ext.Component

Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the ...

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
animate : Mixed
If passed, the Component is animated into its new position. If this parameter is a number, it is used as the animation duration in milliseconds.

Returns

Ext.Component this

setPosition( Number left, Number top, Mixed animate) : Ext.Component

Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires ...

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
animate : Mixed
If true, the Component is animated into its new position. You may also pass an animation configuration.

Returns

Ext.Component this

setRawValue( Mixed value) : Mixed

Sets the field's raw value directly, bypassing value conversion, change detection, and validation. To set the value w...

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

setReadOnly( Boolean readOnly) : Void

Sets the read only state of this field.

Parameters

readOnly : Boolean
Whether the field should be read only.

Returns

Void

setSize( Mixed width, Mixed height) : Ext.Component

Sets the width and height of this Component. This method fires the resize event. This method can accept either width ...

Sets the width and height of this Component. This method fires the resize event. This method can accept either width and height as separate arguments, or you can pass a size object like {width:10, height:20}.

Parameters

width : Mixed
The new width to set. This may be one of:
- A Number specifying the new width in the Element's Ext.core.Element-defaultUnits (by default, pixels).
- A String used to set the CSS width style.
- A size object in the format {width: widthValue, height: heightValue}.
- undefined to leave the width unchanged.
height : Mixed
The new height to set (not required if a size object is passed as the first arg). This may be one of:
- A Number specifying the new height in the Element's Ext.core.Element-defaultUnits (by default, pixels).
- A String used to set the CSS height style. Animation may not be used.
- undefined to leave the height unchanged.

Returns

Ext.Component this

setValue( Mixed value) : Ext.form.Field

Sets a data value into the field and runs the change detection and validation.

Parameters

value : Mixed
The value to set

Returns

Ext.form.Field this

setValue( Mixed value) : Ext.form.Text

Sets a data value into the field and runs the change detection and validation. Also applies any configured emptyText ...

Sets a data value into the field and runs the change detection and validation. Also applies any configured emptyText for text fields. To set the value directly without these inspections see setRawValue.

Parameters

value : Mixed
The value to set

Returns

Ext.form.Text this

setVisible( Boolean visible) : Ext.Component

Convenience function to hide or show this component by boolean.

Parameters

visible : Boolean
True to show, false to hide

Returns

Ext.Component this

setWidth( Number width) : Ext.Component

Sets the width of the component. This method fires the resize event.

Parameters

width : Number
The new width to setThis may be one of:
- A Number specifying the new width in the Element's Ext.core.Element-defaultUnits (by default, pixels).
- A String used to set the CSS width style.

Returns

Ext.Component this

show( [String/Element animateTarget], [Function callback], [Object scope]) : Component

Shows this Component, rendering it first if Ext.Component-autoRender is true. For a Window, it activates it and bring...

Shows this Component, rendering it first if Ext.Component-autoRender is true.

For a Window, it activates it and brings it to front if hidden.

Parameters

animateTarget : String/Element
(optional) The target element or id from which the Component should animate while opening (defaults to null with no animation)
callback : Function
(optional) A callback function to call after the window is displayed. Only necessary if animation was specified.
scope : Object
(optional) The scope (this reference) in which the callback is executed. Defaults to this Component.

Returns

Component this

stopFx : Ext.core.Element

Stops any running effects and clears the element's internal effects queue if it contains any additional effects that ...

Stops any running effects and clears the element's internal effects queue if it contains any additional effects that haven't started yet.

Returns

Ext.core.Element The Element

suspendEvents( Boolean queueSuspended) : Void

Suspend the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

Returns

Void

syncFx : Ext.core.Element

Ensures that all effects queued after syncFx is called on the element are run concurrently. This is the opposite of ...

Ensures that all effects queued after syncFx is called on the element are run concurrently. This is the opposite of sequenceFx.

Returns

Ext.core.Element The Element

toBack : Component

Sends this Component to the back of (lower z-index than) any other visible windows

Returns

Component this

toFront( [Boolean preventFocus]) : Component

Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManag...

Brings this floating Component to the front of any other visible, floating Components managed by the same ZIndexManager

If this Component is modal, inserts the modal mask just below this Component in the z-index stack.

Parameters

preventFocus : Boolean
(optional) Specify true to prevent the Component from being focused.

Returns

Component this

un( String eventName, Function handler, [Object scope]) : Void

Removes an event handler (shorthand for removeListener.)

Parameters

eventName : String
The type of event the handler was associated with.
handler : Function
The handler to remove. This must be a reference to the function passed into the addListener call.
scope : Object
(optional) The scope originally specified for the handler.

Returns

Void

unsetActiveError : Void

Clears the active error.

Returns

Void

up( String selector) : Ext.container.Container

Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector. Example:var own...

Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector.

Example:

var owningTabContainer = grid.up('tabcontainer');

Parameters

selector : String
Optional. The simple selector to test.

Returns

Ext.container.Container The matching ancestor Container (or undefined if no match was found).

update( Mixed htmlOrData, [Boolean loadScripts], [Function callback]) : Void

Update the content area of a component.

Parameters

htmlOrData : Mixed
If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.core.Element update
loadScripts : Boolean
(optional) Only legitimate when using the html configuration. Defaults to false
callback : Function
(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading

Returns

Void

updateBox( Object box) : Ext.Component

Sets the current box measurements of the component's underlying element.

Parameters

box : Object
An object in the format {x, y, width, height}

Returns

Ext.Component this

validate : Boolean

Returns whether or not the field value is currently valid by validating the field's current value, and fires the vali...

Returns whether or not the field value is currently valid by validating the field's current value, and fires the validitychange event if the field's validity has changed since the last validation. Note: disabled fields are always treated as valid.

Custom implementations of this method are allowed to have side-effects such as triggering error message display. To validate without side-effects, use isValid.

Returns

Boolean True if the value is valid, else false

validateValue( Mixed value) : Boolean

Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called with the first ...

Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called with the first and false is returned, otherwise true is returned.

Previously, subclasses were invited to provide an implementation of this to process validations - from 3.2 onwards getErrors should be overridden instead.

Parameters

value : Mixed
The value to validate

Returns

Boolean True if all validations passed, false if one or more failed

valueToRaw( Mixed value) : Mixed

Converts a mixed-type value to a raw representation suitable for displaying in the field. This allows controlling how...

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.

Defined By

Events

activate( Ext.Component this)

Fires after a Component has been visually activated.

Parameters

this : Ext.Component

added( Ext.Component this, Ext.container.Container container, Number pos)

Fires after a Component had been added to a Container.

Parameters

this : Ext.Component
container : Ext.container.Container
Parent Container
pos : Number
position of Component

afterrender( Ext.Component this)

Fires after the component rendering is finished. The afterrender event is fired after this Component has been rendere...

Fires after the component rendering is finished.

The afterrender event is fired after this Component has been rendered, been postprocesed by any afterRender method defined for the Component, and, if stateful, after state has been restored.

Parameters

this : Ext.Component

autosize( Ext.form.Text this, Number width)

Fires when the autoSize function is triggered and the field is resized according to the grow/growMin/growMax configs ...

Fires when the autoSize function is triggered and the field is resized according to the grow/growMin/growMax configs as a result. This event provides a hook for the developer to apply additional logic at runtime to resize the field if needed.

Parameters

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

beforeactivate( Ext.Component this)

Fires before a Component has been visually activated. Returning false from an event listener can prevent the activate...

Fires before a Component has been visually activated. Returning false from an event listener can prevent the activate from occurring.

Parameters

this : Ext.Component

beforedeactivate( Ext.Component this)

Fires before a Component has been visually deactivated. Returning false from an event listener can prevent the deacti...

Fires before a Component has been visually deactivated. Returning false from an event listener can prevent the deactivate from occurring.

Parameters

this : Ext.Component

beforedestroy( Ext.Component this)

Fires before the component is destroyed. Return false from an event handler to stop the destroy.

Parameters

this : Ext.Component

beforehide( Ext.Component this)

Fires before the component is hidden when calling the hide method. Return false from an event handler to stop the hid...

Fires before the component is hidden when calling the hide method. Return false from an event handler to stop the hide.

Parameters

this : Ext.Component

beforerender( Ext.Component this)

Fires before the component is rendered. Return false from an event handler to stop the render.

Parameters

this : Ext.Component

beforeshow( Ext.Component this)

Fires before the component is shown when calling the show method. Return false from an event handler to stop the show...

Fires before the component is shown when calling the show method. Return false from an event handler to stop the show.

Parameters

this : Ext.Component

blur( Ext.form.BaseField this)

Fires when this field loses input focus.

Parameters

this : Ext.form.BaseField

change( Ext.form.Field this, Mixed newValue, Mixed oldValue)

Fires when a user-initiated change is detected in the value of the field.

Parameters

this : Ext.form.Field
newValue : Mixed
The new value
oldValue : Mixed
The original value

deactivate( Ext.Component this)

Fires after a Component has been visually deactivated.

Parameters

this : Ext.Component

destroy( Ext.Component this)

Fires after the component is destroyed.

Parameters

this : Ext.Component

dirtychange( Ext.form.Field this, Boolean isDirty)

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

disable( Ext.Component this)

Fires after the component is disabled.

Parameters

this : Ext.Component

enable( Ext.Component this)

Fires after the component is enabled.

Parameters

this : Ext.Component

errorchange( Ext.form.Labelable this, String error)

Fires when the active error message is changed via setActiveError.

Parameters

this : Ext.form.Labelable
error : String
The active error message

focus( Ext.form.BaseField this)

Fires when this field receives input focus.

Parameters

this : Ext.form.BaseField

hide( Ext.Component this)

Fires after the component is hidden. Fires after the component is hidden when calling the hide method.

Parameters

this : Ext.Component

keydown( Ext.form.Text this, Ext.EventObject e)

Keydown input field event. This event only fires if enableKeyEvents is set to true.

Keydown input field event. This event only fires if enableKeyEvents is set to true.

Parameters

this : Ext.form.Text
This text field
e : Ext.EventObject

keypress( Ext.form.Text this, Ext.EventObject e)

Keypress input field event. This event only fires if enableKeyEvents is set to true.

Keypress input field event. This event only fires if enableKeyEvents is set to true.

Parameters

this : Ext.form.Text
This text field
e : Ext.EventObject

keyup( Ext.form.Text this, Ext.EventObject e)

Keyup input field event. This event only fires if enableKeyEvents is set to true.

Keyup input field event. This event only fires if enableKeyEvents is set to true.

Parameters

this : Ext.form.Text
This text field
e : Ext.EventObject

move( Ext.Component this, Number x, Number y)

Fires after the component is moved.

Parameters

this : Ext.Component
x : Number
The new x position
y : Number
The new y position

removed( Ext.Component this, Ext.container.Container ownerCt)

Fires when a component is removed from an Ext.container.Container

Parameters

this : Ext.Component
ownerCt : Ext.container.Container
Container which holds the component

render( Ext.Component this)

Fires after the component markup is rendered.

Parameters

this : Ext.Component

resize( Ext.Component this, Number adjWidth, Number adjHeight)

Fires after the component is resized.

Parameters

this : Ext.Component
adjWidth : Number
The box-adjusted width that was set
adjHeight : Number
The box-adjusted height that was set

show( Ext.Component this)

Fires after the component is shown when calling the show method.

Parameters

this : Ext.Component

specialkey( Ext.form.BaseField this, Ext.EventObject e)

Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. To handle other keys see Ext.pan...

Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. To handle other keys see Ext.panel.Panel-keys or Ext.util.KeyMap. You can check Ext.EventObject-getKey to determine which key was pressed. For example:

var form = new Ext.form.FormPanel({
    ...
    items: [{
            fieldLabel: 'Field 1',
            name: 'field1',
            allowBlank: false
        },{
            fieldLabel: 'Field 2',
            name: 'field2',
            listeners: {
                specialkey: function(field, e){
                    // e.HOME, e.END, e.PAGE_UP, e.PAGE_DOWN,
                    // e.TAB, e.ESC, arrow keys: e.LEFT, e.RIGHT, e.UP, e.DOWN
                    if (e.getKey() == e.ENTER) {
                        var form = field.up('form').getForm();
                        form.submit();
                    }
                }
            }
        }
    ],
    ...
});

Parameters

this : Ext.form.BaseField
e : Ext.EventObject
The event object