Ext JS 4.2.0 Sencha Docs

Ext.form.field.Checkbox

Alternate names

Ext.form.Checkbox

Hierarchy

Inherited mixins

Requires

Subclasses

Files

Single checkbox field. Can be used as a direct replacement for traditional checkbox fields. Also serves as a parent class for radio buttons.

Labeling

In addition to the standard field labeling options, checkboxes may be given an optional boxLabel which will be displayed immediately after checkbox. Also see Ext.form.CheckboxGroup for a convenient method of grouping related checkboxes.

Values

The main value of a checkbox is a boolean, indicating whether or not the checkbox is checked. The following values will check the checkbox:

  • true
  • 'true'
  • '1'
  • 'on'

Any other value will uncheck the checkbox.

In addition to the main boolean value, you may also specify a separate inputValue. This will be sent as the parameter value when the form is submitted. You will want to set this value if you have multiple checkboxes with the same name. If not specified, the value on will be used.

Example usage

Ext.create('Ext.form.Panel', {
    bodyPadding: 10,
    width: 300,
    title: 'Pizza Order',
    items: [
        {
            xtype: 'fieldcontainer',
            fieldLabel: 'Toppings',
            defaultType: 'checkboxfield',
            items: [
                {
                    boxLabel  : 'Anchovies',
                    name      : 'topping',
                    inputValue: '1',
                    id        : 'checkbox1'
                }, {
                    boxLabel  : 'Artichoke Hearts',
                    name      : 'topping',
                    inputValue: '2',
                    checked   : true,
                    id        : 'checkbox2'
                }, {
                    boxLabel  : 'Bacon',
                    name      : 'topping',
                    inputValue: '3',
                    id        : 'checkbox3'
                }
            ]
        }
    ],
    bbar: [
        {
            text: 'Select Bacon',
            handler: function() {
                Ext.getCmp('checkbox3').setValue(true);
            }
        },
        '-',
        {
            text: 'Select All',
            handler: function() {
                Ext.getCmp('checkbox1').setValue(true);
                Ext.getCmp('checkbox2').setValue(true);
                Ext.getCmp('checkbox3').setValue(true);
            }
        },
        {
            text: 'Deselect All',
            handler: function() {
                Ext.getCmp('checkbox1').setValue(false);
                Ext.getCmp('checkbox2').setValue(false);
                Ext.getCmp('checkbox3').setValue(false);
            }
        }
    ],
    renderTo: Ext.getBody()
});

Available since: 1.1.0

Defined By

Config options

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

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

Available since: 4.0.0

The template used to format the Array of error messages passed to setActiveErrors into a single HTML string. ...

The template used to format the Array of error messages passed to setActiveErrors into a single HTML string. if the msgTarget is title, it defaults to a list separated by new lines. Otherwise, it renders each message as an item in an unordered list.

Available since: 4.0.0

An optional string or XTemplate configuration to insert in the field markup at the end of the input containing element. ...

An optional string or XTemplate configuration to insert in the field markup at the end of the input containing element. If an XTemplate is used, the component's render data serves as the context.

Available since: 4.1.1

An optional string or XTemplate configuration to insert in the field markup after the box label text. ...

An optional string or XTemplate configuration to insert in the field markup after the box label text. If an XTemplate is used, the component's subTpl data serves as the context.

Available since: 4.1.0

An optional string or XTemplate configuration to insert in the field markup after the box label element. ...

An optional string or XTemplate configuration to insert in the field markup after the box label element. If an XTemplate is used, the component's subTpl data serves as the context.

Available since: 4.1.0

An optional string or XTemplate configuration to insert in the field markup after the label text. ...

An optional string or XTemplate configuration to insert in the field markup after the label text. If an XTemplate is used, the component's render data serves as the context.

Available since: 4.1.0

An optional string or XTemplate configuration to insert in the field markup after the label element. ...

An optional string or XTemplate configuration to insert in the field markup after the label element. If an XTemplate is used, the component's render data serves as the context.

Available since: 4.1.0

An optional string or XTemplate configuration to insert in the field markup after the subTpl markup. ...

An optional string or XTemplate configuration to insert in the field markup after the subTpl markup. If an XTemplate is used, the component's render data serves as the context.

Available since: 4.1.0

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

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'
    }
}

Available since: 2.3.0

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

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

Defaults to: true

Available since: 4.0.0

An alias for loader config which also allows to specify just a string which will be used as the url that's automatica...

An alias for loader config which also allows to specify just a string which will be used as the url that's automatically loaded:

Ext.create('Ext.Component', {
    autoLoad: 'content.html',
    renderTo: Ext.getBody()
});

The above is the same as:

Ext.create('Ext.Component', {
    loader: {
        url: 'content.html',
        autoLoad: true
    },
    renderTo: Ext.getBody()
});

Don't use it together with loader config.

Available since: 4.1.1

This cfg has been deprecated since 4.1.1

Use loader config instead.

This config is intended mainly for non-floating Components which may or may not be shown. ...

This config is intended mainly for non-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. If floating is true, the value of this config is omitted as if it is true.

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.

Defaults to: false

Available since: 4.0.0

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. This should not be combined with overflowX or overflowY.

Defaults to: false

Available since: 4.0.0

true to automatically show the component upon creation. ...

true to automatically show the component upon creation. This config option may only be used for floating components or components that use autoRender.

Defaults to: false

Available since: 2.3.0

The CSS class to be applied to the body content element. ...

The CSS class to be applied to the body content element.

Defaults to: Ext.baseCSSPrefix + 'form-item-body'

Available since: 4.0.0

The base CSS class to apply to this component's element. ...

The base CSS class to apply to this component'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.

Defaults to: Ext.baseCSSPrefix + 'field'

Available since: 4.0.0

Overrides: Ext.AbstractComponent.baseCls

An optional string or XTemplate configuration to insert in the field markup at the beginning of the input containing ...

An optional string or XTemplate configuration to insert in the field markup at the beginning of the input containing element. If an XTemplate is used, the component's render data serves as the context.

Available since: 4.1.1

An optional string or XTemplate configuration to insert in the field markup before the box label text. ...

An optional string or XTemplate configuration to insert in the field markup before the box label text. If an XTemplate is used, the component's subTpl data serves as the context.

Available since: 4.1.0

An optional string or XTemplate configuration to insert in the field markup before the box label element. ...

An optional string or XTemplate configuration to insert in the field markup before the box label element. If an XTemplate is used, the component's subTpl data serves as the context.

Available since: 4.1.0

An optional string or XTemplate configuration to insert in the field markup before the label text. ...

An optional string or XTemplate configuration to insert in the field markup before the label text. If an XTemplate is used, the component's render data serves as the context.

Available since: 4.1.0

An optional string or XTemplate configuration to insert in the field markup before the label element. ...

An optional string or XTemplate configuration to insert in the field markup before the label element. If an XTemplate is used, the component's render data serves as the context.

Available since: 4.1.0

An optional string or XTemplate configuration to insert in the field markup before the subTpl markup. ...

An optional string or XTemplate configuration to insert in the field markup before the subTpl markup. If an XTemplate is used, the component's render data serves as the context.

Available since: 4.1.0

Specifies the border size for this component. ...

Specifies the border size 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' (top, right, bottom, left).

For components that have no border by default, setting this won't make the border appear by itself. You also need to specify border color and style:

border: 5,
style: {
    borderColor: 'red',
    borderStyle: 'solid'
}

To turn off the border, use border: false.

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: String
An optional text label that will appear next to the checkbox. ...

An optional text label that will appear next to the checkbox. Whether it appears before or after the checkbox is determined by the boxLabelAlign config.

Available since: 1.1.0

Ext.form.field.Checkbox
view source
: String
The position relative to the checkbox where the boxLabel should appear. ...

The position relative to the checkbox where the boxLabel should appear. Recognized values are 'before' and 'after'.

Defaults to: 'after'

Available since: 4.0.0

An optional string or XTemplate configuration to insert in the field markup inside the box label element (as attribut...

An optional string or XTemplate configuration to insert in the field markup inside the box label element (as attributes). If an XTemplate is used, the component's subTpl data serves as the context.

Available since: 4.1.0

Ext.form.field.Checkbox
view source
: String
The CSS class to be applied to the boxLabel element ...

The CSS class to be applied to the boxLabel element

Defaults to: 'x-form-cb-label'

Available since: 4.0.0

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

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

Defaults to: 50

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: String[]
private overrides ...

private overrides

Defaults to: []

Available since: 4.0.0

Overrides: Ext.form.field.Base.checkChangeEvents

Ext.form.field.Checkbox
view source
: Boolean
true if the checkbox should render initially checked ...

true if the checkbox should render initially checked

Defaults to: false

Available since: 1.1.0

Ext.form.field.Checkbox
view source
: String
The CSS class(es) added to the component's main element when it is in the checked state. ...

The CSS class(es) added to the component's main element when it is in the checked state. You can add your own class (checkedCls='myClass x-form-cb-checked') or replace the default class altogether (checkedCls='myClass').

Defaults to: 'x-form-cb-checked'

Available since: 2.3.0

An array describing the child elements of the Component. ...

An array describing the child elements of the Component. Each member of the array is an object with these properties:

  • name - The property name on the Component for the child element.
  • itemId - The id to combine with the Component's id that is the id of the child element.
  • id - The id of the child element.

If the array member is a string, it is equivalent to { name: m, itemId: m }.

For example, a Component which renders a title and body text:

Ext.create('Ext.Component', {
    renderTo: Ext.getBody(),
    renderTpl: [
        '<h1 id="{id}-title">{title}</h1>',
        '<p>{msg}</p>',
    ],
    renderData: {
        title: "Error",
        msg: "Something went wrong"
    },
    childEls: ["title"],
    listeners: {
        afterrender: function(cmp){
            // After rendering the component will have a title property
            cmp.title.setStyle({color: "red"});
        }
    }
});

A more flexible, but somewhat slower, approach is renderSelectors.

Available since: 4.0.5

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: Ext.baseCSSPrefix + 'clear'

Available since: 4.0.0

An optional extra CSS class that will be added to this component's Element. ...

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

Defaults to: ''

Available since: 1.1.0

Defines the column width inside column layout. ...

Defines the column width inside column layout.

Can be specified as a number or as a percentage.

Available since: 4.1.1

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

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

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: 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.

Defaults to: 'field'

Available since: 4.0.0

Overrides: Ext.AbstractComponent.componentLayout, Ext.form.field.Base.componentLayout

True to constrain this Components within its containing element, false to allow it to fall outside of its containing ...

True to constrain this Components within its containing element, false to allow it to fall outside of its containing element. By default this Component will be rendered to document.body. To render and constrain this Component within another element specify renderTo.

Defaults to: false

Available since: Ext JS 4.2.0

A Region (or an element from which a Region measurement will be read) which is used to constrain the component. ...

A Region (or an element from which a Region measurement will be read) which is used to constrain the component. Only applies when the component is floating.

Available since: 4.1.2

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

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

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.

Available since: 3.4.0

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

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

Available since: 3.4.0

The default Ext.Element#getAlignToXY anchor position value for this menu relative to its element of origin. ...

The default Ext.Element#getAlignToXY anchor position value for this menu relative to its element of origin. Used in conjunction with showBy.

Defaults to: "tl-bl?"

Available since: 4.1.3

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

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

Defaults to: Ext.baseCSSPrefix + 'form-dirty'

Available since: 4.0.0

True to disable the field. ...

True to disable the field. Disabled Fields will not be submitted.

Defaults to: false

Available since: 4.0.0

Overrides: Ext.AbstractComponent.disabled

CSS class to add when the Component is disabled. ...

CSS class to add when the Component is disabled.

Defaults to: 'x-item-disabled'

Available since: 4.0.0

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: '<h1 style="cursor:move">The title</h1><p>The content</p>',
    draggable: {
        delegate: 'h1'
    }
}).show();

Defaults to: false

Available since: 4.0.0

Overrides: Ext.AbstractComponent.draggable

The CSS class to be applied to the error message element. ...

The CSS class to be applied to the error message element.

Defaults to: Ext.baseCSSPrefix + 'form-error-msg'

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: String
An extra CSS class to be applied to the body content element in addition to fieldBodyCls. ...

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

Defaults to: 'x-form-cb-wrap'

Available since: 4.0.0

Overrides: Ext.form.Labelable.fieldBodyCls

Ext.form.field.Checkbox
view source
: String
The default CSS class for the checkbox ...

The default CSS class for the checkbox

Defaults to: 'x-form-field'

Available since: 4.0.0

Overrides: Ext.form.field.Base.fieldCls

The label for the field. ...

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.

Available since: 4.0.0

Optional CSS style(s) to be applied to the field input element. ...

Optional CSS style(s) to be applied to the field input element. Should be a valid argument to Ext.Element.applyStyles. Defaults to undefined. See also the setFieldStyle method for changing the style after initialization.

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: Ext.XTemplateprivate
note: {id} here is really {inputId}, but {cmpId} is available ...

note: {id} here is really {inputId}, but {cmpId} is available

Defaults to: ['<tpl if="boxLabel && boxLabelAlign == \'before\'">', '{beforeBoxLabelTpl}', '<label id="{cmpId}-boxLabelEl" {boxLabelAttrTpl} class="{boxLabelCls} {boxLabelCls}-{boxLabelAlign}" for="{id}">', '{beforeBoxLabelTextTpl}', '{boxLabel}', '{afterBoxLabelTextTpl}', '</label>', '{afterBoxLabelTpl}', '</tpl>', '<input type="button" id="{id}" {inputAttrTpl}', '<tpl if="tabIdx"> tabIndex="{tabIdx}"</tpl>', '<tpl if="disabled"> disabled="disabled"</tpl>', '<tpl if="fieldStyle"> style="{fieldStyle}"</tpl>', ' class="{fieldCls} {typeCls} {inputCls}" autocomplete="off" hidefocus="true" />', '<tpl if="boxLabel && boxLabelAlign == \'after\'">', '{beforeBoxLabelTpl}', '<label id="{cmpId}-boxLabelEl" {boxLabelAttrTpl} class="{boxLabelCls} {boxLabelCls}-{boxLabelAlign}" for="{id}">', '{beforeBoxLabelTextTpl}', '{boxLabel}', '{afterBoxLabelTextTpl}', '</label>', '{afterBoxLabelTpl}', '</tpl>', {disableFormats: true, compiled: true}]

Available since: 4.0.4

Overrides: Ext.form.field.Base.fieldSubTpl

Configure as true to have this Component fixed at its X, Y coordinates in the browser viewport, immune to scrolling t...

Configure as true to have this Component fixed at its X, Y coordinates in the browser viewport, immune to scrolling the document.

Only in browsers that support position:fixed

IE6 and IE7, 8 and 9 quirks do not support position: fixed

Defaults to: false

Available since: Ext JS 4.2.0

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

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.

Defaults to: false

Available since: 4.0.0

Overrides: Ext.AbstractComponent.floating, Ext.Component.floating

Ext.form.field.Checkbox
view source
: String
The CSS class to use when the checkbox receives focus ...

The CSS class to use when the checkbox receives focus

Defaults to: 'x-form-checkbox-focus'

Available since: 2.3.0

Overrides: Ext.form.field.Base.focusCls

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

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

Defaults to: true

Available since: 4.0.0

When inside FormPanel, any component configured with formBind: true will be enabled/disabled depending on the validit...

When inside FormPanel, any component configured with formBind: true will be enabled/disabled depending on the validity state of the form. See Ext.form.Panel for more information and example.

Defaults to: false

Available since: 4.1.1

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

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

Defaults to: Ext.baseCSSPrefix + 'form-item'

Available since: 4.0.0

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.

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: Function
A function called when the checked value changes (can be used instead of handling the change event). ...

A function called when the checked value changes (can be used instead of handling the change event).

Available since: 2.3.0

Parameters

The height of this component in pixels.

The height of this component in pixels.

Available since: 4.0.0

true to hide the component. ...

true to hide the component.

Defaults to: false

Available since: 2.3.0

When set to true, the label element (fieldLabel and labelSeparator) will be automatically hidden if the fieldLabel is...

When set to true, the label element (fieldLabel and labelSeparator) will be automatically hidden if the fieldLabel is empty. Setting this to false will cause the empty label element to be rendered and space to be reserved for it; this is useful if you want a field without a label to line up with other labeled fields in the same form.

If you wish to unconditionall hide the label even if a non-empty fieldLabel is configured, then set the hideLabel config to true.

Defaults to: true

Available since: 4.0.0

Set to true to completely hide the label element (fieldLabel and labelSeparator). ...

Set to true to completely hide the label element (fieldLabel and labelSeparator). Also see hideEmptyLabel, which controls whether space will be reserved for an empty fieldLabel.

Defaults to: false

Available since: 4.0.0

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

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'

Available since: 1.1.0

An HTML fragment, or a DomHelper specification to use as the layout element content. ...

An HTML fragment, or a DomHelper specification to use as the layout element content. 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.

Defaults to: ''

Available since: 3.4.0

The unique id of this component instance. ...

The unique id of this component instance.

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.

Defaults to an auto-assigned id.

Available since: 1.1.0

An optional string or XTemplate configuration to insert in the field markup inside the input element (as attributes). ...

An optional string or XTemplate configuration to insert in the field markup inside the input element (as attributes). If an XTemplate is used, the component's subTpl data serves as the context.

Available since: 4.1.0

The id that will be given to the generated input DOM element. ...

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.

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: String
The type attribute for input fields -- e.g. ...

The type attribute for input fields -- e.g. radio, text, password, file. 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 type 'password' must be used to render that field type currently -- there is no separate Ext component for that. You can use Ext.form.field.File which creates a custom-rendered file upload field, but if you want a plain unstyled file input you can use a Base with inputType:'file'.

Defaults to: 'checkbox'

Available since: 1.1.0

Overrides: Ext.form.field.Base.inputType, Ext.form.field.Checkbox.inputType

Ext.form.field.Checkbox
view source
: String
The value that should go into the generated input element's value attribute and should be used as the parameter value...

The value that should go into the generated input element's value attribute and should be used as the parameter value when submitting as part of a form.

Defaults to: 'on'

Available since: 1.1.0

The CSS class to use when marking the component invalid. ...

The CSS class to use when marking the component invalid.

Defaults to: Ext.baseCSSPrefix + 'form-invalid'

Available since: 4.0.0

The error text to use when marking a field invalid and no message is provided ...

The error text to use when marking a field invalid and no message is provided

Defaults to: 'The value in this field is invalid'

Available since: 1.1.0

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.ComponentManager 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, Ext.container.Container.query, Ext.container.Container.down and Ext.container.Container.child.

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

Available since: 3.4.0

Controls the position and alignment of the fieldLabel. ...

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.

Defaults to: 'left'

Available since: 4.0.0

An optional string or XTemplate configuration to insert in the field markup inside the label element (as attributes). ...

An optional string or XTemplate configuration to insert in the field markup inside the label element (as attributes). If an XTemplate is used, the component's render data serves as the context.

Available since: 4.1.0

The CSS class to be applied to the label element. ...

The CSS class to be applied to the label element. This (single) CSS class is used to formulate the renderSelector and drives the field layout where it is concatenated with a hyphen ('-') and labelAlign. To add additional classes, use labelClsExtra.

Defaults to: Ext.baseCSSPrefix + 'form-item-label'

Available since: 4.0.0

An optional string of one or more additional CSS classes to add to the label element. ...

An optional string of one or more additional CSS classes to add to the label element. Defaults to empty.

Available since: 4.0.4

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

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

Defaults to: 5

Available since: 4.0.0

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

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

Set to empty string to hide the separator completely.

Defaults to: ':'

Available since: 4.0.0

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

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

Available since: 4.0.0

The width of the fieldLabel in pixels. ...

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

Defaults to: 100

Available since: 4.0.0

The rendering template for the field decorations. ...

The rendering template for the field decorations. Component classes using this mixin should include logic to use this as their renderTpl, and implement the getSubTplMarkup method to generate the field body content.

The structure of a field is a table as follows:

If labelAlign: 'left',msgTarget: 'side'`

 +----------------------+----------------------+-------------+
 | Label:               | InputField           | sideErrorEl |
 +----------------------+----------------------+-------------+

If labelAlign: 'left',msgTarget: 'under'`

 +----------------------+------------------------------------+
 | Label:               | InputField      (colspan=2)        |
 |                      | underErrorEl                       |
 +----------------------+------------------------------------+

If labelAlign: 'top',msgTarget: 'side'`

 +---------------------------------------------+-------------+
 | label                                       |             |
 | InputField                                  | sideErrorEl |
 +---------------------------------------------+-------------+

If labelAlign: 'top',msgTarget: 'under'`

 +-----------------------------------------------------------+
 | label                                                     |
 | InputField                      (colspan=2)               |
 | underErrorEl                                              |
 +-----------------------------------------------------------+

The total columns always the same for fields with each setting of labelAlign because when rendered into a Ext.layout.container.Form layout, just the TR of the table will be placed into the form's main TABLE, and the columns of all the siblings must match so that they all line up. In a Ext.layout.container.Form layout, different settings of labelAlign are not supported because of the incompatible column structure.

When the triggerCell or side error cell are hidden or shown, the input cell's colspan is recalculated to maintain the correct 3 visible column count.

Defaults to: ['<tr id="{id}-inputRow" <tpl if="inFormLayout">id="{id}"</tpl>>', '<tpl if="labelOnLeft">', '<td id="{id}-labelCell" style="{labelCellStyle}" {labelCellAttrs}>', '{beforeLabelTpl}', '<label id="{id}-labelEl" {labelAttrTpl}<tpl if="inputId"> for="{inputId}"</tpl> class="{labelCls}"', '<tpl if="labelStyle"> style="{labelStyle}"</tpl>', ' unselectable="on"', '>', '{beforeLabelTextTpl}', '<tpl if="fieldLabel">{fieldLabel}{labelSeparator}</tpl>', '{afterLabelTextTpl}', '</label>', '{afterLabelTpl}', '</td>', '</tpl>', '<td class="{baseBodyCls} {fieldBodyCls}" id="{id}-bodyEl" colspan="{bodyColspan}" role="presentation">', '{beforeBodyEl}', '<tpl if="labelAlign==\'top\'">', '{beforeLabelTpl}', '<div id="{id}-labelCell" style="{labelCellStyle}">', '<label id="{id}-labelEl" {labelAttrTpl}<tpl if="inputId"> for="{inputId}"</tpl> class="{labelCls}"', '<tpl if="labelStyle"> style="{labelStyle}"</tpl>', ' unselectable="on"', '>', '{beforeLabelTextTpl}', '<tpl if="fieldLabel">{fieldLabel}{labelSeparator}</tpl>', '{afterLabelTextTpl}', '</label>', '</div>', '{afterLabelTpl}', '</tpl>', '{beforeSubTpl}', '{[values.$comp.getSubTplMarkup(values)]}', '{afterSubTpl}', '<tpl if="msgTarget===\'side\'">', '{afterBodyEl}', '</td>', '<td id="{id}-sideErrorCell" vAlign="{[values.labelAlign===\'top\' && !values.hideLabel ? \'bottom\' : \'middle\']}" style="{[values.autoFitErrors ? \'display:none\' : \'\']}" width="{errorIconWidth}">', '<div id="{id}-errorEl" class="{errorMsgCls}" style="display:none"></div>', '</td>', '<tpl elseif="msgTarget==\'under\'">', '<div id="{id}-errorEl" class="{errorMsgClass}" colspan="2" style="display:none"></div>', '{afterBodyEl}', '</td>', '</tpl>', '</tr>', {disableFormats: true}]

Available since: 4.0.0

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

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 Ext JS Components

While some Ext JS 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 itemclick 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'); }
        }
    }
});

Available since: 1.1.0

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

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

Ext.create('Ext.Component', {
    loader: {
        url: 'content.html',
        autoLoad: true
    },
    renderTo: Ext.getBody()
});

Available since: 4.0.0

Specifies the margin for this component. ...

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' (top, right, bottom, left).

Available since: 4.0.0

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

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

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

Available since: 4.0.0

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

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

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

Available since: 4.0.0

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

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

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

Available since: 4.0.0

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

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

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

Available since: 4.0.0

The location where the error message text should display. ...

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

Defaults to: 'qtip'

Available since: 4.0.0

The name of the field. ...

The name of the field. 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.

Available since: 1.1.0

Overrides: Ext.form.field.Field.name

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. This can be useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.

Defaults to: ''

Available since: 2.3.0

Possible values are: * 'auto' to enable automatic horizontal scrollbar (overflow-x: 'auto'). ...

Possible values are: * 'auto' to enable automatic horizontal scrollbar (overflow-x: 'auto'). * 'scroll' to always enable horizontal scrollbar (overflow-x: 'scroll'). The default is overflow-x: 'hidden'. This should not be combined with autoScroll.

Available since: 4.1.0

Possible values are: * 'auto' to enable automatic vertical scrollbar (overflow-y: 'auto'). ...

Possible values are: * 'auto' to enable automatic vertical scrollbar (overflow-y: 'auto'). * 'scroll' to always enable vertical scrollbar (overflow-y: 'scroll'). The default is overflow-y: 'hidden'. This should not be combined with autoScroll.

Available since: 4.1.0

Specifies the padding for this component. ...

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' (top, right, bottom, left).

Available since: 4.0.0

An array of plugins to be added to this component. ...

An array of plugins to be added to this component. Can also be just a single plugin instead of array.

Plugins provide custom functionality for a 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.

Plugins can be added to component by either directly referencing the plugin instance:

plugins: [Ext.create('Ext.grid.plugin.CellEditing', {clicksToEdit: 1})],

By using config object with ptype:

plugins: [{ptype: 'cellediting', clicksToEdit: 1}],

Or with just a ptype:

plugins: ['cellediting', 'gridviewdragdrop'],

See Ext.enums.Plugin for list of all ptypes.

Available since: 2.3.0

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

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

Defaults to: false

Available since: 4.0.0

true to mark the field as readOnly in HTML. ...

true to mark the field as readOnly in HTML.

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.

Defaults to: false

Available since: 1.1.0

The CSS class applied to the component's main element when it is readOnly. ...

The CSS class applied to the component's main element when it is readOnly.

Defaults to: Ext.baseCSSPrefix + 'form-readonly'

Available since: 4.0.0

: "north"/"south"/"east"/"west"/"center"
Defines the region inside border layout. ...

Defines the region inside border layout.

Possible values:

  • north - Positions component at top.
  • south - Positions component at bottom.
  • east - Positions component at right.
  • west - Positions component at left.
  • center - Positions component at the remaining space. There must be a component with region: "center" in every border layout.

Available since: 4.1.1

The data used by renderTpl in addition to the following property values of the component: id ui uiCls baseCls compo...

The data used by renderTpl in addition to the following property values of the component:

  • id
  • ui
  • uiCls
  • baseCls
  • componentCls
  • frame

See renderSelectors and childEls for usage examples.

Available since: 4.0.7

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 renders a title and description into its element:

Ext.create('Ext.Component', {
    renderTo: Ext.getBody(),
    renderTpl: [
        '<h1 class="title">{title}</h1>',
        '<p>{desc}</p>'
    ],
    renderData: {
        title: "Error",
        desc: "Something went wrong"
    },
    renderSelectors: {
        titleEl: 'h1.title',
        descEl: 'p'
    },
    listeners: {
        afterrender: function(cmp){
            // After rendering the component will have a titleEl and descEl properties
            cmp.titleEl.setStyle({color: "red"});
        }
    }
});

For a faster, but less flexible, alternative that achieves the same end result (properties for child elements on the Component after render), see childEls and addChildEls.

Available since: 4.0.0

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

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

Notes:

Do not use this option if the Component is to be a child item of a Container. It is the responsibility of the Container's layout manager to render and manage its child items.

When using this config, a call to render() is not required.

See also: render.

Available since: 2.3.0

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

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 Ext JS and Sencha 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 and childEls options.

Defaults to: '{%this.renderContent(out,values)%}'

Available since: 4.0.0

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

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

Available since: 4.0.0

A valid Ext.resizer.Resizer handles config string. ...

A valid Ext.resizer.Resizer handles config string. Only applies when resizable = true.

Defaults to: 'all'

Available since: 4.0.0

True to layout this component and its descendants in "rtl" (right-to-left) mode. ...

True to layout this component and its descendants in "rtl" (right-to-left) mode. Can be explicitly set to false to override a true value inherited from an ancestor.

Defined in override Ext.rtl.AbstractComponent.

Available since: Ext JS 4.2.0

A buffer to be applied if many state events are fired within a short period. ...

A buffer to be applied if many state events are fired within a short period.

Defaults to: 100

Available since: 4.0.6

Ext.form.field.Checkbox
view source
: Object
An object to use as the scope ('this' reference) of the handler function. ...

An object to use as the scope ('this' reference) of the handler function.

Defaults to this Checkbox.

Available since: 2.3.0

Specifies whether the floating component should be given a 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'

Available since: 4.0.0

Number of pixels to offset the shadow.

Number of pixels to offset the shadow.

Available since: 4.1.0

If this property is a number, it is interpreted as follows: 0: Neither width nor height depend on content. ...

If this property is a number, it is interpreted as follows:

  • 0: Neither width nor height depend on content. This is equivalent to false.
  • 1: Width depends on content (shrink wraps), but height does not.
  • 2: Height depends on content (shrink wraps), but width does not. The default.
  • 3: Both width and height depend on content (shrink wrap). This is equivalent to true.

In CSS terms, shrink-wrap width is analogous to an inline-block element as opposed to a block-level element. Some container layouts always shrink-wrap their children, effectively ignoring this property (e.g., Ext.layout.container.HBox, Ext.layout.container.VBox, Ext.layout.component.Dock).

Defaults to: 2

Available since: 4.1.0

An array of events that, when fired, should trigger this object to save its state. ...

An array of events that, when fired, should trigger this object to save its state. Defaults to none. stateEvents may be any type of event supported by this object, including browser or custom events (e.g., ['click', 'customerchange']).

See stateful for an explanation of saving and restoring object state.

Available since: 4.0.0

The unique id for this object to use for state management purposes. ...

The unique id for this object to use for state management purposes.

See stateful for an explanation of saving and restoring state.

Available since: 4.0.0

A flag which causes the object to attempt to restore the state of internal properties from a saved state on startup. ...

A flag which causes the object to attempt to restore the state of internal properties from a saved state on startup. The object must have a stateId for state to be managed.

Auto-generated ids are not guaranteed to be stable across page loads and cannot be relied upon to save and restore the same state for a object.

For state saving to work, the state manager's provider must have been set to an implementation of Ext.state.Provider which overrides the set and get methods to save and recall name/value pairs. A built-in implementation, Ext.state.CookieProvider is available.

To set the state provider for the current page:

Ext.state.Manager.setProvider(new Ext.state.CookieProvider({

   expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now

}));

A stateful object attempts to save state when one of the events listed in the stateEvents configuration fires.

To save state, a stateful object first serializes its state by calling getState.

The Component base class implements getState to save its width and height within the state only if they were initially configured, and have changed from the configured value.

The Panel class saves its collapsed state in addition to that.

The Grid class saves its column state in addition to its superclass state.

If there is more application state to be save, the developer must provide an implementation which first calls the superclass method to inherit the above behaviour, and then injects new properties into the returned object.

The value yielded by getState is passed to Ext.state.Manager.set which uses the configured Ext.state.Provider to save the object keyed by the stateId.

During construction, a stateful object attempts to restore its state by calling Ext.state.Manager.get passing the stateId

The resulting object is passed to applyState*. The default implementation of applyState simply copies properties into the object, but a developer may override this to support restoration of more complex application state.

You can perform extra processing on state save and restore by attaching handlers to the beforestaterestore, staterestore, beforestatesave and statesave events.

Defaults to: false

Available since: 4.0.0

A custom style specification to be applied to this component's Element. ...

A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.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'
        }
    })
    ]
});

Available since: 1.1.0

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

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

Defaults to: true

Available since: 4.0.0

The tabIndex for this field. ...

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

Available since: 1.1.0

True to automatically call toFront when the show method is called on an already visible, floating component. ...

True to automatically call toFront when the show method is called on an already visible, floating component.

Defaults to: true

Available since: 4.0.0

An Ext.Template, Ext.XTemplate or an array of strings to form an Ext.XTemplate. ...

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

Available since: 3.4.0

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

The Ext.(X)Template method to use when updating the content area of the Component. See Ext.XTemplate.overwrite for information on default mode.

Defaults to: 'overwrite'

Available since: 3.4.0

A UI style for a component. ...

A UI style for a component.

Defaults to: 'default'

Available since: 4.0.0

An array of of classNames which are currently applied to this component. ...

An array of of classNames which are currently applied to this component.

Defaults to: []

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: String
If configured, this will be submitted as the checkbox's value during form submit if the checkbox is unchecked. ...

If configured, this will be submitted as the checkbox's value during form submit if the checkbox is unchecked. By default this is undefined, which results in nothing being submitted for the checkbox field when the form is submitted (the default behavior of HTML checkboxes).

Available since: 4.0.0

Whether the field should validate when it loses focus. ...

Whether the field should validate when it loses focus. This will cause fields to be validated as the user steps through the fields in the form regardless of whether they are making changes to those fields along the way. See also validateOnChange.

Defaults to: true

Available since: 1.1.0

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

Specifies whether this field should be validated immediately whenever a change in its value is detected. 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.field.Base.checkChangeEvents for controlling how changes to the field's value are detected.

Defaults to: true

Available since: 4.0.0

A value to initialize this field with.

A value to initialize this field with.

Available since: 4.0.0

The width of this component in pixels.

The width of this component in pixels.

Available since: 4.0.0

This property provides a shorter alternative to creating objects than using a full class name. ...

This property provides a shorter alternative to creating objects than using a full class name. Using xtype is the most common way to define component instances, especially in a container. For example, the items in a form containing text fields could be created explicitly like so:

 items: [
     Ext.create('Ext.form.field.Text', {
         fieldLabel: 'Foo'
     }),
     Ext.create('Ext.form.field.Text', {
         fieldLabel: 'Bar'
     }),
     Ext.create('Ext.form.field.Number', {
         fieldLabel: 'Num'
     })
 ]

But by using xtype, the above becomes:

 items: [
     {
         xtype: 'textfield',
         fieldLabel: 'Foo'
     },
     {
         xtype: 'textfield',
         fieldLabel: 'Bar'
     },
     {
         xtype: 'numberfield',
         fieldLabel: 'Num'
     }
 ]

When the xtype is common to many items, Ext.container.AbstractContainer.defaultType is another way to specify the xtype for all items that don't have an explicit xtype:

 defaultType: 'textfield',
 items: [
     { fieldLabel: 'Foo' },
     { fieldLabel: 'Bar' },
     { fieldLabel: 'Num', xtype: 'numberfield' }
 ]

Each member of the items array is now just a "configuration object". These objects are used to create and configure component instances. A configuration object can be manually used to instantiate a component using Ext.widget:

 var text1 = Ext.create('Ext.form.field.Text', {
     fieldLabel: 'Foo'
 });

 // or alternatively:

 var text1 = Ext.widget({
     xtype: 'textfield',
     fieldLabel: 'Foo'
 });

This conversion of configuration objects into instantiated components is done when a container is created as part of its {Ext.container.AbstractContainer.initComponent} process. As part of the same process, the items array is converted from its raw array form into a Ext.util.MixedCollection instance.

You can define your own xtype on a custom component by specifying the xtype property in Ext.define. For example:

Ext.define('MyApp.PressMeButton', {
    extend: 'Ext.button.Button',
    xtype: 'pressmebutton',
    text: 'Press Me'
});

Care should be taken when naming an xtype in a custom component because there is a single, shared scope for all xtypes. Third part components should consider using a prefix to avoid collisions.

Ext.define('Foo.form.CoolButton', {
    extend: 'Ext.button.Button',
    xtype: 'ux-coolbutton',
    text: 'Cool!'
});

See Ext.enums.Widget for list of all available xtypes.

Available since: 2.3.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

...

Defaults to: /^([a-z]+)-([a-z]+)(\?)?$/

Available since: Ext JS 4.2.0

Setting this property to true causes the isLayoutRoot method to return true and stop the search for the top-most comp...

Setting this property to true causes the isLayoutRoot method to return true and stop the search for the top-most component for a layout.

Defaults to: false

Available since: 4.1.0

...

Defaults to: ['position', 'top', 'left']

Available since: Ext JS 4.2.0

...

Defaults to: true

Available since: 4.0.0

...

Defaults to: {tag: 'table', cellpadding: 0}

Available since: 4.1.0

true indicates an id was auto-generated rather than provided by configuration. ...

true indicates an id was auto-generated rather than provided by configuration.

Defaults to: false

Available since: 4.1.0

The div Element wrapping the component's contents. ...

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

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: Ext.Element
A reference to the label element created for the boxLabel. ...

A reference to the label element created for the boxLabel. Only present if the component has been rendered and has a boxLabel configured.

Available since: 4.0.0

...

Defaults to: []

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: Arrayprivate
...

Defaults to: ['boxLabelEl']

Available since: 4.1.0

Overrides: Ext.form.Labelable.childEls

The number of component layout calls made on this object. ...

The number of component layout calls made on this object.

Defaults to: 0

Available since: 4.0.3

...

Defaults to: {}

Available since: 4.1.1

The name of the padding property that is used by the layout to manage padding. ...

The name of the padding property that is used by the layout to manage padding. See managePadding

Defaults to: 'padding'

Available since: Ext JS 4.2.0

...

Defaults to: 'autocomponent'

Available since: 4.1.2

...

Defaults to: false

Available since: 4.1.0

Indicates whether or not the component can be dragged. ...

Indicates whether or not the component can be dragged.

Defaults to: false

Available since: 4.0.0

The div Element that will contain the component's error message(s). ...

The div Element that will contain the component's error message(s). Note that depending on the configured 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.

Available since: 4.0.0

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Available since: 4.1.1

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

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

There are other similar relationships such as the button which activates a menu, or the menu item which activated a submenu, or the column header which activated the column menu.

These differences are abstracted away by the up method.

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

See floating and zIndexManager

Available since: 4.0.0

...

Defaults to: Ext.baseCSSPrefix + 'frame'

Available since: 4.1.0

...

Defaults to: ['TL', 'TC', 'TR', 'ML', 'MC', 'MR', 'BL', 'BC', 'BR']

Available since: 4.1.0

...

Defaults to: ['tl', 'tc', 'tr', 'ml', 'mc', 'mr', 'bl', 'bc', 'br']

Available since: 4.1.0

...

Defaults to: /[\-]frame\d+[TMB][LCR]$/

Available since: 4.1.0

Cache the frame information object so as not to cause style recalculations ...

Cache the frame information object so as not to cause style recalculations

Defaults to: {}

Available since: 4.1.0

Indicates the width of any framing elements which were added within the encapsulating element to provide graphical, r...

Indicates the width of any framing elements which were added within the encapsulating element to provide graphical, rounded borders. See the frame config. This property is null if the component is not framed.

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

Available since: 4.0.0

  • top : Number (optional)

    The width of the top framing element in pixels.

    Defaults to: 0

  • right : Number (optional)

    The width of the right framing element in pixels.

    Defaults to: 0

  • bottom : Number (optional)

    The width of the bottom framing element in pixels.

    Defaults to: 0

  • left : Number (optional)

    The width of the left framing element in pixels.

    Defaults to: 0

  • width : Number (optional)

    The total width of the left and right framing elements in pixels.

    Defaults to: 0

  • height : Number (optional)

    The total height of the top and right bottom elements in pixels.

    Defaults to: 0

...

Defaults to: ['{%this.renderDockedItems(out,values,0);%}', '<table class="', Ext.baseCSSPrefix, 'table-plain', '" cellpadding="0"><tbody>', '<tpl if="top">', '<tr>', '<tpl if="left"><td id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl>{frameElCls}" role="presentation"></td></tpl>', '<td id="{fgid}TC" class="{frameCls}-tc {baseCls}-tc {baseCls}-{ui}-tc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl>{frameElCls}" role="presentation"></td>', '<tpl if="right"><td id="{fgid}TR" class="{frameCls}-tr {baseCls}-tr {baseCls}-{ui}-tr<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl>{frameElCls}" role="presentation"></td></tpl>', '</tr>', '</tpl>', '<tr>', '<tpl if="left"><td id="{fgid}ML" class="{frameCls}-ml {baseCls}-ml {baseCls}-{ui}-ml<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl>{frameElCls}" role="presentation"></td></tpl>', '<td id="{fgid}MC" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl>{frameElCls}" role="presentation">', '{%this.applyRenderTpl(out, values)%}', '</td>', '<tpl if="right"><td id="{fgid}MR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl>{frameElCls}" role="presentation"></td></tpl>', '</tr>', '<tpl if="bottom">', '<tr>', '<tpl if="left"><td id="{fgid}BL" class="{frameCls}-bl {baseCls}-bl {baseCls}-{ui}-bl<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl>{frameElCls}" role="presentation"></td></tpl>', '<td id="{fgid}BC" class="{frameCls}-bc {baseCls}-bc {baseCls}-{ui}-bc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl>{frameElCls}" role="presentation"></td>', '<tpl if="right"><td id="{fgid}BR" class="{frameCls}-br {baseCls}-br {baseCls}-{ui}-br<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl>{frameElCls}" role="presentation"></td></tpl>', '</tr>', '</tpl>', '</tbody></table>', '{%this.renderDockedItems(out,values,1);%}']

Available since: 4.1.0

...

Defaults to: ['{%this.renderDockedItems(out,values,0);%}', '<tpl if="top">', '<tpl if="left"><div id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl>{frameElCls}" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}TR" class="{frameCls}-tr {baseCls}-tr {baseCls}-{ui}-tr<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}TC" class="{frameCls}-tc {baseCls}-tc {baseCls}-{ui}-tc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl>{frameElCls}" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>', '<tpl if="left"><div id="{fgid}ML" class="{frameCls}-ml {baseCls}-ml {baseCls}-{ui}-ml<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl>{frameElCls}" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}MR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}MC" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl>{frameElCls}" role="presentation">', '{%this.applyRenderTpl(out, values)%}', '</div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '<tpl if="bottom">', '<tpl if="left"><div id="{fgid}BL" class="{frameCls}-bl {baseCls}-bl {baseCls}-{ui}-bl<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl>{frameElCls}" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}BR" class="{frameCls}-br {baseCls}-br {baseCls}-{ui}-br<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}BC" class="{frameCls}-bc {baseCls}-bc {baseCls}-{ui}-bc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl>{frameElCls}" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>', '{%this.renderDockedItems(out,values,1);%}']

Available since: 4.1.0

private ...

private

Defaults to: false

Available since: 2.3.0

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }

Available since: 4.1.0

...

Defaults to: 'left'

Available since: Ext JS 4.2.0

...

Defaults to: ['<tpl if="errors && errors.length">', '<ul class="{listCls}"><tpl for="errors"><li>{.}</li></tpl></ul>', '</tpl>']

Available since: 4.1.2

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

Ext.form.field.Checkbox
view source
: Stringprivate
the form-cb css class is for styling shared between checkbox and subclasses (radio) ...

the form-cb css class is for styling shared between checkbox and subclasses (radio)

Defaults to: Ext.baseCSSPrefix + 'form-cb'

Available since: Ext JS 4.2.0

The input Element for this Field. ...

The input Element for this Field. Only available after the field has been rendered.

Available since: 4.0.0

...

Defaults to: true

Available since: Ext JS 4.2.0

Ext.form.field.Checkbox
view source
: Booleanprivate
true in this class to identify an object as an instantiated Checkbox, or subclass thereof. ...

true in this class to identify an object as an instantiated Checkbox, or subclass thereof.

Defaults to: true

Available since: 4.0.0

true in this class to identify an object as an instantiated Component, or subclass thereof. ...

true in this class to identify an object as an instantiated Component, or subclass thereof.

Defaults to: true

Available since: 4.0.0

Flag denoting that this object is labelable as a field. ...

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

Defaults to: true

Available since: 4.0.0

Flag denoting that this component is a Field. ...

Flag denoting that this component is a Field. Always true.

Defaults to: true

Available since: 4.0.0

...

Defaults to: true

Available since: 4.1.1

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Available since: 4.0.0

The <TD> Element which contains the label Element for this component. ...

The <TD> Element which contains the label Element for this component. Only available after the component has been rendered.

Available since: 4.1.0

The label Element for this component. ...

The label Element for this component. Only available after the component has been rendered.

Available since: 4.0.0

...

Defaults to: ['beforeBodyEl', 'afterBodyEl', 'beforeLabelTpl', 'afterLabelTpl', 'beforeSubTpl', 'afterSubTpl', 'beforeLabelTextTpl', 'afterLabelTextTpl', 'labelAttrTpl']

Available since: 4.1.0

This is an array to avoid a split on every call to Ext.copyTo ...

This is an array to avoid a split on every call to Ext.copyTo

Defaults to: ['allowBlank', 'id', 'labelAlign', 'fieldBodyCls', 'baseBodyCls', 'clearCls', 'labelSeparator', 'msgTarget']

Available since: 4.1.0

...

Defaults to: 0

Available since: 4.1.0

This is an internal flag that you use when creating custom components. ...

This is an internal flag that you use when creating custom components. By default this is set to true which means that every component gets a mask when it's disabled. Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false since they want to implement custom disable logic.

Defaults to: false

Available since: 4.0.0

Overrides: Ext.AbstractComponent.maskOnDisable

Tells the layout system that the height can be measured immediately because the width does not need setting. ...

Tells the layout system that the height can be measured immediately because the width does not need setting.

Defaults to: true

Available since: 4.1.0

...

Defaults to: Ext.baseCSSPrefix + 'hide-offsets'

Available since: 4.1.2

Ext.form.field.Checkbox
view source
: RegExpprivate
private ...

private

Defaults to: /^on$/i

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: Object
The original value of the field as configured in the checked configuration, or as loaded by the last form load operat...

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

Available since: 3.4.0

Overrides: Ext.form.field.Field.originalValue

This Component's owner Container (is set automatically when this Component is added to a Container). ...

This Component's owner Container (is set automatically when this Component is added to a Container).

Important. This is not a universal upwards navigation pointer. It indicates the Container which owns and manages this Component if any. There are other similar relationships such as the button which activates a menu, or the menu item which activated a submenu, or the column header which activated the column menu.

These differences are abstracted away by the up method.

Note: to access items within the Container see itemId.

Available since: 2.3.0

...

Defaults to: ['<tpl if="errors && errors.length">', '<tpl for="errors"><tpl if="xindex &gt; 1">\n</tpl>{.}</tpl>', '</tpl>']

Available since: 4.1.2

Indicates whether or not the component has been rendered. ...

Indicates whether or not the component has been rendered.

Defaults to: false

Available since: 1.1.0

An object property which provides unified information as to which dimensions are scrollable based upon the autoScroll...

An object property which provides unified information as to which dimensions are scrollable based upon the autoScroll, overflowX and overflowY settings (And for views of trees and grids, the owning panel's scroll setting).

Note that if you set overflow styles using the style config or bodyStyle config, this object does not include that information; it is best to use autoScroll, overflowX and overflowY if you need to access these flags.

This object has the following properties:

Available since: Ext JS 4.2.0

  • x : Boolean

    true if this Component is scrollable horizontally - style setting may be 'auto' or 'scroll'.

  • y : Boolean

    true if this Component is scrollable vertically - style setting may be 'auto' or 'scroll'.

  • both : Boolean

    true if this Component is scrollable both horizontally and vertically.

  • overflowX : String

    The overflow-x style setting, 'auto' or 'scroll' or ''.

  • overflowY : String

    The overflow-y style setting, 'auto' or 'scroll' or ''.

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 4.0.0

Ext.form.field.Checkbox
view source
: Booleanprivate
inputEl should always retain the same size, never stretch ...

inputEl should always retain the same size, never stretch

Defaults to: false

Available since: 4.1.2

Overrides: Ext.form.field.Base.stretchInputElFixed

Ext.form.field.Checkbox
view source
: Arrayprivate
...

Defaults to: ['beforeBoxLabelTpl', 'afterBoxLabelTpl', 'beforeBoxLabelTextTpl', 'afterBoxLabelTextTpl', 'boxLabelAttrTpl', 'inputAttrTpl']

Available since: 4.1.0

Overrides: Ext.form.field.Base.subTplInsertions

...

Defaults to: 0

Available since: 4.0.0

...

Defaults to: 0

Available since: 4.0.0

Available since: Ext JS 4.2.0

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

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. If no floating ancestor is found, the global ZIndexManager is used.

See floating and zIndexParent

Available since: 4.0.0

Only present for floating Components which were inserted as child items of Containers, and which have a floating Cont...

Only present for floating Components which were inserted as child items of Containers, and which have a floating Container in their containment ancestry.

For floating Components which are child items of a Container, the zIndexParent will be a 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.

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

For example, the dropdown BoundList of a ComboBox which is in a Window will have the Window as its zIndexParent, and will always show above that Window, wherever the Window is placed in the z-index stack.

See floating and zIndexManager

Available since: 4.1.0

Defined By

Static properties

...

Defaults to: []

Available since: 4.1.1

Methods

Defined By

Instance methods

Creates new Component. ...

Creates new Component.

Available since: 1.1.0

Parameters

  • config : Ext.Element/String/Object

    The configuration options may be specified as either:

    • an element : it is set as the internal element and its id used as the component id
    • a string : it is assumed to be the id of an existing element and is used as the component id
    • anything else : it is assumed to be a standard config object and is applied to the component

Returns

Fires

    Overrides: Ext.AbstractComponent.constructor, Ext.Component.constructor

    Adds each argument passed to this method to the childEls array. ...

    Adds each argument passed to this method to the childEls array.

    Available since: 4.1.0

    Fires

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

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

      Available since: 2.3.0

      This method has been deprecated since 4.1

      Use addCls instead.

      Parameters

      Returns

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

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

      Available since: 4.0.0

      Parameters

      Returns

      Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this component. ...

      Adds a cls to the uiCls array, which will also call addUIClsToElement and adds to all elements of this component.

      Available since: 4.0.0

      Parameters

      • classes : String/String[]

        A string or an array of strings to add to the uiCls.

      • skip : Object

        (Boolean) skip true to skip adding it to the class and do it later (via the return).

      Fires

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

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

        Available since: 1.1.0

        Parameters

        • eventNames : Object/String...

          Either an object with event names as properties with a value of true. For example:

          this.addEvents({
              storeloaded: true,
              storecleared: true
          });
          

          Or any number of event names as separate parameters. For example:

          this.addEvents('storeloaded', 'storecleared');
          
        Sets up the focus listener on this Component's focusEl if it has one. ...

        Sets up the focus listener on this Component's focusEl if it has one.

        Form Components which must implicitly participate in tabbing order usually have a naturally focusable element as their focusEl, and it is the DOM event of that receiving focus which drives the Component's onFocus handling, and the DOM event of it being blurred which drives the onBlur handling.

        If the focusEl is not naturally focusable, then the listeners are only added if the FocusManager is enabled.

        Available since: 4.1.0

        Fires

          ( element, listeners, scope, options ) : Object
          Appends an event handler to this object. ...

          Appends an event handler to this object. For example:

          myGridPanel.on("mouseover", this.onMouseOver, this);
          

          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
          });
          

          One can also specify options for each event handler separately:

          myGridPanel.on({
              cellClick: {fn: this.onCellClick, scope: this, single: true},
              mouseover: {fn: panel.onMouseOver, scope: panel}
          });
          

          Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

          myGridPanel.on({
              cellClick: {fn: 'onCellClick', scope: this, single: true},
              mouseover: {fn: 'onMouseOver', scope: panel}
          });
          

          Available since: 4.0.0

          Parameters

          Returns

          • Object

            Only when the destroyable option is specified.

            A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

            this.btnListeners =  = myButton.on({
                destroyable: true
                mouseover:   function() { console.log('mouseover'); },
                mouseout:    function() { console.log('mouseout'); },
                click:       function() { console.log('click'); }
            });
            

            And when those listeners need to be removed:

            Ext.destroy(this.btnListeners);
            

            or

            this.btnListeners.destroy();
            

          Fires

            Overrides: Ext.util.Observable.addListener

            ( item, ename, [fn], [scope], [options] ) : Object
            Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

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

            Available since: 4.0.0

            Parameters

            • item : Ext.util.Observable/Ext.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.

            • options : Object (optional)

              If the ename parameter was an event name, this is the addListener options.

            Returns

            • Object

              Only when the destroyable option is specified.

              A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

              this.btnListeners =  = myButton.mon({
                  destroyable: true
                  mouseover:   function() { console.log('mouseover'); },
                  mouseout:    function() { console.log('mouseout'); },
                  click:       function() { console.log('click'); }
              });
              

              And when those listeners need to be removed:

              Ext.destroy(this.btnListeners);
              

              or

              this.btnListeners.destroy();
              

            Fires

              ...

              Available since: 4.0.0

              Adds a plugin. ...

              Adds a plugin. May be called at any time in the component's lifecycle.

              Available since: Ext JS 4.2.0

              Parameters

              Fires

                ( state, propName, [value] ) : Booleanprotected
                Save a property to the given state object if it is not its default or configured value. ...

                Save a property to the given state object if it is not its default or configured value.

                Available since: 4.1.0

                Parameters

                • state : Object

                  The state object.

                • propName : String

                  The name of the property on this object to save.

                • value : String (optional)

                  The value of the state property (defaults to this[propName]).

                Returns

                • Boolean

                  The state object or a new object if state was null and the property was saved.

                Fires

                  Add events that will trigger the state to be saved. ...

                  Add events that will trigger the state to be saved. If the first argument is an array, each element of that array is the name of a state event. Otherwise, each argument passed to this method is the name of a state event.

                  Available since: 4.0.0

                  Parameters

                  • events : String/String[]

                    The event name or an array of event names.

                  Fires

                    Method which adds a specified UI + uiCls to the components element. ...

                    Method which adds a specified UI + uiCls to the components element. Can be overridden to remove the UI from more than just the components element.

                    Available since: 4.0.0

                    Parameters

                    • ui : String

                      The UI to remove from the element.

                    Method which adds a specified UI to the components element. ...

                    Method which adds a specified UI to the components element.

                    Available since: 4.0.0

                    Fires

                      private ==> used outside of core TODO: currently only used by ToolTip. ...

                      private ==> used outside of core TODO: currently only used by ToolTip. does this method belong here?

                      Available since: Ext JS 4.2.0

                      Parameters

                      Fires

                        ...

                        Available since: 4.0.0

                        Parameters

                        Fires

                          Called by the layout system after the Component has been laid out. ...

                          Called by the layout system after the Component has been laid out.

                          Available since: 4.0.0

                          This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                          Fires

                            Overrides: Ext.AbstractComponent.afterComponentLayout, Ext.Component.afterComponentLayout

                            ...

                            Available since: 4.1.0

                            Parameters

                            Fires

                            • boxready
                            • move
                            ( [callback], [scope] )protectedtemplate
                            Invoked after the Component has been hidden. ...

                            Invoked after the Component has been hidden.

                            Gets passed the same callback and scope parameters that onHide received.

                            Available since: 4.0.0

                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                            Parameters

                            Fires

                            ( )privateprotectedtemplate
                            Allows addition of behavior after rendering is complete. ...

                            Allows addition of behavior after rendering is complete. At this stage the Component’s Element will have been styled according to the configuration, will have had any configured CSS class names added, and will be in the configured visibility and the configured enable state.

                            Available since: 4.0.0

                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                            Fires

                            Overrides: Ext.util.Renderable.afterRender

                            ( ax, ay )protectedtemplate
                            Template method called after a Component has been positioned. ...

                            Template method called after a Component has been positioned.

                            Available since: 4.0.0

                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                            Parameters

                            Fires

                            Overrides: Ext.AbstractComponent.afterSetPosition

                            ( [animateTarget], [callback], [scope] )protectedtemplate
                            Invoked after the Component is shown (after onShow is called). ...

                            Invoked after the Component is shown (after onShow is called).

                            Gets passed the same parameters as show.

                            Available since: 4.0.0

                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                            Parameters

                            Fires

                            ( element, [position], [offsets], [animate] ) : Ext.util.Positionablechainable
                            Aligns the element with another element relative to the specified anchor points. ...

                            Aligns the element with another element relative to the specified anchor points. If the other element is the document it aligns it to the viewport. The position parameter is optional, and can be specified in any one of the following formats:

                            • Blank: Defaults to aligning the element's top-left corner to the target's bottom-left corner ("tl-bl").
                            • One anchor (deprecated): The passed anchor position is used as the target element's anchor point. The element being aligned will position its top-left corner (tl) to that point. This method has been deprecated in favor of the newer two anchor syntax below.
                            • Two anchors: If two values from the table below are passed separated by a dash, the first value is used as the element's anchor point, and the second value is used as the target's anchor point.

                            In addition to the anchor points, the position parameter also supports the "?" character. If "?" is passed at the end of the position string, the element will attempt to align as specified, but the position will be adjusted to constrain to the viewport if necessary. Note that the element being aligned might be swapped to align to a different position than that specified in order to enforce the viewport constraints. Following are all of the supported anchor positions:

                            Value  Description
                            -----  -----------------------------
                            tl     The top left corner (default)
                            t      The center of the top edge
                            tr     The top right corner
                            l      The center of the left edge
                            c      In the center of the element
                            r      The center of the right edge
                            bl     The bottom left corner
                            b      The center of the bottom edge
                            br     The bottom right corner
                            

                            Example Usage:

                            // align el to other-el using the default positioning
                            // ("tl-bl", non-constrained)
                            el.alignTo("other-el");
                            
                            // align the top left corner of el with the top right corner of other-el
                            // (constrained to viewport)
                            el.alignTo("other-el", "tr?");
                            
                            // align the bottom right corner of el with the center left edge of other-el
                            el.alignTo("other-el", "br-l?");
                            
                            // align the center of el with the bottom left corner of other-el and
                            // adjust the x position by -6 pixels (and the y position by 0)
                            el.alignTo("other-el", "c-bl", [-6, 0]);
                            

                            Available since: Ext JS 4.2.0

                            Parameters

                            • element : Ext.util.Positionable/HTMLElement/String

                              The Positionable, HTMLElement, or id of the element to align to.

                            • position : String (optional)

                              The position to align to

                              Defaults to: "tl-bl?"

                            • offsets : Number[] (optional)

                              Offset the positioning by [x, y]

                            • animate : Boolean/Object (optional)

                              true for the default animation or a standard Element animation config object

                            Returns

                            Fires

                              ( element, [position], [offsets], [animate], [monitorScroll], [callback] ) : Ext.util.Positionablechainable
                              Anchors an element to another element and realigns it when the window is resized. ...

                              Anchors an element to another element and realigns it when the window is resized.

                              Available since: Ext JS 4.2.0

                              Parameters

                              • element : Ext.util.Positionable/HTMLElement/String

                                The Positionable, HTMLElement, or id of the element to align to.

                              • position : String (optional)

                                The position to align to

                                Defaults to: "tl-bl?"

                              • offsets : Number[] (optional)

                                Offset the positioning by [x, y]

                              • animate : Boolean/Object (optional)

                                true for the default animation or a standard Element animation config object

                              • monitorScroll : Boolean/Number (optional)

                                True to monitor body scroll and reposition. If this parameter is a number, it is used as the buffer delay in milliseconds.

                                Defaults to: 50

                              • callback : Function (optional)

                                The function to call after the animation finishes

                              Returns

                              Fires

                                process the passed fx configuration. ...
                                • process the passed fx configuration.

                                Available since: 4.0.0

                                Parameters

                                Fires

                                  Performs custom animation on this object. ...

                                  Performs custom animation on this object.

                                  This method is applicable to both the Component class and the Sprite class. It performs animated transitions of certain properties of this object over a specified timeline.

                                  Animating a Component

                                  When animating a Component, the following properties may be specified in from, to, and keyframe objects:

                                  • x - The Component's page X position in pixels.

                                  • y - The Component's page Y position in pixels

                                  • left - The Component's left value in pixels.

                                  • top - The Component's top value in pixels.

                                  • width - The Component's width value in pixels.

                                  • height - The Component's height value in pixels.

                                  • dynamic - Specify as true to update the Component's layout (if it is a Container) at every frame of the animation. Use sparingly as laying out on every intermediate size change is an expensive operation.

                                  For example, to animate a Window to a new size, ensuring that its internal layout and any shadow is correct:

                                  myWindow = Ext.create('Ext.window.Window', {
                                      title: 'Test Component animation',
                                      width: 500,
                                      height: 300,
                                      layout: {
                                          type: 'hbox',
                                          align: 'stretch'
                                      },
                                      items: [{
                                          title: 'Left: 33%',
                                          margins: '5 0 5 5',
                                          flex: 1
                                      }, {
                                          title: 'Left: 66%',
                                          margins: '5 5 5 5',
                                          flex: 2
                                      }]
                                  });
                                  myWindow.show();
                                  myWindow.header.el.on('click', function() {
                                      myWindow.animate({
                                          to: {
                                              width: (myWindow.getWidth() == 500) ? 700 : 500,
                                              height: (myWindow.getHeight() == 300) ? 400 : 300
                                          }
                                      });
                                  });
                                  

                                  For performance reasons, by default, the internal layout is only updated when the Window reaches its final "to" size. If dynamic updating of the Window's child Components is required, then configure the animation with dynamic: true and the two child items will maintain their proportions during the animation.

                                  Available since: 4.0.0

                                  Parameters

                                  Returns

                                  Fires

                                    Overrides: Ext.util.Animate.animate

                                    Sets references to elements inside the component. ...

                                    Sets references to elements inside the component.

                                    Available since: 4.1.0

                                    Parameters

                                    Fires

                                      Sets references to elements inside the component. ...

                                      Sets references to elements inside the component. This applies renderSelectors as well as childEls.

                                      Available since: 4.0.0

                                      Fires

                                        Overrides: Ext.util.Renderable.applyRenderSelectors

                                        Applies the state to the object. ...

                                        Applies the state to the object. This should be overridden in subclasses to do more complex state operations. By default it applies the state properties onto the current object.

                                        Available since: 4.0.0

                                        Parameters

                                        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.

                                        Available since: 4.0.0

                                        Parameters

                                        • fn : Object

                                          A function containing the transaction code

                                        Fires

                                        Template method to do any pre-blur processing. ...

                                        Template method to do any pre-blur processing.

                                        Available since: 4.1.0

                                        Parameters

                                        ( adjWidth, adjHeight )protectedtemplate
                                        Occurs before componentLayout is run. ...

                                        Occurs before componentLayout is run. Returning false from this method will prevent the componentLayout from being executed.

                                        Available since: 4.0.0

                                        This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                        Parameters

                                        • adjWidth : Number

                                          The box-adjusted width that was set.

                                        • adjHeight : Number

                                          The box-adjusted height that was set.

                                        Ext.form.field.Checkbox
                                        view source
                                        ( )protectedtemplate
                                        inherit docs ...

                                        inherit docs

                                        Available since: 4.0.0

                                        This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                        Fires

                                          Overrides: Ext.AbstractComponent.beforeDestroy

                                          Template method to do any pre-focus processing. ...

                                          Template method to do any pre-focus processing.

                                          Available since: 4.1.2

                                          Parameters

                                          Occurs before componentLayout is run. ...

                                          Occurs before componentLayout is run. In previous releases, this method could return false to prevent its layout but that is not supported in Ext JS 4.1 or higher. This method is simply a notification of the impending layout to give the component a chance to adjust the DOM. Ideally, DOM reads should be avoided at this time to reduce expensive document reflows.

                                          Available since: Ext JS 4.2.0

                                          This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                          ...

                                          Available since: 4.1.0

                                          Fires

                                            Overrides: Ext.util.Renderable.beforeRender

                                            Template method before a field is reset. ...

                                            Template method before a field is reset.

                                            Available since: 4.1.1

                                            Template method called before a Component is positioned. ...

                                            Template method called before a Component is positioned.

                                            Ensures that the position is adjusted so that the Component is constrained if so configured.

                                            Available since: 4.1.0

                                            Fires

                                              Overrides: Ext.AbstractComponent.beforeSetPosition

                                              Invoked before the Component is shown. ...

                                              Invoked before the Component is shown.

                                              Available since: 4.0.0

                                              This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                              ...

                                              Available since: 4.0.0

                                              Returns

                                              Fires

                                                ( fn, [scope], [args] ) : Ext.Componentchainable
                                                Bubbles up the component/container heirarchy, calling the specified function with each component. ...

                                                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.

                                                Available since: 3.4.0

                                                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. Defaults to passing the current component.

                                                Returns

                                                Fires

                                                  ( [anchor], [extraX], [extraY], [size] ) : Number[]private
                                                  Calculates x,y coordinates specified by the anchor position on the element, adding extraX and extraY values. ...

                                                  Calculates x,y coordinates specified by the anchor position on the element, adding extraX and extraY values.

                                                  Available since: Ext JS 4.2.0

                                                  Parameters

                                                  • anchor : String (optional)

                                                    The specified anchor position. See alignTo for details on supported anchor positions.

                                                    Defaults to: 'tl'

                                                  • extraX : Number (optional)

                                                    value to be added to the x coordinate

                                                  • extraY : Number (optional)

                                                    value to be added to the y coordinate

                                                  • size : Object (optional)

                                                    An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

                                                  Returns

                                                  • Number[]

                                                    [x, y] An array containing the element's x and y coordinates

                                                  Fires

                                                    ( [constrainTo], [proposedPosition], [local], [proposedSize] ) : Number[]
                                                    Calculates the new [x,y] position to move this Positionable into a constrain region. ...

                                                    Calculates the new [x,y] position to move this Positionable into a constrain region.

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

                                                    Priority is given to constraining the top and left within the constraint.

                                                    An alternative constraint may be passed.

                                                    Available since: Ext JS 4.2.0

                                                    Parameters

                                                    • constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)

                                                      The Element or Region into which this Component is to be constrained. Defaults to the element into which this Positionable was rendered, or this Component's {@link Ext.Component.constrainTo.

                                                    • proposedPosition : Number[] (optional)

                                                      A proposed [X, Y] position to test for validity and to coerce into constraints instead of using this Positionable's current position.

                                                    • local : Boolean (optional)

                                                      The proposedPosition is local (relative to floatParent if a floating Component)

                                                    • proposedSize : Number[] (optional)

                                                      A proposed [width, height] size to use when calculating constraints instead of using this Positionable's current size.

                                                    Returns

                                                    • Number[]

                                                      If the element needs to be translated, the new [X, Y] position within constraints if possible, giving priority to keeping the top and left edge in the constrain region. Otherwise, false.

                                                    Fires

                                                      ( args ) : Objectdeprecatedprotected
                                                      Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

                                                      Call the original method that was previously overridden with override

                                                      Ext.define('My.Cat', {
                                                          constructor: function() {
                                                              alert("I'm a cat!");
                                                          }
                                                      });
                                                      
                                                      My.Cat.override({
                                                          constructor: function() {
                                                              alert("I'm going to be a cat!");
                                                      
                                                              this.callOverridden();
                                                      
                                                              alert("Meeeeoooowwww");
                                                          }
                                                      });
                                                      
                                                      var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                                                                // alerts "I'm a cat!"
                                                                                // alerts "Meeeeoooowwww"
                                                      

                                                      Available since: 4.0.0

                                                      This method has been deprecated

                                                      as of 4.1. Use callParent instead.

                                                      Parameters

                                                      • args : Array/Arguments

                                                        The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

                                                      Returns

                                                      • Object

                                                        Returns the result of calling the overridden method

                                                      Call the "parent" method of the current method. ...

                                                      Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

                                                       Ext.define('My.Base', {
                                                           constructor: function (x) {
                                                               this.x = x;
                                                           },
                                                      
                                                           statics: {
                                                               method: function (x) {
                                                                   return x;
                                                               }
                                                           }
                                                       });
                                                      
                                                       Ext.define('My.Derived', {
                                                           extend: 'My.Base',
                                                      
                                                           constructor: function () {
                                                               this.callParent([21]);
                                                           }
                                                       });
                                                      
                                                       var obj = new My.Derived();
                                                      
                                                       alert(obj.x);  // alerts 21
                                                      

                                                      This can be used with an override as follows:

                                                       Ext.define('My.DerivedOverride', {
                                                           override: 'My.Derived',
                                                      
                                                           constructor: function (x) {
                                                               this.callParent([x*2]); // calls original My.Derived constructor
                                                           }
                                                       });
                                                      
                                                       var obj = new My.Derived();
                                                      
                                                       alert(obj.x);  // now alerts 42
                                                      

                                                      This also works with static methods.

                                                       Ext.define('My.Derived2', {
                                                           extend: 'My.Base',
                                                      
                                                           statics: {
                                                               method: function (x) {
                                                                   return this.callParent([x*2]); // calls My.Base.method
                                                               }
                                                           }
                                                       });
                                                      
                                                       alert(My.Base.method(10);     // alerts 10
                                                       alert(My.Derived2.method(10); // alerts 20
                                                      

                                                      Lastly, it also works with overridden static methods.

                                                       Ext.define('My.Derived2Override', {
                                                           override: 'My.Derived2',
                                                      
                                                           statics: {
                                                               method: function (x) {
                                                                   return this.callParent([x*2]); // calls My.Derived2.method
                                                               }
                                                           }
                                                       });
                                                      
                                                       alert(My.Derived2.method(10); // now alerts 40
                                                      

                                                      To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

                                                      Available since: 4.0.0

                                                      Parameters

                                                      • args : Array/Arguments

                                                        The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

                                                      Returns

                                                      • Object

                                                        Returns the result of calling the parent method

                                                      This method is used by an override to call the superclass method but bypass any overridden method. ...

                                                      This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

                                                      Consider:

                                                       Ext.define('Ext.some.Class', {
                                                           method: function () {
                                                               console.log('Good');
                                                           }
                                                       });
                                                      
                                                       Ext.define('Ext.some.DerivedClass', {
                                                           method: function () {
                                                               console.log('Bad');
                                                      
                                                               // ... logic but with a bug ...
                                                      
                                                               this.callParent();
                                                           }
                                                       });
                                                      

                                                      To patch the bug in DerivedClass.method, the typical solution is to create an override:

                                                       Ext.define('App.paches.DerivedClass', {
                                                           override: 'Ext.some.DerivedClass',
                                                      
                                                           method: function () {
                                                               console.log('Fixed');
                                                      
                                                               // ... logic but with bug fixed ...
                                                      
                                                               this.callSuper();
                                                           }
                                                       });
                                                      

                                                      The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

                                                      Available since: 4.1.3

                                                      Parameters

                                                      • args : Array/Arguments

                                                        The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

                                                      Returns

                                                      • Object

                                                        Returns the result of calling the superclass method

                                                      Cancel any deferred focus on this component ...

                                                      Cancel any deferred focus on this component

                                                      Available since: 4.1.0

                                                      Center this Component in its container. ...

                                                      Center this Component in its container.

                                                      Available since: 4.0.0

                                                      Returns

                                                      Fires

                                                      • move
                                                      Checks whether the value of the field has changed since the last time it was checked. ...

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

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

                                                      Available since: 4.0.0

                                                      Fires

                                                      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.

                                                      Available since: 4.0.0

                                                      Fires

                                                      Clear any invalid styles/messages for this field. ...

                                                      Clear any invalid styles/messages for this field.

                                                      Note: this method does not cause the Field's validate or isValid methods to return true if the value does not pass validation. So simply clearing a field's errors will not necessarily allow submission of forms submitted with the Ext.form.action.Submit.clientValidation option set.

                                                      Available since: 1.1.0

                                                      Fires

                                                        Overrides: Ext.form.field.Field.clearInvalid, Ext.form.field.Base.clearInvalid

                                                        Removes all listeners for this object including the managed listeners ...

                                                        Removes all listeners for this object including the managed listeners

                                                        Available since: 4.0.0

                                                        Fires

                                                          Removes all managed listeners for this object. ...

                                                          Removes all managed listeners for this object.

                                                          Available since: 4.0.0

                                                          Fires

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

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

                                                            Available since: 2.3.0

                                                            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

                                                            ...

                                                            Available since: 4.1.1

                                                            ...

                                                            Available since: 4.0.0

                                                            Parameters

                                                            • ptype : String/Object

                                                              string or config object containing a ptype property.

                                                              Constructs a plugin according to the passed config object/ptype string.

                                                              Ensures that the constructed plugin always has a cmp reference back to this component. The setting up of this is done in PluginManager. The PluginManager ensures that a reference to this component is passed to the constructor. It also ensures that the plugin's setCmp method (if any) is called.

                                                            Returns an array of fully constructed plugin instances. ...

                                                            Returns an array of fully constructed plugin instances. This converts any configs into their appropriate instances.

                                                            It does not mutate the plugins array. It creates a new array.

                                                            Available since: 4.0.5

                                                            Fires

                                                              ( eventName, args, bubbles )private
                                                              Continue to fire event. ...

                                                              Continue to fire event.

                                                              Available since: 4.0.7

                                                              Parameters

                                                              Fires

                                                                Defined in override Ext.rtl.AbstractComponent. ...

                                                                Defined in override Ext.rtl.AbstractComponent.

                                                                Available since: Ext JS 4.2.0

                                                                Parameters

                                                                Fires

                                                                  Overrides: Ext.util.Positionable.convertPositionSpec

                                                                  Creates an event handling function which refires the event from this object as the passed event name. ...

                                                                  Creates an event handling function which refires the event from this object as the passed event name.

                                                                  Available since: 4.0.0

                                                                  Parameters

                                                                  • newName : String

                                                                    The name under which to refire the passed parameters.

                                                                  • beginEnd : Array (optional)

                                                                    The caller can specify on which indices to slice.

                                                                  Returns

                                                                  ...

                                                                  Available since: 4.0.0

                                                                  Disable the component. ...

                                                                  Disable the component.

                                                                  Available since: 1.1.0

                                                                  Parameters

                                                                  • silent : Boolean (optional)

                                                                    Passing true will suppress the disable event from being fired.

                                                                    Defaults to: false

                                                                  Fires

                                                                  Called from the selected frame generation template to insert this Component's inner structure inside the framing stru...

                                                                  Called from the selected frame generation template to insert this Component's inner structure inside the framing structure.

                                                                  When framing is used, a selected frame generation template is used as the primary template of the getElConfig instead of the configured renderTpl. The renderTpl is invoked by this method which is injected into the framing template.

                                                                  Available since: 4.1.0

                                                                  Parameters

                                                                  Handles autoRender. ...

                                                                  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

                                                                  Available since: 4.1.0

                                                                  Fires

                                                                  • afterrender
                                                                  • beforerender
                                                                  • render
                                                                  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.

                                                                  Available since: 4.0.0

                                                                  Returns

                                                                  Fires

                                                                    Overrides: Ext.AbstractComponent.doComponentLayout

                                                                    Moves this floating Component into a constrain region. ...

                                                                    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.

                                                                    Available since: 4.0.0

                                                                    Parameters

                                                                    • constrainTo : String/HTMLElement/Ext.Element/Ext.util.Region (optional)

                                                                      The Element or Region into which this Component is to be constrained. Defaults to the element into which this floating Component was rendered.

                                                                    Fires

                                                                    • move
                                                                    ...

                                                                    Available since: 4.1.0

                                                                    Parameters

                                                                    ...

                                                                    Available since: 4.1.0

                                                                    Parameters

                                                                    Enable the component ...

                                                                    Enable the component

                                                                    Available since: 1.1.0

                                                                    Parameters

                                                                    • silent : Boolean (optional)

                                                                      Passing true will suppress the enable event from being fired.

                                                                      Defaults to: false

                                                                    Fires

                                                                    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.define('Ext.overrides.form.field.Base', {
                                                                        override: 'Ext.form.field.Base',
                                                                    
                                                                        //  Add functionality to Field's initComponent to enable the change event to bubble
                                                                        initComponent: function () {
                                                                            this.callParent();
                                                                            this.enableBubble('change');
                                                                        }
                                                                    });
                                                                    
                                                                    var myForm = Ext.create('Ext.form.Panel', {
                                                                        title: 'User Details',
                                                                        items: [{
                                                                            ...
                                                                        }],
                                                                        listeners: {
                                                                            change: function() {
                                                                                // Title goes red if form has been modified.
                                                                                myForm.header.setStyle('color', 'red');
                                                                            }
                                                                        }
                                                                    });
                                                                    

                                                                    Available since: 3.4.0

                                                                    Parameters

                                                                    • eventNames : String/String[]

                                                                      The event name to bubble, or an Array of event names.

                                                                    Ensures that this component is attached to document.body. ...

                                                                    Ensures that this component is attached to document.body. If the component was rendered to Ext.getDetachedBody, then it will be appended to document.body. Any configured position is also restored.

                                                                    Available since: 4.1.0

                                                                    Parameters

                                                                    • runLayout : Boolean (optional)

                                                                      True to run the component's layout.

                                                                      Defaults to: false

                                                                    Fires

                                                                    • move
                                                                    Only relevant if the instance's isFileUpload method returns true. ...

                                                                    Only relevant if the instance's isFileUpload method returns true. Returns a reference to the file input DOM element holding the user's selected file. The input will be appended into the submission form and will not be returned, so this method should also create a replacement.

                                                                    Available since: 4.0.0

                                                                    Returns

                                                                    • HTMLElement
                                                                    Find a container above this component at any level by a custom function. ...

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

                                                                    See also the up method.

                                                                    Available since: 2.3.0

                                                                    Parameters

                                                                    • fn : Function

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

                                                                    Returns

                                                                    Fires

                                                                      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

                                                                      See also the up method.

                                                                      Available since: 2.3.0

                                                                      Parameters

                                                                      • xtype : String/Ext.Class

                                                                        The xtype string for a component, or the class of the component directly

                                                                      Returns

                                                                      Fires

                                                                        Finds a plugin by ptype in the plugins array ...

                                                                        Finds a plugin by ptype in the plugins array

                                                                        Available since: Ext JS 4.2.0

                                                                        Parameters

                                                                        This method visits the rendered component tree in a "top-down" order. ...

                                                                        This method visits the rendered component tree in a "top-down" order. That is, this code runs on a parent component before running on a child. This method calls the onRender method of each component.

                                                                        Available since: 4.1.0

                                                                        Parameters

                                                                        • containerIdx : Number

                                                                          The index into the Container items of this Component.

                                                                        Fires

                                                                        • afterrender
                                                                        • render
                                                                        ...

                                                                        Available since: 4.1.0

                                                                        Fires

                                                                          Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addList...

                                                                          Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

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

                                                                          Available since: 1.1.0

                                                                          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.

                                                                          Fires

                                                                            Fires the specified event with the passed parameter list. ...

                                                                            Fires the specified event with the passed parameter list.

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

                                                                            Available since: Ext JS 4.2.0

                                                                            Parameters

                                                                            • eventName : String

                                                                              The name of the event to fire.

                                                                            • args : Object[]

                                                                              An array of parameters which are passed to handlers.

                                                                            Returns

                                                                            • Boolean

                                                                              returns false if any of the handlers return false otherwise it returns true.

                                                                            Fires

                                                                              For more information on the hierarchy events, see the note for the hierarchyEventSource observer defined in the onCla...

                                                                              For more information on the hierarchy events, see the note for the hierarchyEventSource observer defined in the onClassCreated callback.

                                                                              This functionality is contained in Component (as opposed to Container) because a Component can be the ownerCt for a floating component (loadmask), and the loadmask needs to know when its owner is shown/hidden via the hierarchyEventSource so that its hidden state can be synchronized.

                                                                              TODO: merge this functionality with Ext.globalEvents

                                                                              Available since: Ext JS 4.2.0

                                                                              Parameters

                                                                              private ...

                                                                              private

                                                                              Available since: 2.3.0

                                                                              Parameters

                                                                              Fires

                                                                              ...

                                                                              Available since: 4.0.0

                                                                              Parameters

                                                                              Fires

                                                                              • move
                                                                              ( [selectText], [delay] ) : Ext.Component
                                                                              Try to focus this component. ...

                                                                              Try to focus this component.

                                                                              Available since: 1.1.0

                                                                              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

                                                                                The focused Component. Usually this Component. Some Containers may delegate focus to a descendant Component (Windows can do this through their defaultFocus config option.

                                                                              Fires

                                                                                Forces this component to redo its componentLayout. ...

                                                                                Forces this component to redo its componentLayout.

                                                                                Available since: 4.0.2

                                                                                This method has been deprecated since 4.1.0

                                                                                Use updateLayout instead.

                                                                                Fires

                                                                                  Deprecate 5.0 ...

                                                                                  Deprecate 5.0

                                                                                  Available since: 4.0.0

                                                                                  Overrides: Ext.Component.getActionEl

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

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

                                                                                  Available since: 4.0.0

                                                                                  Returns

                                                                                  Gets the active error message for this component, if any. ...

                                                                                  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.

                                                                                  Available since: 4.0.0

                                                                                  Returns

                                                                                  • String

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

                                                                                  Gets an Array of any active error messages currently applied to the field. ...

                                                                                  Gets an Array of any active error messages currently applied to the field. This does not trigger validation on its own, it merely returns any messages that the component may already hold.

                                                                                  Available since: 4.0.0

                                                                                  Returns

                                                                                  • String[]

                                                                                    The active error messages on the component; if there are no errors, an empty Array is returned.

                                                                                  ( element, [position], [offsets] ) : Number[]
                                                                                  Gets the x,y coordinates to align this element with another element. ...

                                                                                  Gets the x,y coordinates to align this element with another element. See alignTo for more info on the supported position values.

                                                                                  Available since: Ext JS 4.2.0

                                                                                  Parameters

                                                                                  • element : Ext.util.Positionable/HTMLElement/String

                                                                                    The Positionable, HTMLElement, or id of the element to align to.

                                                                                  • position : String (optional)

                                                                                    The position to align to

                                                                                    Defaults to: "tl-bl?"

                                                                                  • offsets : Number[] (optional)

                                                                                    Offset the positioning by [x, y]

                                                                                  Returns

                                                                                  Fires

                                                                                    private ...

                                                                                    private

                                                                                    Available since: Ext JS 4.2.0

                                                                                    ( el, [anchor], [local], [size] ) : Number[]private
                                                                                    Begin Positionable methods Overridden in Ext.rtl.AbstractComponent. ...

                                                                                    Begin Positionable methods


                                                                                    Overridden in Ext.rtl.AbstractComponent.

                                                                                    Available since: Ext JS 4.2.0

                                                                                    Parameters

                                                                                    • el : Ext.dom.Element

                                                                                      The element

                                                                                    • anchor : String (optional)

                                                                                      The specified anchor position. See alignTo for details on supported anchor positions.

                                                                                      Defaults to: 'tl'

                                                                                    • local : Boolean (optional)

                                                                                      True to get the local (element top/left-relative) anchor position instead of page coordinates

                                                                                    • size : Object (optional)

                                                                                      An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

                                                                                    Returns

                                                                                    • Number[]

                                                                                      [x, y] An array containing the element's x and y coordinates

                                                                                    Overrides: Ext.util.Positionable.getAnchorToXY

                                                                                    ( [anchor], [local], [size] ) : Number[]
                                                                                    Gets the x,y coordinates specified by the anchor position on the element. ...

                                                                                    Gets the x,y coordinates specified by the anchor position on the element.

                                                                                    Available since: Ext JS 4.2.0

                                                                                    Parameters

                                                                                    • anchor : String (optional)

                                                                                      The specified anchor position. See alignTo for details on supported anchor positions.

                                                                                      Defaults to: 'tl'

                                                                                    • local : Boolean (optional)

                                                                                      True to get the local (element top/left-relative) anchor position instead of page coordinates

                                                                                    • size : Object (optional)

                                                                                      An object containing the size to use for calculating anchor position {width: (target width), height: (target height)} (defaults to the element's current size)

                                                                                    Returns

                                                                                    • Number[]

                                                                                      [x, y] An array containing the element's x and y coordinates

                                                                                    Fires

                                                                                      ...

                                                                                      Available since: 4.1.2

                                                                                      Parameters

                                                                                      ...

                                                                                      Available since: 4.0.0

                                                                                      Calculates the colspan value for the body cell - the cell which contains the input field. ...

                                                                                      Calculates the colspan value for the body cell - the cell which contains the input field.

                                                                                      The field table structure contains 4 columns:

                                                                                      Available since: 4.1.0

                                                                                      Fires

                                                                                        Overridden in Ext.rtl.AbstractComponent. ...

                                                                                        Overridden in Ext.rtl.AbstractComponent.

                                                                                        Available since: Ext JS 4.2.0

                                                                                        Returns

                                                                                        • Object

                                                                                          an object with the following numeric properties - beforeX - afterX - beforeY - afterY

                                                                                        Overrides: Ext.util.Positionable.getBorderPadding

                                                                                        ( [contentBox], [local] ) : Object
                                                                                        Return an object defining the area of this Element which can be passed to setBox to set another Element's size/locati...

                                                                                        Return an object defining the area of this Element which can be passed to setBox to set another Element's size/location to match this element.

                                                                                        Available since: Ext JS 4.2.0

                                                                                        Parameters

                                                                                        • contentBox : Boolean (optional)

                                                                                          If true a box for the content of the element is returned.

                                                                                        • local : Boolean (optional)

                                                                                          If true the element's left and top relative to its offsetParent are returned instead of page x/y.

                                                                                        Returns

                                                                                        • Object

                                                                                          box An object in the format:

                                                                                          {
                                                                                              x: <Element's X position>,
                                                                                              y: <Element's Y position>,
                                                                                              left: <Element's X position (an alias for x)>,
                                                                                              top: <Element's Y position (an alias for y)>,
                                                                                              width: <Element's width>,
                                                                                              height: <Element's height>,
                                                                                              bottom: <Element's lower bound>,
                                                                                              right: <Element's rightmost bound>
                                                                                          }
                                                                                          

                                                                                          The returned object may also be addressed as an Array where index 0 contains the X position and index 1 contains the Y position. The result may also be used for setXY

                                                                                        Fires

                                                                                          Gets the bubbling parent for an Observable ...

                                                                                          Gets the bubbling parent for an Observable

                                                                                          Available since: 4.0.7

                                                                                          Returns

                                                                                          Fires

                                                                                            Implements an upward event bubbling policy. ...

                                                                                            Implements an upward event bubbling policy. By default a Component bubbles events up to its reference owner.

                                                                                            Component subclasses may implement a different bubbling strategy by overriding this method.

                                                                                            Available since: 3.4.0

                                                                                            Fires

                                                                                              Overrides: Ext.AbstractComponent.getBubbleTarget

                                                                                              ...

                                                                                              Available since: 4.1.0

                                                                                              Fires

                                                                                                ...

                                                                                                Available since: 4.1.0

                                                                                                Parameters

                                                                                                Fires

                                                                                                  ...

                                                                                                  Available since: 4.0.0

                                                                                                  Fires

                                                                                                    ...

                                                                                                    Available since: 4.1.0

                                                                                                    Parameters

                                                                                                    ( [constrainTo], [proposedPosition], [proposedSize] ) : Number[]/Boolean
                                                                                                    Returns the [X, Y] vector by which this Positionable's element must be translated to make a best attempt to constrain...

                                                                                                    Returns the [X, Y] vector by which this Positionable's element must be translated to make a best attempt to constrain within the passed constraint. Returns false if the element does not need to be moved.

                                                                                                    Priority is given to constraining the top and left within the constraint.

                                                                                                    The constraint may either be an existing element into which the element is to be constrained, or a Region into which this element is to be constrained.

                                                                                                    By default, any extra shadow around the element is not included in the constrain calculations - the edges of the element are used as the element bounds. To constrain the shadow within the constrain region, set the constrainShadow property on this element to true.

                                                                                                    Available since: Ext JS 4.2.0

                                                                                                    Parameters

                                                                                                    • constrainTo : Ext.util.Positionable/HTMLElement/String/Ext.util.Region (optional)

                                                                                                      The Positionable, HTMLElement, element id, or Region into which the element is to be constrained.

                                                                                                    • proposedPosition : Number[] (optional)

                                                                                                      A proposed [X, Y] position to test for validity and to produce a vector for instead of using the element's current position

                                                                                                    • proposedSize : Number[] (optional)

                                                                                                      A proposed [width, height] size to constrain instead of using the element's current size

                                                                                                    Returns

                                                                                                    • Number[]/Boolean

                                                                                                      If the element needs to be translated, an [X, Y] vector by which this element must be translated. Otherwise, false.

                                                                                                    Fires

                                                                                                      ...

                                                                                                      Available since: 4.0.0

                                                                                                      ...

                                                                                                      Available since: 4.0.0

                                                                                                      Retrieves the top level element representing this component. ...

                                                                                                      Retrieves the top level element representing this component.

                                                                                                      Available since: 1.1.0

                                                                                                      Returns

                                                                                                      Overrides: Ext.AbstractComponent.getEl

                                                                                                      Ext.form.field.Checkbox
                                                                                                      view source
                                                                                                      ( )private
                                                                                                      ...

                                                                                                      Available since: 4.0.0

                                                                                                      Fires

                                                                                                        Overrides: Ext.util.Renderable.getElConfig

                                                                                                        ...

                                                                                                        Available since: 4.1.1

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

                                                                                                        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.

                                                                                                        Available since: 4.0.0

                                                                                                        Parameters

                                                                                                        • value : Object

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

                                                                                                        Returns

                                                                                                        • String[]

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

                                                                                                        Returns the label for the field. ...

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

                                                                                                        Available since: 4.0.0

                                                                                                        This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                        Returns

                                                                                                        • String

                                                                                                          The configured field label, or empty string if not defined

                                                                                                        Fires

                                                                                                          Ext.form.field.Checkbox
                                                                                                          view source
                                                                                                          ( )private
                                                                                                          ...

                                                                                                          Available since: 4.1.0

                                                                                                          Overrides: Ext.form.field.Base.getFieldStyle

                                                                                                          Returns the focus holder element associated with this Component. ...

                                                                                                          Returns the focus holder element associated with this Component. At the Component base class level, this function returns undefined.

                                                                                                          Subclasses which use embedded focusable elements (such as Window, Field and Button) should override this for use by the focus method.

                                                                                                          Containers which need to participate in the FocusManager's navigation and Container focusing scheme also need to return a focusEl, although focus is only listened for in this case if the FocusManager is enabled.

                                                                                                          Available since: 4.0.0

                                                                                                          Returns

                                                                                                          • undefined

                                                                                                            undefined because raw Components cannot by default hold focus.

                                                                                                          Overrides: Ext.AbstractComponent.getFocusEl

                                                                                                          Ext.form.field.Checkbox
                                                                                                          view source
                                                                                                          ( )private
                                                                                                          ...

                                                                                                          Available since: 4.1.0

                                                                                                          Fires

                                                                                                            On render, reads an encoded style attribute, "background-position" from the style of this Component's element. ...

                                                                                                            On render, reads an encoded style attribute, "background-position" from the style of this Component's element. This information is memoized based upon the CSS class name of this Component's element. Because child Components are rendered as textual HTML as part of the topmost Container, a dummy div is inserted into the document to receive the document element's CSS class name, and therefore style attributes.

                                                                                                            Available since: 4.1.0

                                                                                                            Fires

                                                                                                              ...

                                                                                                              Available since: Ext JS 4.2.0

                                                                                                              ...

                                                                                                              Available since: 4.1.0

                                                                                                              Parameters

                                                                                                              Fires

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

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

                                                                                                                Available since: 4.0.0

                                                                                                                Returns

                                                                                                                A component's hierarchyState is used to keep track of aspects of a component's state that affect its descendants hier...

                                                                                                                A component's hierarchyState is used to keep track of aspects of a component's state that affect its descendants hierarchically like "collapsed" and "hidden". For example, if this.hierarchyState.hidden == true, it means that either this component, or one of its ancestors is hidden.

                                                                                                                Hierarchical state management is implemented by chaining each component's hierarchyState property to its parent container's hierarchyState property via the prototype. The result is such that if a component's hierarchyState does not have it's own property, it inherits the property from the nearest ancestor that does.

                                                                                                                To set a hierarchical "hidden" value:

                                                                                                                this.getHierarchyState().hidden = true;
                                                                                                                

                                                                                                                It is important to remember when unsetting hierarchyState properties to delete them instead of just setting them to a falsy value. This ensures that the hierarchyState returns to a state of inheriting the value instead of overriding it To unset the hierarchical "hidden" value:

                                                                                                                delete this.getHierarchyState().hidden;
                                                                                                                

                                                                                                                IMPORTANT! ALWAYS access hierarchyState using this method, not by accessing this.hierarchyState directly. The hierarchyState property does not exist until the first time getHierarchyState() is called. At that point getHierarchyState() walks up the component tree to establish the hierarchyState prototype chain. Additionally the hierarchyState property should NOT be relied upon even after the initial call to getHierarchyState() because it is possible for the hierarchyState to be invalidated. Invalidation typically happens when a component is moved to a new container. In such a case the hierarchy state remains invalid until the next time getHierarchyState() is called on the component or one of its descendants.

                                                                                                                Available since: Ext JS 4.2.0

                                                                                                                Parameters

                                                                                                                Fires

                                                                                                                  Retrieves the id of this component. ...

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

                                                                                                                  Available since: 1.1.0

                                                                                                                  Returns

                                                                                                                  Fires

                                                                                                                    Overrides: Ext.AbstractComponent.getId

                                                                                                                    Returns the initial configuration passed to constructor when instantiating this class. ...

                                                                                                                    Returns the initial configuration passed to constructor when instantiating this class.

                                                                                                                    Available since: 4.1.0

                                                                                                                    Parameters

                                                                                                                    • name : String (optional)

                                                                                                                      Name of the config option to return.

                                                                                                                    Returns

                                                                                                                    • Object/Mixed

                                                                                                                      The full config object or a single config value when name parameter specified.

                                                                                                                    Returns the input id for this field. ...

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

                                                                                                                    Available since: 4.0.0

                                                                                                                    Overrides: Ext.form.Labelable.getInputId

                                                                                                                    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.

                                                                                                                    Available since: 4.1.0

                                                                                                                    Parameters

                                                                                                                    Returns

                                                                                                                    • HTMLElement

                                                                                                                      DOM element that you can use in the insertBefore

                                                                                                                    ...

                                                                                                                    Available since: 4.1.0

                                                                                                                    Parameters

                                                                                                                    Returns the value of itemId assigned to this component, or when that is not set, returns the value of id. ...

                                                                                                                    Returns the value of itemId assigned to this component, or when that is not set, returns the value of id.

                                                                                                                    Available since: 4.0.0

                                                                                                                    Returns

                                                                                                                    ...

                                                                                                                    Available since: 4.1.0

                                                                                                                    ...

                                                                                                                    Available since: 4.1.0

                                                                                                                    ...

                                                                                                                    Available since: 4.1.0

                                                                                                                    Gets any label styling for the labelEl ...

                                                                                                                    Gets any label styling for the labelEl

                                                                                                                    Available since: 4.1.0

                                                                                                                    Returns

                                                                                                                    Gets the width of the label (if visible) ...

                                                                                                                    Gets the width of the label (if visible)

                                                                                                                    Available since: 4.1.3

                                                                                                                    Returns

                                                                                                                    Fires

                                                                                                                      Generates the arguments for the field decorations rendering template. ...

                                                                                                                      Generates the arguments for the field decorations rendering template.

                                                                                                                      Available since: 4.0.0

                                                                                                                      Returns

                                                                                                                      Fires

                                                                                                                        Gets the Ext.ComponentLoader for this Component. ...

                                                                                                                        Gets the Ext.ComponentLoader for this Component.

                                                                                                                        Available since: 4.0.0

                                                                                                                        Returns

                                                                                                                        Overridden in Ext.rtl.AbstractComponent. ...

                                                                                                                        Overridden in Ext.rtl.AbstractComponent.

                                                                                                                        Available since: Ext JS 4.2.0

                                                                                                                        Returns

                                                                                                                        Overrides: Ext.util.Positionable.getLocalX, Ext.AbstractComponent.getLocalX

                                                                                                                        Overridden in Ext.rtl.AbstractComponent. ...

                                                                                                                        Overridden in Ext.rtl.AbstractComponent.

                                                                                                                        Available since: Ext JS 4.2.0

                                                                                                                        Returns

                                                                                                                        • Number[]

                                                                                                                          The local XY position of the element

                                                                                                                        Overrides: Ext.util.Positionable.getLocalXY

                                                                                                                        Returns the y coordinate of this element reletive to its offsetParent. ...

                                                                                                                        Returns the y coordinate of this element reletive to its offsetParent.

                                                                                                                        Available since: Ext JS 4.2.0

                                                                                                                        Returns

                                                                                                                        Overrides: Ext.util.Positionable.getLocalY

                                                                                                                        Ext.form.field.Checkbox
                                                                                                                        view source
                                                                                                                        ( )private
                                                                                                                        inherit docs ...

                                                                                                                        inherit docs

                                                                                                                        Available since: 4.0.0

                                                                                                                        ...

                                                                                                                        Available since: 4.1.0

                                                                                                                        Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when Ext.form.Basic.updateRe...

                                                                                                                        Returns the value(s) that should be saved to the Ext.data.Model instance for this field, when Ext.form.Basic.updateRecord is called. 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 data value. More advanced field implementations may return more than one name-value pair. The returned values will be saved to the corresponding field names in the Model.

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

                                                                                                                        Available since: 4.0.0

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

                                                                                                                        Fires

                                                                                                                          Returns the name attribute of the field. ...

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

                                                                                                                          Available since: 4.0.0

                                                                                                                          Returns

                                                                                                                          Returns the offsets of this element from the passed element. ...

                                                                                                                          Returns the offsets of this element from the passed element. The element must both be part of the DOM tree and not have display:none to have page coordinates.

                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                          Parameters

                                                                                                                          Returns

                                                                                                                          • Number[]

                                                                                                                            The XY page offsets (e.g. [100, -200])

                                                                                                                          Fires

                                                                                                                            Include margins ...

                                                                                                                            Include margins

                                                                                                                            Available since: 4.0.0

                                                                                                                            Get an el for overflowing, defaults to the target el ...

                                                                                                                            Get an el for overflowing, defaults to the target el

                                                                                                                            Available since: Ext JS 4.2.0

                                                                                                                            Fires

                                                                                                                              Returns the CSS style object which will set the Component's scroll styles. ...

                                                                                                                              Returns the CSS style object which will set the Component's scroll styles. This must be applied to the target element.

                                                                                                                              Available since: 4.1.0

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

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

                                                                                                                              Available since: 4.0.0

                                                                                                                              Parameters

                                                                                                                              Returns

                                                                                                                              Gets the current XY position of the component's underlying element. ...

                                                                                                                              Gets the current XY position of the component's underlying element.

                                                                                                                              Available since: 4.0.0

                                                                                                                              Parameters

                                                                                                                              • local : Boolean (optional)

                                                                                                                                If true the element's left and top are returned instead of page XY.

                                                                                                                                Defaults to: false

                                                                                                                              Returns

                                                                                                                              • Number[]

                                                                                                                                The XY position of the element (e.g., [100, 200])

                                                                                                                              Fires

                                                                                                                                Deprecate 5.0 ...

                                                                                                                                Deprecate 5.0

                                                                                                                                Available since: 4.0.0

                                                                                                                                ...

                                                                                                                                Available since: 4.0.0

                                                                                                                                Ext.form.field.Checkbox
                                                                                                                                view source
                                                                                                                                ( ) : Boolean
                                                                                                                                Returns the checked state of the checkbox. ...

                                                                                                                                Returns the checked state of the checkbox.

                                                                                                                                Available since: 1.1.0

                                                                                                                                Returns

                                                                                                                                • Boolean

                                                                                                                                  True if checked, else false

                                                                                                                                Overrides: Ext.form.field.Base.getRawValue

                                                                                                                                Used by ComponentQuery, and the up method to find the owning Component in the linkage hierarchy. ...

                                                                                                                                Used by ComponentQuery, and the up method to find the owning Component in the linkage hierarchy.

                                                                                                                                By default this returns the Container which contains this Component.

                                                                                                                                This may be overriden by Component authors who implement ownership hierarchies which are not based upon ownerCt, such as BoundLists being owned by Fields or Menus being owned by Buttons.

                                                                                                                                Available since: Ext JS 4.2.0

                                                                                                                                Returns a region object that defines the area of this element. ...

                                                                                                                                Returns a region object that defines the area of this element.

                                                                                                                                Available since: Ext JS 4.2.0

                                                                                                                                Returns

                                                                                                                                Fires

                                                                                                                                  ...

                                                                                                                                  Available since: 4.1.0

                                                                                                                                  Fires

                                                                                                                                  • beforerender
                                                                                                                                  Deprecate 5.0 ...

                                                                                                                                  Deprecate 5.0

                                                                                                                                  Available since: 4.0.0

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

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

                                                                                                                                  Available since: 4.0.0

                                                                                                                                  Returns

                                                                                                                                  • Object

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

                                                                                                                                  Returns an object that describes how this component's width and height are managed. ...

                                                                                                                                  Returns an object that describes how this component's width and height are managed. All of these objects are shared and should not be modified.

                                                                                                                                  Available since: 4.1.0

                                                                                                                                  Parameters

                                                                                                                                  Returns

                                                                                                                                  The supplied default state gathering method for the AbstractComponent class. ...

                                                                                                                                  The supplied default state gathering method for the AbstractComponent class.

                                                                                                                                  This method returns dimension settings such as flex, anchor, width and height along with collapsed state.

                                                                                                                                  Subclasses which implement more complex state should call the superclass's implementation, and apply their state to the result if this basic state is to be saved.

                                                                                                                                  Note that Component state will only be saved if the Component has a stateId and there as a StateProvider configured for the document.

                                                                                                                                  Available since: 4.0.0

                                                                                                                                  Returns

                                                                                                                                  Fires

                                                                                                                                    Overrides: Ext.state.Stateful.getState, Ext.AbstractComponent.getState

                                                                                                                                    Gets the state id for this object. ...

                                                                                                                                    Gets the state id for this object.

                                                                                                                                    Available since: 4.0.0

                                                                                                                                    Returns

                                                                                                                                    • String

                                                                                                                                      The 'stateId' or the implicit 'id' specified by component configuration.

                                                                                                                                    Returns an offscreen div with the same class name as the element this is being rendered. ...

                                                                                                                                    Returns an offscreen div with the same class name as the element this is being rendered. This is because child item rendering takes place in a detached div which, being not part of the document, has no styling.

                                                                                                                                    Available since: 4.1.0

                                                                                                                                    Parameters

                                                                                                                                    Ext.form.field.Checkbox
                                                                                                                                    view source
                                                                                                                                    ( ) : Objecttemplate
                                                                                                                                    Creates and returns the data object to be used when rendering the fieldSubTpl. ...

                                                                                                                                    Creates and returns the data object to be used when rendering the fieldSubTpl.

                                                                                                                                    Available since: 4.0.0

                                                                                                                                    This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                    Returns

                                                                                                                                    Fires

                                                                                                                                      Overrides: Ext.form.field.Base.getSubTplData

                                                                                                                                      Gets the markup to be inserted into the outer template's bodyEl. ...

                                                                                                                                      Gets the markup to be inserted into the outer template's bodyEl. For fields this is the actual input element.

                                                                                                                                      Available since: 4.0.0

                                                                                                                                      Fires

                                                                                                                                        Overrides: Ext.form.Labelable.getSubTplMarkup

                                                                                                                                        private override to use getSubmitValue() as a convenience ...

                                                                                                                                        private override to use getSubmitValue() as a convenience

                                                                                                                                        Available since: 4.0.0

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

                                                                                                                                        Fires

                                                                                                                                          Overrides: Ext.form.field.Field.getSubmitData

                                                                                                                                          Ext.form.field.Checkbox
                                                                                                                                          view source
                                                                                                                                          ( ) : String
                                                                                                                                          Returns the submit value for the checkbox which can be used when submitting forms. ...

                                                                                                                                          Returns the submit value for the checkbox which can be used when submitting forms.

                                                                                                                                          Available since: 4.0.0

                                                                                                                                          Returns

                                                                                                                                          Overrides: Ext.form.field.Base.getSubmitValue

                                                                                                                                          This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component. ...

                                                                                                                                          This is used to determine where to insert the 'html', 'contentEl' and 'items' in this component.

                                                                                                                                          Available since: 4.0.0

                                                                                                                                          ...

                                                                                                                                          Available since: 4.0.0

                                                                                                                                          Parameters

                                                                                                                                          Ext.form.field.Checkbox
                                                                                                                                          view source
                                                                                                                                          ( ) : Boolean
                                                                                                                                          Returns the checked state of the checkbox. ...

                                                                                                                                          Returns the checked state of the checkbox.

                                                                                                                                          Available since: 1.1.0

                                                                                                                                          Returns

                                                                                                                                          • Boolean

                                                                                                                                            True if checked, else false

                                                                                                                                          Overrides: Ext.form.field.Base.getValue

                                                                                                                                          Returns the content region of this element. ...

                                                                                                                                          Returns the content region of this element. That is the region within the borders and padding.

                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                          Returns

                                                                                                                                          • Ext.util.Region

                                                                                                                                            A Region containing "top, left, bottom, right" member data.

                                                                                                                                          Fires

                                                                                                                                            Deprecate 5.0 ...

                                                                                                                                            Deprecate 5.0

                                                                                                                                            Available since: 4.0.0

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

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

                                                                                                                                            Available since: 4.0.0

                                                                                                                                            Returns

                                                                                                                                            Gets the current X position of the DOM element based on page coordinates. ...

                                                                                                                                            Gets the current X position of the DOM element based on page coordinates.

                                                                                                                                            Available since: Ext JS 4.2.0

                                                                                                                                            Returns

                                                                                                                                            • Number

                                                                                                                                              The X position of the element

                                                                                                                                            Overrides: Ext.util.Positionable.getX

                                                                                                                                            Gets the xtype for this component as registered with Ext.ComponentManager. ...

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

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

                                                                                                                                            Available since: 2.3.0

                                                                                                                                            Returns

                                                                                                                                            Returns this Component's xtype hierarchy as a slash-delimited string. ...

                                                                                                                                            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.field.Text();
                                                                                                                                            alert(t.getXTypes());  // alerts 'component/field/textfield'
                                                                                                                                            

                                                                                                                                            Available since: 2.3.0

                                                                                                                                            Returns

                                                                                                                                            • String

                                                                                                                                              The xtype hierarchy string

                                                                                                                                            Gets the current position of the DOM element based on page coordinates. ...

                                                                                                                                            Gets the current position of the DOM element based on page coordinates.

                                                                                                                                            Available since: Ext JS 4.2.0

                                                                                                                                            Returns

                                                                                                                                            • Number[]

                                                                                                                                              The XY position of the element

                                                                                                                                            Overrides: Ext.util.Positionable.getXY

                                                                                                                                            Gets the current Y position of the DOM element based on page coordinates. ...

                                                                                                                                            Gets the current Y position of the DOM element based on page coordinates.

                                                                                                                                            Available since: Ext JS 4.2.0

                                                                                                                                            Returns

                                                                                                                                            • Number

                                                                                                                                              The Y position of the element

                                                                                                                                            Overrides: Ext.util.Positionable.getY

                                                                                                                                            Tells whether the field currently has an active error message. ...

                                                                                                                                            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.

                                                                                                                                            Available since: 4.0.0

                                                                                                                                            Returns

                                                                                                                                            Fires

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

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

                                                                                                                                              Available since: 4.0.0

                                                                                                                                              This method has been deprecated since 4.0

                                                                                                                                              Replaced by getActiveAnimation

                                                                                                                                              Returns

                                                                                                                                              Checks if the specified CSS class exists on this element's DOM node. ...

                                                                                                                                              Checks if the specified CSS class exists on this element's DOM node.

                                                                                                                                              Available since: 4.1.0

                                                                                                                                              Parameters

                                                                                                                                              • className : String

                                                                                                                                                The CSS class to check for.

                                                                                                                                              Returns

                                                                                                                                              • Boolean

                                                                                                                                                true if the class exists, else false.

                                                                                                                                              ...

                                                                                                                                              Available since: 4.1.0

                                                                                                                                              Parameters

                                                                                                                                              Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

                                                                                                                                              Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

                                                                                                                                              Available since: 1.1.0

                                                                                                                                              Parameters

                                                                                                                                              • eventName : String

                                                                                                                                                The name of the event to check for

                                                                                                                                              Returns

                                                                                                                                              • Boolean

                                                                                                                                                true if the event is being listened for or bubbles, else false

                                                                                                                                              Checks if there is currently a specified uiCls. ...

                                                                                                                                              Checks if there is currently a specified uiCls.

                                                                                                                                              Available since: 4.0.0

                                                                                                                                              Parameters

                                                                                                                                              • cls : String

                                                                                                                                                The cls to check.

                                                                                                                                              Checks if the field has a visible label ...

                                                                                                                                              Checks if the field has a visible label

                                                                                                                                              Available since: 4.1.0

                                                                                                                                              Returns

                                                                                                                                              • Boolean

                                                                                                                                                True if the field has a visible label

                                                                                                                                              Fires

                                                                                                                                                ( [animateTarget], [callback], [scope] ) : Ext.Componentchainable
                                                                                                                                                Hides this Component, setting it to invisible using the configured hideMode. ...

                                                                                                                                                Hides this Component, setting it to invisible using the configured hideMode.

                                                                                                                                                Available since: 1.1.0

                                                                                                                                                Parameters

                                                                                                                                                • animateTarget : String/Ext.Element/Ext.Component (optional)

                                                                                                                                                  only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true.. The target to which the Component should animate while hiding.

                                                                                                                                                  Defaults to: null

                                                                                                                                                • callback : Function (optional)

                                                                                                                                                  A callback function to call after the Component is hidden.

                                                                                                                                                • scope : Object (optional)

                                                                                                                                                  The scope (this reference) in which the callback is executed. Defaults to this Component.

                                                                                                                                                Returns

                                                                                                                                                Fires

                                                                                                                                                ...

                                                                                                                                                Available since: 4.0.0

                                                                                                                                                Fires

                                                                                                                                                  Ext.form.field.Checkbox
                                                                                                                                                  view source
                                                                                                                                                  ( )protectedtemplate
                                                                                                                                                  private ...

                                                                                                                                                  private

                                                                                                                                                  Available since: 1.1.0

                                                                                                                                                  This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                  Fires

                                                                                                                                                    Overrides: Ext.Component.initComponent, Ext.form.field.Base.initComponent

                                                                                                                                                    ( config ) : Ext.Basechainableprotected
                                                                                                                                                    Initialize configuration for this class. ...

                                                                                                                                                    Initialize configuration for this class. a typical example:

                                                                                                                                                    Ext.define('My.awesome.Class', {
                                                                                                                                                        // The default config
                                                                                                                                                        config: {
                                                                                                                                                            name: 'Awesome',
                                                                                                                                                            isAwesome: true
                                                                                                                                                        },
                                                                                                                                                    
                                                                                                                                                        constructor: function(config) {
                                                                                                                                                            this.initConfig(config);
                                                                                                                                                        }
                                                                                                                                                    });
                                                                                                                                                    
                                                                                                                                                    var awesome = new My.awesome.Class({
                                                                                                                                                        name: 'Super Awesome'
                                                                                                                                                    });
                                                                                                                                                    
                                                                                                                                                    alert(awesome.getName()); // 'Super Awesome'
                                                                                                                                                    

                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                    Parameters

                                                                                                                                                    Returns

                                                                                                                                                    ...

                                                                                                                                                    Available since: 4.1.0

                                                                                                                                                    Parameters

                                                                                                                                                    ...

                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                    Ext.form.field.Checkbox
                                                                                                                                                    view source
                                                                                                                                                    ( )protected
                                                                                                                                                    private ...

                                                                                                                                                    private

                                                                                                                                                    Available since: 2.3.0

                                                                                                                                                    Fires

                                                                                                                                                      Overrides: Ext.AbstractComponent.initEvents, Ext.form.field.Base.initEvents

                                                                                                                                                      Initializes this Field mixin on the current instance. ...

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

                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                      Fires

                                                                                                                                                        ...

                                                                                                                                                        Available since: 4.1.0

                                                                                                                                                        Fires

                                                                                                                                                          Poke in a reference to applyRenderTpl(frameInfo, out) ...

                                                                                                                                                          Poke in a reference to applyRenderTpl(frameInfo, out)

                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                          Parameters

                                                                                                                                                          Fires

                                                                                                                                                            ...

                                                                                                                                                            Available since: Ext JS 4.2.0

                                                                                                                                                            Fires

                                                                                                                                                              Called by getHierarchyState to initialize the hierarchyState the first time it is requested. ...

                                                                                                                                                              Called by getHierarchyState to initialize the hierarchyState the first time it is requested.

                                                                                                                                                              Overridden in Ext.rtl.AbstractComponent.

                                                                                                                                                              Available since: Ext JS 4.2.0

                                                                                                                                                              Parameters

                                                                                                                                                              Performs initialization of this mixin. ...

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

                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                              Fires

                                                                                                                                                                Initializes padding by applying it to the target element, or if the layout manages padding ensures that the padding o...

                                                                                                                                                                Initializes padding by applying it to the target element, or if the layout manages padding ensures that the padding on the target element is "0".

                                                                                                                                                                Available since: Ext JS 4.2.0

                                                                                                                                                                Parameters

                                                                                                                                                                Fires

                                                                                                                                                                  ...

                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                  Parameters

                                                                                                                                                                  Initialized the renderData to be used when rendering the renderTpl. ...

                                                                                                                                                                  Initialized the renderData to be used when rendering the renderTpl.

                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                  Returns

                                                                                                                                                                  • Object

                                                                                                                                                                    Object with keys and values that are going to be applied to the renderTpl

                                                                                                                                                                  Fires

                                                                                                                                                                    Overrides: Ext.util.Renderable.initRenderData

                                                                                                                                                                    Initializes the renderTpl. ...

                                                                                                                                                                    Initializes the renderTpl.

                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                    Returns

                                                                                                                                                                    Fires

                                                                                                                                                                      Overrides: Ext.util.Renderable.initRenderTpl

                                                                                                                                                                      ...

                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                      Parameters

                                                                                                                                                                      Initializes the state of the object upon construction. ...

                                                                                                                                                                      Initializes the state of the object upon construction.

                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                      Fires

                                                                                                                                                                      Applies padding, margin, border, top, left, height, and width configs to the appropriate elements. ...

                                                                                                                                                                      Applies padding, margin, border, top, left, height, and width configs to the appropriate elements.

                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                      Parameters

                                                                                                                                                                      Fires

                                                                                                                                                                        Ext.form.field.Checkbox
                                                                                                                                                                        view source
                                                                                                                                                                        ( )
                                                                                                                                                                        Initializes the field's value based on the initial config. ...

                                                                                                                                                                        Initializes the field's value based on the initial config.

                                                                                                                                                                        Available since: 2.3.0

                                                                                                                                                                        Fires

                                                                                                                                                                          Overrides: Ext.form.field.Field.initValue

                                                                                                                                                                          Tests whether this Component matches the selector string. ...

                                                                                                                                                                          Tests whether this Component matches the selector string.

                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                          Parameters

                                                                                                                                                                          • selector : String

                                                                                                                                                                            The selector string to test against.

                                                                                                                                                                          Returns

                                                                                                                                                                          • Boolean

                                                                                                                                                                            true if this Component matches the selector.

                                                                                                                                                                          Ext.form.field.Checkbox
                                                                                                                                                                          view source
                                                                                                                                                                          ( rawValue, inputValue )private
                                                                                                                                                                          ...

                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                          Parameters

                                                                                                                                                                          Utility method to determine if a Component is floating, and has an owning Container whose coordinate system it must b...

                                                                                                                                                                          Utility method to determine if a Component is floating, and has an owning Container whose coordinate system it must be positioned in when using setPosition.

                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                          ...

                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                          Parameters

                                                                                                                                                                          Determines whether this component is the descendant of a particular container. ...

                                                                                                                                                                          Determines whether this component is the descendant of a particular container.

                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                          Parameters

                                                                                                                                                                          Returns

                                                                                                                                                                          • Boolean

                                                                                                                                                                            true if the component is the descendant of a particular container, otherwise false.

                                                                                                                                                                          Fires

                                                                                                                                                                            Returns true if the value of this Field has been changed from its originalValue. ...

                                                                                                                                                                            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.

                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                            Returns

                                                                                                                                                                            • Boolean

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

                                                                                                                                                                            Fires

                                                                                                                                                                              Method to determine whether this Component is currently disabled. ...

                                                                                                                                                                              Method to determine whether this Component is currently disabled.

                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                              Returns

                                                                                                                                                                              • Boolean

                                                                                                                                                                                the disabled state of this Component.

                                                                                                                                                                              Method to determine whether this Component is draggable. ...

                                                                                                                                                                              Method to determine whether this Component is draggable.

                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                              Returns

                                                                                                                                                                              • Boolean

                                                                                                                                                                                the draggable state of this component.

                                                                                                                                                                              Method to determine whether this Component is droppable. ...

                                                                                                                                                                              Method to determine whether this Component is droppable.

                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                              Returns

                                                                                                                                                                              • Boolean

                                                                                                                                                                                the droppable state of this component.

                                                                                                                                                                              Returns whether two field values are logically equal. ...

                                                                                                                                                                              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.

                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                              Parameters

                                                                                                                                                                              • value1 : Object

                                                                                                                                                                                The first value to compare

                                                                                                                                                                              • value2 : Object

                                                                                                                                                                                The second value to compare

                                                                                                                                                                              Returns

                                                                                                                                                                              • Boolean

                                                                                                                                                                                True if the values are equal, false if inequal.

                                                                                                                                                                              Returns whether two values are logically equal. ...

                                                                                                                                                                              Returns whether two values are logically equal. Similar to isEqual, however null or undefined values will be treated as empty strings.

                                                                                                                                                                              Available since: 4.0.7

                                                                                                                                                                              Parameters

                                                                                                                                                                              • value1 : Object

                                                                                                                                                                                The first value to compare

                                                                                                                                                                              • value2 : Object

                                                                                                                                                                                The second value to compare

                                                                                                                                                                              Returns

                                                                                                                                                                              • Boolean

                                                                                                                                                                                True if the values are equal, false if inequal.

                                                                                                                                                                              Returns whether this Field is a file upload field; if it returns true, forms will use special techniques for submitti...

                                                                                                                                                                              Returns whether this Field is a file upload field; if it returns true, forms will use special techniques for submitting the form via AJAX. See Ext.form.Basic.hasUpload for details. If this returns true, the extractFileInput method must also be implemented to return the corresponding file input element.

                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                              Returns

                                                                                                                                                                              Overrides: Ext.form.field.Field.isFileUpload, Ext.form.field.Base.isFileUpload

                                                                                                                                                                              Method to determine whether this Component is floating. ...

                                                                                                                                                                              Method to determine whether this Component is floating.

                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                              Returns

                                                                                                                                                                              • Boolean

                                                                                                                                                                                the floating state of this component.

                                                                                                                                                                              ...

                                                                                                                                                                              Available since: 4.1.0

                                                                                                                                                                              Fires

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

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

                                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                                Returns

                                                                                                                                                                                • Boolean

                                                                                                                                                                                  the hidden state of this Component.

                                                                                                                                                                                ...

                                                                                                                                                                                Available since: Ext JS 4.2.0

                                                                                                                                                                                Fires

                                                                                                                                                                                  Determines whether this Component is the root of a layout. ...

                                                                                                                                                                                  Determines whether this Component is the root of a layout. This returns true if this component can run its layout without assistance from or impact on its owner. If this component cannot run its layout given these restrictions, false is returned and its owner will be considered as the next candidate for the layout root.

                                                                                                                                                                                  Setting the _isLayoutRoot property to true causes this method to always return true. This may be useful when updating a layout of a Container which shrink wraps content, and you know that it will not change size, and so can safely be the topmost participant in the layout run.

                                                                                                                                                                                  Available since: 4.1.0

                                                                                                                                                                                  Returns true if layout is suspended for this component. ...

                                                                                                                                                                                  Returns true if layout is suspended for this component. This can come from direct suspension of this component's layout activity (Ext.Container.suspendLayout) or if one of this component's containers is suspended.

                                                                                                                                                                                  Available since: 4.1.0

                                                                                                                                                                                  Returns

                                                                                                                                                                                  • Boolean

                                                                                                                                                                                    true layout of this component is suspended.

                                                                                                                                                                                  Returns true if this component's local coordinate system is rtl. ...

                                                                                                                                                                                  Returns true if this component's local coordinate system is rtl. For normal components this equates to the value of isParentRtl(). Floaters are a bit different because a floater's element can be a childNode of something other than its parent component's element. For floaters we have to read the dom to see if the component's element's parentNode has a css direction value of "rtl".

                                                                                                                                                                                  Defined in override Ext.rtl.AbstractComponent.

                                                                                                                                                                                  Available since: Ext JS 4.2.0

                                                                                                                                                                                  Returns

                                                                                                                                                                                  Fires

                                                                                                                                                                                    Defined in override Ext.rtl.AbstractComponent. ...

                                                                                                                                                                                    Defined in override Ext.rtl.AbstractComponent.

                                                                                                                                                                                    Available since: Ext JS 4.2.0

                                                                                                                                                                                    Fires

                                                                                                                                                                                      Returns true if this component's parent container is rtl. ...

                                                                                                                                                                                      Returns true if this component's parent container is rtl. Used by rtl positioning methods to determine if the component should be positioned using a right-to-left coordinate system.

                                                                                                                                                                                      Defined in override Ext.rtl.AbstractComponent.

                                                                                                                                                                                      Available since: Ext JS 4.2.0

                                                                                                                                                                                      Returns

                                                                                                                                                                                      Fires

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

                                                                                                                                                                                        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.

                                                                                                                                                                                        Available since: 1.1.0

                                                                                                                                                                                        Returns

                                                                                                                                                                                        • Boolean

                                                                                                                                                                                          True if the value is valid, else false

                                                                                                                                                                                        Fires

                                                                                                                                                                                          Overrides: Ext.form.field.Field.isValid, Ext.form.field.Base.isValid

                                                                                                                                                                                          Returns true if this component is visible. ...

                                                                                                                                                                                          Returns true if this component is visible.

                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                          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.

                                                                                                                                                                                            Defaults to: false

                                                                                                                                                                                          Returns

                                                                                                                                                                                          • Boolean

                                                                                                                                                                                            true if this component is visible, false otherwise.

                                                                                                                                                                                          Fires

                                                                                                                                                                                            Tests whether or not this Component is of a specific xtype. ...

                                                                                                                                                                                            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.field.Text();
                                                                                                                                                                                            var isText = t.isXType('textfield');        // true
                                                                                                                                                                                            var isBoxSubclass = t.isXType('field');       // true, descended from Ext.form.field.Base
                                                                                                                                                                                            var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.form.field.Base instance
                                                                                                                                                                                            

                                                                                                                                                                                            Available since: 2.3.0

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            • xtype : String

                                                                                                                                                                                              The xtype to check for this Component

                                                                                                                                                                                            • shallow : Boolean (optional)

                                                                                                                                                                                              true to check whether this Component is directly of the specified xtype, false to check whether this Component is descended from the xtype.

                                                                                                                                                                                              Defaults to: false

                                                                                                                                                                                            Returns

                                                                                                                                                                                            • Boolean

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

                                                                                                                                                                                            ...

                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            Display one or more error messages associated with this field, using msgTarget to determine how to display the messag...

                                                                                                                                                                                            Display one or more error messages associated with this field, using msgTarget to determine how to display the messages and applying invalidCls to the field's UI element.

                                                                                                                                                                                            Note: this method does not cause the Field's validate or isValid methods 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.

                                                                                                                                                                                            Available since: 1.1.0

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            • errors : String/String[]

                                                                                                                                                                                              The validation message(s) to display.

                                                                                                                                                                                            Fires

                                                                                                                                                                                              Overrides: Ext.form.field.Field.markInvalid, Ext.form.field.Base.markInvalid

                                                                                                                                                                                              ...

                                                                                                                                                                                              Available since: 4.1.0

                                                                                                                                                                                              Fires

                                                                                                                                                                                                ( item, ename, [fn], [scope], [options] ) : Object
                                                                                                                                                                                                Shorthand for addManagedListener. ...

                                                                                                                                                                                                Shorthand for addManagedListener.

                                                                                                                                                                                                Available since: 4.0.2

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                • item : Ext.util.Observable/Ext.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.

                                                                                                                                                                                                • options : Object (optional)

                                                                                                                                                                                                  If the ename parameter was an event name, this is the addListener options.

                                                                                                                                                                                                Returns

                                                                                                                                                                                                • Object

                                                                                                                                                                                                  Only when the destroyable option is specified.

                                                                                                                                                                                                  A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                                                                                                                                                                                  this.btnListeners =  = myButton.mon({
                                                                                                                                                                                                      destroyable: true
                                                                                                                                                                                                      mouseover:   function() { console.log('mouseover'); },
                                                                                                                                                                                                      mouseout:    function() { console.log('mouseout'); },
                                                                                                                                                                                                      click:       function() { console.log('click'); }
                                                                                                                                                                                                  });
                                                                                                                                                                                                  

                                                                                                                                                                                                  And when those listeners need to be removed:

                                                                                                                                                                                                  Ext.destroy(this.btnListeners);
                                                                                                                                                                                                  

                                                                                                                                                                                                  or

                                                                                                                                                                                                  this.btnListeners.destroy();
                                                                                                                                                                                                  
                                                                                                                                                                                                ( direction, distance, [animate] )
                                                                                                                                                                                                Move the element relative to its current position. ...

                                                                                                                                                                                                Move the element relative to its current position.

                                                                                                                                                                                                Available since: Ext JS 4.2.0

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                • direction : String

                                                                                                                                                                                                  Possible values are:

                                                                                                                                                                                                  • "l" (or "left")
                                                                                                                                                                                                  • "r" (or "right")
                                                                                                                                                                                                  • "t" (or "top", or "up")
                                                                                                                                                                                                  • "b" (or "bottom", or "down")
                                                                                                                                                                                                • distance : Number

                                                                                                                                                                                                  How far to move the element in pixels

                                                                                                                                                                                                • animate : Boolean/Object (optional)

                                                                                                                                                                                                  true for the default animation or a standard Element animation config object

                                                                                                                                                                                                Fires

                                                                                                                                                                                                  ( item, ename, [fn], [scope] )
                                                                                                                                                                                                  Shorthand for removeManagedListener. ...

                                                                                                                                                                                                  Shorthand for removeManagedListener.

                                                                                                                                                                                                  Available since: 4.0.2

                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                  • item : Ext.util.Observable/Ext.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 the next node in the Component tree in tree traversal order. ...

                                                                                                                                                                                                  Returns the next node in the Component tree in tree traversal order.

                                                                                                                                                                                                  Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree to attempt to find a match. Contrast with nextSibling.

                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                  Returns

                                                                                                                                                                                                  • Ext.Component

                                                                                                                                                                                                    The next node (or the next node which matches the selector). Returns null if there is no matching node.

                                                                                                                                                                                                  Fires

                                                                                                                                                                                                    Returns the next sibling of this Component. ...

                                                                                                                                                                                                    Returns the next sibling of this Component.

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

                                                                                                                                                                                                    May also be referred to as next()

                                                                                                                                                                                                    Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with nextNode

                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    Returns

                                                                                                                                                                                                    • Ext.Component

                                                                                                                                                                                                      The next sibling (or the next sibling which matches the selector). Returns null if there is no matching sibling.

                                                                                                                                                                                                    ( eventName, [fn], [scope], [options] ) : Object
                                                                                                                                                                                                    Shorthand for addListener. ...

                                                                                                                                                                                                    Shorthand for addListener.

                                                                                                                                                                                                    Available since: 1.1.0

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    • eventName : String/Object

                                                                                                                                                                                                      The name of the event to listen for. May also be an object who's property names are event names.

                                                                                                                                                                                                    • fn : Function (optional)

                                                                                                                                                                                                      The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to fireEvent plus the options parameter described below.

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

                                                                                                                                                                                                      Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

                                                                                                                                                                                                      This object 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 : Ext.util.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'
                                                                                                                                                                                                              }
                                                                                                                                                                                                          });
                                                                                                                                                                                                        
                                                                                                                                                                                                      • destroyable : Boolean (optional)

                                                                                                                                                                                                        When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

                                                                                                                                                                                                        Defaults to: false

                                                                                                                                                                                                      • priority : Number (optional)

                                                                                                                                                                                                        An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

                                                                                                                                                                                                        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
                                                                                                                                                                                                        });
                                                                                                                                                                                                        

                                                                                                                                                                                                    Returns

                                                                                                                                                                                                    • Object

                                                                                                                                                                                                      Only when the destroyable option is specified.

                                                                                                                                                                                                      A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                                                                                                                                                                                      this.btnListeners =  = myButton.on({
                                                                                                                                                                                                          destroyable: true
                                                                                                                                                                                                          mouseover:   function() { console.log('mouseover'); },
                                                                                                                                                                                                          mouseout:    function() { console.log('mouseout'); },
                                                                                                                                                                                                          click:       function() { console.log('click'); }
                                                                                                                                                                                                      });
                                                                                                                                                                                                      

                                                                                                                                                                                                      And when those listeners need to be removed:

                                                                                                                                                                                                      Ext.destroy(this.btnListeners);
                                                                                                                                                                                                      

                                                                                                                                                                                                      or

                                                                                                                                                                                                      this.btnListeners.destroy();
                                                                                                                                                                                                      
                                                                                                                                                                                                    Method to manage awareness of when components are added to their respective Container, firing an added event. ...

                                                                                                                                                                                                    Method to manage awareness of when components are added to their respective Container, firing an added event. References are established at add time rather than at render time.

                                                                                                                                                                                                    Allows addition of behavior when a Component is added to a Container. At this stage, the Component is in the parent Container's collection of child items. After calling the superclass's onAdded, the ownerCt reference will be present, and if configured with a ref, the refOwner will be set.

                                                                                                                                                                                                    Available since: 3.4.0

                                                                                                                                                                                                    This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                    Fires

                                                                                                                                                                                                    Overrides: Ext.AbstractComponent.onAdded, Ext.Component.onAdded

                                                                                                                                                                                                    ...

                                                                                                                                                                                                    Available since: 4.1.0

                                                                                                                                                                                                    Fires

                                                                                                                                                                                                      private ...

                                                                                                                                                                                                      private

                                                                                                                                                                                                      Available since: 4.1.0

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      Fires

                                                                                                                                                                                                      Ext.form.field.Checkbox
                                                                                                                                                                                                      view source
                                                                                                                                                                                                      ( e )private
                                                                                                                                                                                                      Handle click on the checkbox button ...

                                                                                                                                                                                                      Handle click on the checkbox button

                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                      Fires

                                                                                                                                                                                                        ...

                                                                                                                                                                                                        Available since: 4.1.0

                                                                                                                                                                                                        Fires

                                                                                                                                                                                                          Overrides: Ext.AbstractComponent.onBoxReady

                                                                                                                                                                                                          Ext.form.field.Checkbox
                                                                                                                                                                                                          view source
                                                                                                                                                                                                          ( newVal, oldVal )private
                                                                                                                                                                                                          Called when the checkbox's checked state changes. ...

                                                                                                                                                                                                          Called when the checkbox's checked state changes. Invokes the handler callback function if specified.

                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                          Fires

                                                                                                                                                                                                            Overrides: Ext.form.field.Field.onChange

                                                                                                                                                                                                            ( names, callback, scope )private
                                                                                                                                                                                                            ...

                                                                                                                                                                                                            Available since: 4.1.0

                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                            Allows addition of behavior to the destroy operation. ...

                                                                                                                                                                                                            Allows addition of behavior to the destroy operation. After calling the superclass's onDestroy, the Component will be destroyed.

                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                            This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                            Fires

                                                                                                                                                                                                              Overrides: Ext.AbstractComponent.onDestroy, Ext.Component.onDestroy

                                                                                                                                                                                                              Called when the field's dirty state changes. ...

                                                                                                                                                                                                              Called when the field's dirty state changes. Adds/removes the dirtyCls on the main element.

                                                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                              Overrides: Ext.form.field.Field.onDirtyChange

                                                                                                                                                                                                              private ...

                                                                                                                                                                                                              private

                                                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                                                              This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                Overrides: Ext.AbstractComponent.onDisable

                                                                                                                                                                                                                Ext.form.field.Checkbox
                                                                                                                                                                                                                view source
                                                                                                                                                                                                                ( )protectedtemplate
                                                                                                                                                                                                                private ...

                                                                                                                                                                                                                private

                                                                                                                                                                                                                Available since: 2.3.0

                                                                                                                                                                                                                This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                  Overrides: Ext.AbstractComponent.onEnable, Ext.form.field.Base.onEnable

                                                                                                                                                                                                                  ...

                                                                                                                                                                                                                  Available since: 4.1.0

                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                  • move
                                                                                                                                                                                                                  private ...

                                                                                                                                                                                                                  private

                                                                                                                                                                                                                  Available since: 4.1.0

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                  ( [animateTarget], [callback], [scope] )protectedtemplate
                                                                                                                                                                                                                  Possibly animates down to a target element. ...

                                                                                                                                                                                                                  Possibly animates down to a target element.

                                                                                                                                                                                                                  Allows addition of behavior to the hide operation. After calling the superclass’s onHide, the Component will be hidden.

                                                                                                                                                                                                                  Gets passed the same parameters as hide.

                                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                                  This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                  Overrides: Ext.AbstractComponent.onHide, Ext.Component.onHide

                                                                                                                                                                                                                  Listen for TAB events and wrap round if tabbing of either end of the Floater ...

                                                                                                                                                                                                                  Listen for TAB events and wrap round if tabbing of either end of the Floater

                                                                                                                                                                                                                  Available since: 4.1.3

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  Mousedown brings to front, and programatically grabs focus unless the mousedown was on a focusable element ...

                                                                                                                                                                                                                  Mousedown brings to front, and programatically grabs focus unless the mousedown was on a focusable element

                                                                                                                                                                                                                  Available since: Ext JS 4.2.0

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                    Called after the component is moved, this method is empty by default but can be implemented by any subclass that need...

                                                                                                                                                                                                                    Called after the component is moved, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a move occurs.

                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                    This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    • x : Number

                                                                                                                                                                                                                      The new x position.

                                                                                                                                                                                                                    • y : Number

                                                                                                                                                                                                                      The new y position.

                                                                                                                                                                                                                    ( destroying )protectedtemplate
                                                                                                                                                                                                                    Method to manage awareness of when components are removed from their respective Container, firing a removed event. ...

                                                                                                                                                                                                                    Method to manage awareness of when components are removed from their respective Container, firing a removed event. References are properly cleaned up after removing a component from its owning container.

                                                                                                                                                                                                                    Allows addition of behavior when a Component is removed from its parent Container. At this stage, the Component has been removed from its parent Container's collection of child items, but has not been destroyed (It will be destroyed if the parent Container's autoDestroy is true, or if the remove call was passed a truthy second parameter). After calling the superclass's onRemoved, the ownerCt and the refOwner will not be present.

                                                                                                                                                                                                                    Available since: 3.4.0

                                                                                                                                                                                                                    This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                    • destroying : Boolean

                                                                                                                                                                                                                      Will be passed as true if the Container performing the remove operation will delete this Component upon remove.

                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                    private ...

                                                                                                                                                                                                                    private

                                                                                                                                                                                                                    Available since: 2.3.0

                                                                                                                                                                                                                    This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                      Overrides: Ext.util.Renderable.onRender

                                                                                                                                                                                                                      ( width, height, oldWidth, oldHeight )protectedtemplate
                                                                                                                                                                                                                      Allows addition of behavior to the resize operation. ...

                                                                                                                                                                                                                      Allows addition of behavior to the resize operation.

                                                                                                                                                                                                                      Called when Ext.resizer.Resizer#drag event is fired.

                                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                                      This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                      ( [animateTarget], [callback], [scope] )protectedtemplate
                                                                                                                                                                                                                      Allows addition of behavior to the show operation. ...

                                                                                                                                                                                                                      Allows addition of behavior to the show operation. After calling the superclass's onShow, the Component will be visible.

                                                                                                                                                                                                                      Override in subclasses where more complex behaviour is needed.

                                                                                                                                                                                                                      Gets passed the same parameters as show.

                                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                                      This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                      Overrides: Ext.AbstractComponent.onShow, Ext.Component.onShow

                                                                                                                                                                                                                      ( [callback], [scope] )protectedtemplate
                                                                                                                                                                                                                      Invoked after the afterShow method is complete. ...

                                                                                                                                                                                                                      Invoked after the afterShow method is complete.

                                                                                                                                                                                                                      Gets passed the same callback and scope parameters that afterShow received.

                                                                                                                                                                                                                      Available since: 4.0.4

                                                                                                                                                                                                                      This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                      ...

                                                                                                                                                                                                                      Available since: 4.1.1

                                                                                                                                                                                                                      This method is called when any of the stateEvents are fired. ...

                                                                                                                                                                                                                      This method is called when any of the stateEvents are fired.

                                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                      Overridden in Ext.rtl.AbstractComponent. ...

                                                                                                                                                                                                                      Overridden in Ext.rtl.AbstractComponent.

                                                                                                                                                                                                                      Available since: Ext JS 4.2.0

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      Template method to do any post-blur processing. ...

                                                                                                                                                                                                                      Template method to do any post-blur processing.

                                                                                                                                                                                                                      Available since: 4.1.0

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      Prepares a given class for observable instances. ...

                                                                                                                                                                                                                      Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

                                                                                                                                                                                                                      Available since: 4.1.2

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      • T : Function

                                                                                                                                                                                                                        The class constructor to prepare.

                                                                                                                                                                                                                      Returns the previous node in the Component tree in tree traversal order. ...

                                                                                                                                                                                                                      Returns the previous node in the Component tree in tree traversal order.

                                                                                                                                                                                                                      Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree in reverse order to attempt to find a match. Contrast with previousSibling.

                                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                      • Ext.Component

                                                                                                                                                                                                                        The previous node (or the previous node which matches the selector). Returns null if there is no matching node.

                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                        Returns the previous sibling of this Component. ...

                                                                                                                                                                                                                        Returns the previous sibling of this Component.

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

                                                                                                                                                                                                                        May also be referred to as prev()

                                                                                                                                                                                                                        Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with previousNode

                                                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                        • Ext.Component

                                                                                                                                                                                                                          The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.

                                                                                                                                                                                                                        Performs any necessary manipulation of a raw field value to prepare it for conversion and/or validation, for instance...

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

                                                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                        • value : Object

                                                                                                                                                                                                                          The unprocessed string value

                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                        • Object

                                                                                                                                                                                                                          The processed string value

                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                        Available since: 4.1.0

                                                                                                                                                                                                                        Parameters

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

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

                                                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                        Called by Component#doAutoRender Register a Container configured floating: true with this Component's ZIndexManager. ...

                                                                                                                                                                                                                        Called by Component#doAutoRender

                                                                                                                                                                                                                        Register a Container configured floating: true with this Component's ZIndexManager.

                                                                                                                                                                                                                        Components added in this way will not participate in any layout, but will be rendered upon first show in the way that Windows are.

                                                                                                                                                                                                                        Available since: 4.0.5

                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                        Available since: 4.1.0

                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                          For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

                                                                                                                                                                                                                          this.relayEvents(this.getStore(), ['load']);
                                                                                                                                                                                                                          

                                                                                                                                                                                                                          The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.

                                                                                                                                                                                                                          Available since: 2.3.0

                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                          • origin : Object

                                                                                                                                                                                                                            The Observable whose events this object is to relay.

                                                                                                                                                                                                                          • events : String[]

                                                                                                                                                                                                                            Array of event names to relay.

                                                                                                                                                                                                                          • prefix : String (optional)

                                                                                                                                                                                                                            A common prefix to prepend to the event names. For example:

                                                                                                                                                                                                                            this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                                                                                                                                                                                            

                                                                                                                                                                                                                            Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                          • Object

                                                                                                                                                                                                                            A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

                                                                                                                                                                                                                            this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                                                                                                                                                                                            

                                                                                                                                                                                                                            Can be undone by calling

                                                                                                                                                                                                                            Ext.destroy(this.storeRelayers);
                                                                                                                                                                                                                            

                                                                                                                                                                                                                            or

                                                                                                                                                                                                                            this.store.relayers.destroy();
                                                                                                                                                                                                                            

                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                            Remove any anchor to this element. ...

                                                                                                                                                                                                                            Remove any anchor to this element. See anchorTo.

                                                                                                                                                                                                                            Available since: Ext JS 4.2.0

                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                              Removes items in the childEls array based on the return value of a supplied test function. ...

                                                                                                                                                                                                                              Removes items in the childEls array based on the return value of a supplied test function. The function is called with a entry in childEls and if the test function return true, that entry is removed. If false, that entry is kept.

                                                                                                                                                                                                                              Available since: 4.1.0

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                                ...

                                                                                                                                                                                                                                Available since: 2.3.0

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

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

                                                                                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                                Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all elements of thi...

                                                                                                                                                                                                                                Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all elements of this component.

                                                                                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                • cls : String/String[]

                                                                                                                                                                                                                                  A string or an array of strings to remove to the uiCls.

                                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                                  Removes an event handler. ...

                                                                                                                                                                                                                                  Removes an event handler.

                                                                                                                                                                                                                                  Available since: 1.1.0

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  • eventName : String

                                                                                                                                                                                                                                    The type of event the handler was associated with.

                                                                                                                                                                                                                                  • fn : 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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                    Removes listeners that were added by the mon method. ...

                                                                                                                                                                                                                                    Removes listeners that were added by the mon method.

                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • item : Ext.util.Observable/Ext.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.

                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                      inherit docs ...

                                                                                                                                                                                                                                      inherit docs

                                                                                                                                                                                                                                      Available since: 4.0.1

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      • isClear : Boolean

                                                                                                                                                                                                                                        True if this is being called during a clear

                                                                                                                                                                                                                                      • managedListener : Object

                                                                                                                                                                                                                                        The managed listener item See removeManagedListener for other args

                                                                                                                                                                                                                                      Overrides: Ext.util.Observable.removeManagedListenerItem

                                                                                                                                                                                                                                      ...

                                                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                                                      ...

                                                                                                                                                                                                                                      Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      Method which removes a specified UI + uiCls from the components element. ...

                                                                                                                                                                                                                                      Method which removes a specified UI + uiCls from the components element. The cls which is added to the element will be: this.baseCls + '-' + ui.

                                                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      • ui : String

                                                                                                                                                                                                                                        The UI to add to the element.

                                                                                                                                                                                                                                      Method which removes a specified UI from the components element. ...

                                                                                                                                                                                                                                      Method which removes a specified UI from the components element.

                                                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                                        ( [container], [position] )
                                                                                                                                                                                                                                        Renders the Component into the passed HTML element. ...

                                                                                                                                                                                                                                        Renders the Component into the passed HTML element.

                                                                                                                                                                                                                                        If you are using a Container object to house this Component, then do not use the render method.

                                                                                                                                                                                                                                        A Container's child Components are rendered by that Container's layout manager when the Container is first rendered.

                                                                                                                                                                                                                                        If the Container is already rendered when a new child Component is added, you may need to call the Container's doLayout to refresh the view which causes any unrendered child Components to be rendered. This is required so that you can add multiple child components if needed while only refreshing the layout once.

                                                                                                                                                                                                                                        When creating complex UIs, it is important to remember that sizing and positioning of child items is the responsibility of the Container's layout manager. If you expect child items to be sized in response to user interactions, you must configure the Container with a layout manager which creates and manages the type of layout you have in mind.

                                                                                                                                                                                                                                        Omitting the Container's layout config means that a basic layout manager is used which does nothing but render child components sequentially into the Container. No sizing or positioning will be performed in this situation.

                                                                                                                                                                                                                                        Available since: 4.1.0

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        • container : Ext.Element/HTMLElement/String (optional)

                                                                                                                                                                                                                                          The element this Component should be rendered into. If it is being created from existing markup, this should be omitted.

                                                                                                                                                                                                                                        • position : String/Number (optional)

                                                                                                                                                                                                                                          The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container)

                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                        • afterrender
                                                                                                                                                                                                                                        • beforerender
                                                                                                                                                                                                                                        • render
                                                                                                                                                                                                                                        Overrides the method from the Ext.form.Labelable mixin to also add the invalidCls to the inputEl, as that is required...

                                                                                                                                                                                                                                        Overrides the method from the Ext.form.Labelable mixin to also add the invalidCls to the inputEl, as that is required for proper styling in IE with nested fields (due to lack of child selector)

                                                                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                          Overrides: Ext.form.Labelable.renderActiveError

                                                                                                                                                                                                                                          Resets the current field value to the originally loaded value and clears any validation messages. ...

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

                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                                          Ext.form.field.Checkbox
                                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                                          ( fromBoxInGroup )
                                                                                                                                                                                                                                          Resets the field's originalValue property so it matches the current value. ...

                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                                            Overrides: Ext.form.field.Field.resetOriginalValue

                                                                                                                                                                                                                                            Resumes firing of the named event(s). ...

                                                                                                                                                                                                                                            Resumes firing of the named event(s).

                                                                                                                                                                                                                                            After calling this method to resume events, the events will fire when requested to fire.

                                                                                                                                                                                                                                            Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

                                                                                                                                                                                                                                            Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            • eventName : String...

                                                                                                                                                                                                                                              Multiple event names to resume.

                                                                                                                                                                                                                                            Resumes firing events (see suspendEvents). ...

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

                                                                                                                                                                                                                                            Available since: 2.3.0

                                                                                                                                                                                                                                            ...

                                                                                                                                                                                                                                            Available since: 4.1.0

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                                              ( propName, state, [stateName] ) : Boolean
                                                                                                                                                                                                                                              Conditionally saves a single property from this object to the given state object. ...

                                                                                                                                                                                                                                              Conditionally saves a single property from this object to the given state object. The idea is to only save state which has changed from the initial state so that current software settings do not override future software settings. Only those values that are user-changed state should be saved.

                                                                                                                                                                                                                                              Available since: 4.0.4

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • propName : String

                                                                                                                                                                                                                                                The name of the property to save.

                                                                                                                                                                                                                                              • state : Object

                                                                                                                                                                                                                                                The state object in to which to save the property.

                                                                                                                                                                                                                                              • stateName : String (optional)

                                                                                                                                                                                                                                                The name to use for the property in state.

                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                              • Boolean

                                                                                                                                                                                                                                                True if the property was saved, false if not.

                                                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                                                Gathers additional named properties of the instance and adds their current values to the passed state object. ...

                                                                                                                                                                                                                                                Gathers additional named properties of the instance and adds their current values to the passed state object.

                                                                                                                                                                                                                                                Available since: 4.0.4

                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                • propNames : String/String[]

                                                                                                                                                                                                                                                  The name (or array of names) of the property to save.

                                                                                                                                                                                                                                                • state : Object

                                                                                                                                                                                                                                                  The state object in to which to save the property values.

                                                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                                                  Saves the state of the object to the persistence store. ...

                                                                                                                                                                                                                                                  Saves the state of the object to the persistence store.

                                                                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                                  ( deltaX, deltaY, animate )
                                                                                                                                                                                                                                                  Scrolls this Component's target element by the passed delta values, optionally animating. ...

                                                                                                                                                                                                                                                  Scrolls this Component's target element by the passed delta values, optionally animating.

                                                                                                                                                                                                                                                  All of the following are equivalent:

                                                                                                                                                                                                                                                   comp.scrollBy(10, 10, true);
                                                                                                                                                                                                                                                   comp.scrollBy([10, 10], true);
                                                                                                                                                                                                                                                   comp.scrollBy({ x: 10, y: 10 }, true);
                                                                                                                                                                                                                                                  

                                                                                                                                                                                                                                                  Available since: 4.1.0

                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                  • deltaX : Number/Number[]/Object

                                                                                                                                                                                                                                                    Either the x delta, an Array specifying x and y deltas or an object with "x" and "y" properties.

                                                                                                                                                                                                                                                  • deltaY : Number/Boolean/Object

                                                                                                                                                                                                                                                    Either the y delta, or an animate flag or config object.

                                                                                                                                                                                                                                                  • animate : Boolean/Object

                                                                                                                                                                                                                                                    Animate flag/config object if the delta values were passed separately.

                                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                                    Ensures that all effects queued after sequenceFx is called on this object are run in sequence. ...

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

                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                    ( [active], [newActive] )
                                                                                                                                                                                                                                                    This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been moved to th...

                                                                                                                                                                                                                                                    This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.

                                                                                                                                                                                                                                                    If a Window is superceded by another Window, deactivating it hides its shadow.

                                                                                                                                                                                                                                                    This method also fires the activate or deactivate event depending on which action occurred.

                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                    • active : Boolean (optional)

                                                                                                                                                                                                                                                      True to activate the Component, false to deactivate it.

                                                                                                                                                                                                                                                      Defaults to: false

                                                                                                                                                                                                                                                    • newActive : Ext.Component (optional)

                                                                                                                                                                                                                                                      The newly active Component which is taking over topmost zIndex position.

                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                    • activate
                                                                                                                                                                                                                                                    • deactivate
                                                                                                                                                                                                                                                    Sets the active error message to the given string. ...

                                                                                                                                                                                                                                                    Sets the active error message to the given string. This replaces the entire error message contents with the given string. Also see setActiveErrors which accepts an Array of messages and formats them according to the activeErrorsTpl. Note that this only updates the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call markInvalid instead.

                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                    • msg : String

                                                                                                                                                                                                                                                      The error message

                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                      Set the active error message to an Array of error messages. ...

                                                                                                                                                                                                                                                      Set the active error message to an Array of error messages. The messages are formatted into a single message string using the activeErrorsTpl. Also see setActiveError which allows setting the entire error contents with a single string. Note that this only updates the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call markInvalid instead.

                                                                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • errors : String[]

                                                                                                                                                                                                                                                        The error messages

                                                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                                                        Sets the overflow on the content element of the component. ...

                                                                                                                                                                                                                                                        Sets the overflow on the content element of the component.

                                                                                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        • scroll : Boolean

                                                                                                                                                                                                                                                          True to allow the Component to auto scroll.

                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                          • border : String/Number

                                                                                                                                                                                                                                                            The border, see border. If a falsey value is passed the border will be removed.

                                                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                                                            Sets the element's box. ...

                                                                                                                                                                                                                                                            Sets the element's box. If animate is true then x, y, width, and height will be animated concurrently.

                                                                                                                                                                                                                                                            Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • box : Object

                                                                                                                                                                                                                                                              The box to fill {x, y, width, height}

                                                                                                                                                                                                                                                            • animate : Boolean/Object (optional)

                                                                                                                                                                                                                                                              true for the default animation or a standard Element animation config object

                                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                                                            • move
                                                                                                                                                                                                                                                            Ext.form.field.Checkbox
                                                                                                                                                                                                                                                            view source
                                                                                                                                                                                                                                                            ( boxLabel )
                                                                                                                                                                                                                                                            Sets the boxLabel for this checkbox. ...

                                                                                                                                                                                                                                                            Sets the boxLabel for this checkbox.

                                                                                                                                                                                                                                                            Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • boxLabel : String

                                                                                                                                                                                                                                                              The new label

                                                                                                                                                                                                                                                            ...

                                                                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            ( config, applyIfNotSet ) : Ext.Basechainableprivate
                                                                                                                                                                                                                                                            ...

                                                                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                                            Enable or disable the component. ...

                                                                                                                                                                                                                                                            Enable or disable the component.

                                                                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • disabled : Boolean

                                                                                                                                                                                                                                                              true to disable.

                                                                                                                                                                                                                                                            Sets the dock position of this component in its parent panel. ...

                                                                                                                                                                                                                                                            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)

                                                                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • dock : Object

                                                                                                                                                                                                                                                              The dock position.

                                                                                                                                                                                                                                                            • layoutParent : Boolean (optional)

                                                                                                                                                                                                                                                              true to re-layout parent.

                                                                                                                                                                                                                                                              Defaults to: false

                                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                                            Set the current error state ...

                                                                                                                                                                                                                                                            Set the current error state

                                                                                                                                                                                                                                                            Available since: 4.1.2

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • error : String

                                                                                                                                                                                                                                                              The error message to set

                                                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                                                              Applies a set of default configuration values to this Labelable instance. ...

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              • defaults : Object

                                                                                                                                                                                                                                                                The defaults to apply to the object.

                                                                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                                                                Set the label of this field. ...

                                                                                                                                                                                                                                                                Set the label of this field.

                                                                                                                                                                                                                                                                Available since: 4.1.0

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                • label : String

                                                                                                                                                                                                                                                                  The new label. The labelSeparator will be automatically appended to the label string.

                                                                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                                                                  Set the CSS style of the field input element. ...

                                                                                                                                                                                                                                                                  Set the CSS style of the field input element.

                                                                                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                  ...

                                                                                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                  Sets the height of the component. ...

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

                                                                                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                  • height : Number

                                                                                                                                                                                                                                                                    The new height to set. This may be one of:

                                                                                                                                                                                                                                                                    • A Number specifying the new height in the Element's Ext.Element.defaultUnits (by default, pixels).
                                                                                                                                                                                                                                                                    • A String used to set the CSS height style.
                                                                                                                                                                                                                                                                    • undefined to leave the height unchanged.

                                                                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                                                                  Fires

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

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

                                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • load : Boolean/Object/String

                                                                                                                                                                                                                                                                      True to show the default LoadMask, a config object that will be passed to the LoadMask constructor, or a message String to show. False to hide the current LoadMask.

                                                                                                                                                                                                                                                                    • targetEl : Boolean (optional)

                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                    Overridden in Ext.rtl.AbstractComponent. ...

                                                                                                                                                                                                                                                                    Overridden in Ext.rtl.AbstractComponent.

                                                                                                                                                                                                                                                                    Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                    Overrides: Ext.util.Positionable.setLocalX

                                                                                                                                                                                                                                                                    Overridden in Ext.rtl.AbstractComponent. ...

                                                                                                                                                                                                                                                                    Overridden in Ext.rtl.AbstractComponent.

                                                                                                                                                                                                                                                                    Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                    Overrides: Ext.util.Positionable.setLocalXY

                                                                                                                                                                                                                                                                    Sets the local y coordinate of this element using CSS style. ...

                                                                                                                                                                                                                                                                    Sets the local y coordinate of this element using CSS style. When used on an absolute positioned element this method is symmetrical with getLocalY, but may not be symmetrical when used on a relatively positioned element.

                                                                                                                                                                                                                                                                    Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                    Overrides: Ext.util.Positionable.setLocalY

                                                                                                                                                                                                                                                                    Sets the margin on the target element. ...

                                                                                                                                                                                                                                                                    Sets the margin on the target element.

                                                                                                                                                                                                                                                                    Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                                      ( overflowX, overflowY ) : Ext.Componentchainable
                                                                                                                                                                                                                                                                      Sets the overflow x/y on the content element of the component. ...

                                                                                                                                                                                                                                                                      Sets the overflow x/y on the content element of the component. The x/y overflow values can be any valid CSS overflow (e.g., 'auto' or 'scroll'). By default, the value is 'hidden'. Passing null for one of the values will erase the inline style. Passing undefined will preserve the current value.

                                                                                                                                                                                                                                                                      Available since: 4.1.0

                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                      • overflowX : String

                                                                                                                                                                                                                                                                        The overflow-x value.

                                                                                                                                                                                                                                                                      • overflowY : String

                                                                                                                                                                                                                                                                        The overflow-y value.

                                                                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                                                                        Sets the page XY position of the component. ...

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

                                                                                                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • x : Number/Number[]

                                                                                                                                                                                                                                                                          The new x position or an array of [x,y].

                                                                                                                                                                                                                                                                        • y : Number (optional)

                                                                                                                                                                                                                                                                          The new y position.

                                                                                                                                                                                                                                                                        • animate : Boolean/Object (optional)

                                                                                                                                                                                                                                                                          True to animate the Component into its new position. You may also pass an animation configuration.

                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                                                        ( x, [y], [animate] ) : Ext.Componentchainable
                                                                                                                                                                                                                                                                        Sets the left and top of the component. ...

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

                                                                                                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • x : Number/Number[]/Object

                                                                                                                                                                                                                                                                          The new left, an array of [x,y], or animation config object containing x and y properties.

                                                                                                                                                                                                                                                                        • y : Number (optional)

                                                                                                                                                                                                                                                                          The new top.

                                                                                                                                                                                                                                                                        • animate : Boolean/Object (optional)

                                                                                                                                                                                                                                                                          If true, the Component is animated into its new position. You may also pass an animation configuration.

                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                                                        Ext.form.field.Checkbox
                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                        ( value ) : Boolean
                                                                                                                                                                                                                                                                        Sets the checked state of the checkbox. ...

                                                                                                                                                                                                                                                                        Sets the checked state of the checkbox.

                                                                                                                                                                                                                                                                        Available since: 1.1.0

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • value : Boolean/String/Number

                                                                                                                                                                                                                                                                          The following values will check the checkbox: true, 'true', '1', 1, or 'on', as well as a String that matches the inputValue. Any other value will uncheck the checkbox.

                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                        • Boolean

                                                                                                                                                                                                                                                                          the new checked state of the checkbox

                                                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                                                          Overrides: Ext.form.field.Base.setRawValue

                                                                                                                                                                                                                                                                          Ext.form.field.Checkbox
                                                                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                                                                          ( readOnly )
                                                                                                                                                                                                                                                                          Sets the read only state of this field. ...

                                                                                                                                                                                                                                                                          Sets the read only state of this field.

                                                                                                                                                                                                                                                                          Available since: 3.4.0

                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                                                                          Overrides: Ext.form.field.Base.setReadOnly

                                                                                                                                                                                                                                                                          Sets the element's position and size to the specified region. ...

                                                                                                                                                                                                                                                                          Sets the element's position and size to the specified region. If animation is true then width, height, x and y will be animated concurrently.

                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                          • region : Ext.util.Region

                                                                                                                                                                                                                                                                            The region to fill

                                                                                                                                                                                                                                                                          • animate : Boolean/Object (optional)

                                                                                                                                                                                                                                                                            true for the default animation or a standard Element animation config object

                                                                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                                                                          • move
                                                                                                                                                                                                                                                                          Sets the width and height of this Component. ...

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

                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                          • width : Number/String/Object

                                                                                                                                                                                                                                                                            The new width to set. This may be one of:

                                                                                                                                                                                                                                                                            • A Number specifying the new width in the Element's Ext.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 : Number/String

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

                                                                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                                                                            Sets the UI for the component. ...

                                                                                                                                                                                                                                                                            Sets the UI for the component. This will remove any existing UIs on the component. It will also loop through any uiCls set on the component and rename them so they include the new UI.

                                                                                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                            • ui : String

                                                                                                                                                                                                                                                                              The new UI for the component.

                                                                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                                                                              Ext.form.field.Checkbox
                                                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                                                              ( checked ) : Ext.form.field.Checkboxchainable
                                                                                                                                                                                                                                                                              Sets the checked state of the checkbox, and invokes change detection. ...

                                                                                                                                                                                                                                                                              Sets the checked state of the checkbox, and invokes change detection.

                                                                                                                                                                                                                                                                              Available since: 1.1.0

                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                              • checked : Boolean/String

                                                                                                                                                                                                                                                                                The following values will check the checkbox: true, 'true', '1', or 'on', as well as a String that matches the inputValue. Any other value will uncheck the checkbox.

                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                                                                                Overrides: Ext.form.field.Base.setValue

                                                                                                                                                                                                                                                                                Convenience function to hide or show this component by Boolean. ...

                                                                                                                                                                                                                                                                                Convenience function to hide or show this component by Boolean.

                                                                                                                                                                                                                                                                                Available since: 1.1.0

                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                • visible : Boolean

                                                                                                                                                                                                                                                                                  true to show, false to hide.

                                                                                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                                                                                Sets the width of the component. ...

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

                                                                                                                                                                                                                                                                                Available since: 4.0.0

                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                • width : Number

                                                                                                                                                                                                                                                                                  The new width to setThis may be one of:

                                                                                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                                                                                  Sets the X position of the DOM element based on page coordinates. ...

                                                                                                                                                                                                                                                                                  Sets the X position of the DOM element based on page coordinates.

                                                                                                                                                                                                                                                                                  Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                                                                                  Overrides: Ext.util.Positionable.setX

                                                                                                                                                                                                                                                                                  Sets the position of the DOM element in page coordinates. ...

                                                                                                                                                                                                                                                                                  Sets the position of the DOM element in page coordinates.

                                                                                                                                                                                                                                                                                  Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                                                                                  Overrides: Ext.util.Positionable.setXY

                                                                                                                                                                                                                                                                                  Sets the Y position of the DOM element based on page coordinates. ...

                                                                                                                                                                                                                                                                                  Sets the Y position of the DOM element based on page coordinates.

                                                                                                                                                                                                                                                                                  Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                                                                                  Overrides: Ext.util.Positionable.setY

                                                                                                                                                                                                                                                                                  z-index is managed by the zIndexManager and may be overwritten at any time. ...

                                                                                                                                                                                                                                                                                  z-index is managed by the zIndexManager and may be overwritten at any time. Returns the next z-index to be used. If this is a Container, then it will have rebased any managed floating Components, and so the next available z-index will be approximately 10000 above that.

                                                                                                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  Inject a reference to the function which applies the render template into the framing template. ...

                                                                                                                                                                                                                                                                                  Inject a reference to the function which applies the render template into the framing template. The framing template wraps the content.

                                                                                                                                                                                                                                                                                  Available since: 4.1.0

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  ...

                                                                                                                                                                                                                                                                                  Available since: 4.1.0

                                                                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                                                                                    Available since: 4.1.0

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    ( [animateTarget], [callback], [scope] ) : Ext.Componentchainable
                                                                                                                                                                                                                                                                                    Shows this Component, rendering it first if autoRender or floating are true. ...

                                                                                                                                                                                                                                                                                    Shows this Component, rendering it first if autoRender or floating are true.

                                                                                                                                                                                                                                                                                    After being shown, a floating Component (such as a Ext.window.Window), is activated it and brought to the front of its z-index stack.

                                                                                                                                                                                                                                                                                    Available since: 1.1.0

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • animateTarget : String/Ext.Element (optional)

                                                                                                                                                                                                                                                                                      only valid for floating Components such as Windows or ToolTips, or regular Components which have been configured with floating: true. The target from which the Component should animate from while opening.

                                                                                                                                                                                                                                                                                      Defaults to: null

                                                                                                                                                                                                                                                                                    • callback : Function (optional)

                                                                                                                                                                                                                                                                                      A callback function to call after the Component 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

                                                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                                                    Overrides: Ext.AbstractComponent.show, Ext.Component.show

                                                                                                                                                                                                                                                                                    ( x, [y], [animate] ) : Ext.Componentchainable
                                                                                                                                                                                                                                                                                    Displays component at specific xy position. ...

                                                                                                                                                                                                                                                                                    Displays component at specific xy position. A floating component (like a menu) is positioned relative to its ownerCt if any. Useful for popping up a context menu:

                                                                                                                                                                                                                                                                                    listeners: {
                                                                                                                                                                                                                                                                                        itemcontextmenu: function(view, record, item, index, event, options) {
                                                                                                                                                                                                                                                                                            Ext.create('Ext.menu.Menu', {
                                                                                                                                                                                                                                                                                                width: 100,
                                                                                                                                                                                                                                                                                                height: 100,
                                                                                                                                                                                                                                                                                                margin: '0 0 10 0',
                                                                                                                                                                                                                                                                                                items: [{
                                                                                                                                                                                                                                                                                                    text: 'regular item 1'
                                                                                                                                                                                                                                                                                                },{
                                                                                                                                                                                                                                                                                                    text: 'regular item 2'
                                                                                                                                                                                                                                                                                                },{
                                                                                                                                                                                                                                                                                                    text: 'regular item 3'
                                                                                                                                                                                                                                                                                                }]
                                                                                                                                                                                                                                                                                            }).showAt(event.getXY());
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • x : Number/Number[]

                                                                                                                                                                                                                                                                                      The new x position or array of [x,y].

                                                                                                                                                                                                                                                                                    • y : Number (optional)

                                                                                                                                                                                                                                                                                      The new y position

                                                                                                                                                                                                                                                                                    • animate : Boolean/Object (optional)

                                                                                                                                                                                                                                                                                      True to animate the Component into its new position. You may also pass an animation configuration.

                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                                                    ( component, [position], [offsets] ) : Ext.Componentchainable
                                                                                                                                                                                                                                                                                    Shows this component by the specified Component or Element. ...

                                                                                                                                                                                                                                                                                    Shows this component by the specified Component or Element. Used when this component is floating.

                                                                                                                                                                                                                                                                                    Available since: 4.1.3

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                                                    Get the reference to the class from which this object was instantiated. ...

                                                                                                                                                                                                                                                                                    Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

                                                                                                                                                                                                                                                                                    Ext.define('My.Cat', {
                                                                                                                                                                                                                                                                                        statics: {
                                                                                                                                                                                                                                                                                            totalCreated: 0,
                                                                                                                                                                                                                                                                                            speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                                                                                                                                                                                                                                                                                        },
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                        constructor: function() {
                                                                                                                                                                                                                                                                                            var statics = this.statics();
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                            alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                                                                                                                                                                                                                                                                                            // equivalent to: My.Cat.speciesName
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                            alert(this.self.speciesName);   // dependent on 'this'
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                            statics.totalCreated++;
                                                                                                                                                                                                                                                                                        },
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                        clone: function() {
                                                                                                                                                                                                                                                                                            var cloned = new this.self;                      // dependent on 'this'
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                            cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                            return cloned;
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                    });
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                    Ext.define('My.SnowLeopard', {
                                                                                                                                                                                                                                                                                        extend: 'My.Cat',
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                        statics: {
                                                                                                                                                                                                                                                                                            speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                                                                                                                                                                                                                                                                                        },
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                        constructor: function() {
                                                                                                                                                                                                                                                                                            this.callParent();
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                    });
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                    var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                    var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                    var clone = snowLeopard.clone();
                                                                                                                                                                                                                                                                                    alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
                                                                                                                                                                                                                                                                                    alert(clone.groupName);                 // alerts 'Cat'
                                                                                                                                                                                                                                                                                    
                                                                                                                                                                                                                                                                                    alert(My.Cat.totalCreated);             // alerts 3
                                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                                                    Returns

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

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

                                                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                                                    Returns

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

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

                                                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                                                    This method has been deprecated since 4.0

                                                                                                                                                                                                                                                                                    Replaced by stopAnimation

                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                    Suspends firing of the named event(s). ...

                                                                                                                                                                                                                                                                                    Suspends firing of the named event(s).

                                                                                                                                                                                                                                                                                    After calling this method to suspend events, the events will no longer fire when requested to fire.

                                                                                                                                                                                                                                                                                    Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

                                                                                                                                                                                                                                                                                    Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • eventName : String...

                                                                                                                                                                                                                                                                                      Multiple event names to suspend.

                                                                                                                                                                                                                                                                                    Suspends the firing of all events. ...

                                                                                                                                                                                                                                                                                    Suspends the firing of all events. (see resumeEvents)

                                                                                                                                                                                                                                                                                    Available since: 2.3.0

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • queueSuspended : Boolean

                                                                                                                                                                                                                                                                                      Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

                                                                                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                                                                                    Available since: 4.1.0

                                                                                                                                                                                                                                                                                    Ensures that all effects queued after syncFx is called on this object are run concurrently. ...

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

                                                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                    synchronizes the hidden state of this component with the state of its hierarchy ...

                                                                                                                                                                                                                                                                                    synchronizes the hidden state of this component with the state of its hierarchy

                                                                                                                                                                                                                                                                                    Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                                                    • afterrender
                                                                                                                                                                                                                                                                                    • beforehide
                                                                                                                                                                                                                                                                                    • beforerender
                                                                                                                                                                                                                                                                                    • beforeshow
                                                                                                                                                                                                                                                                                    • render
                                                                                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                                                                                    Available since: 4.0.0

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

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

                                                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                    Available since: 4.0.0

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    • preventFocus : Boolean (optional)

                                                                                                                                                                                                                                                                                      Specify true to prevent the Component from being focused.

                                                                                                                                                                                                                                                                                      Defaults to: false

                                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                                                      Allows for any necessary modifications before the original value is set ...

                                                                                                                                                                                                                                                                                      Allows for any necessary modifications before the original value is set

                                                                                                                                                                                                                                                                                      Available since: 4.1.1

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • value : Object

                                                                                                                                                                                                                                                                                        The initial value

                                                                                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                                                                                      • Object

                                                                                                                                                                                                                                                                                        The modified initial value

                                                                                                                                                                                                                                                                                      Transform the raw value before it is set ...

                                                                                                                                                                                                                                                                                      Transform the raw value before it is set

                                                                                                                                                                                                                                                                                      Available since: 4.1.1

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                                                                                      Translates the passed page coordinates into left/top css values for the element ...

                                                                                                                                                                                                                                                                                      Translates the passed page coordinates into left/top css values for the element

                                                                                                                                                                                                                                                                                      Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • x : Number/Array

                                                                                                                                                                                                                                                                                        The page x or an array containing [x, y]

                                                                                                                                                                                                                                                                                      • y : Number (optional)

                                                                                                                                                                                                                                                                                        The page y, required if x is not an array

                                                                                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                                                                                      • Object

                                                                                                                                                                                                                                                                                        An object with left and top properties. e.g. {left: (value), top: (value)}

                                                                                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                                                                                        Translates the passed page coordinates into x and y css values for the element ...

                                                                                                                                                                                                                                                                                        Translates the passed page coordinates into x and y css values for the element

                                                                                                                                                                                                                                                                                        Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        • x : Number/Array

                                                                                                                                                                                                                                                                                          The page x or an array containing [x, y]

                                                                                                                                                                                                                                                                                        • y : Number (optional)

                                                                                                                                                                                                                                                                                          The page y, required if x is not an array

                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                        • Object

                                                                                                                                                                                                                                                                                          An object with x and y properties. e.g. {x: (value), y: (value)}

                                                                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                                                                          Returns the trimmed label by slicing off the label separator character. ...

                                                                                                                                                                                                                                                                                          Returns the trimmed label by slicing off the label separator character. Can be overridden.

                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                                                                                          • String

                                                                                                                                                                                                                                                                                            The trimmed field label, or empty string if not defined

                                                                                                                                                                                                                                                                                          ( eventName, fn, [scope] )
                                                                                                                                                                                                                                                                                          Shorthand for removeListener. ...

                                                                                                                                                                                                                                                                                          Shorthand for removeListener.

                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          • eventName : String

                                                                                                                                                                                                                                                                                            The type of event the handler was associated with.

                                                                                                                                                                                                                                                                                          • fn : 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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                                                                                                                                                                                                                                          Overridden in Ext.rtl.AbstractComponent. ...

                                                                                                                                                                                                                                                                                          Overridden in Ext.rtl.AbstractComponent.

                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                                                                                            ...

                                                                                                                                                                                                                                                                                            Available since: 4.1.0

                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                            Clears the active error message(s). ...

                                                                                                                                                                                                                                                                                            Clears the active error message(s). Note that this only clears the error message element's text and attributes, you'll have to call doComponentLayout to actually update the field's layout to match. If the field extends Ext.form.field.Base you should call clearInvalid instead.

                                                                                                                                                                                                                                                                                            Available since: 4.0.0

                                                                                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                                                                                              Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed simple selector or ...

                                                                                                                                                                                                                                                                                              Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed simple selector or component.

                                                                                                                                                                                                                                                                                              Important. There is not a universal upwards navigation pointer. There are several upwards relationships such as the button which activates a menu, or the menu item which activated a submenu, or the column header which activated the column menu.

                                                                                                                                                                                                                                                                                              These differences are abstracted away by this method.

                                                                                                                                                                                                                                                                                              Example:

                                                                                                                                                                                                                                                                                              var owningTabPanel = grid.up('tabpanel');
                                                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                                                              Available since: 4.0.0

                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                              • selector : String/Ext.Component (optional)

                                                                                                                                                                                                                                                                                                The simple selector component or actual component to test. If not passed the immediate owner/activater is returned.

                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                                                                                                ( htmlOrData, [loadScripts], [callback] )
                                                                                                                                                                                                                                                                                                Update the content area of a component. ...

                                                                                                                                                                                                                                                                                                Update the content area of a component.

                                                                                                                                                                                                                                                                                                Available since: 3.4.0

                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                • htmlOrData : String/Object

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

                                                                                                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                                                                                                  Injected as an override by Ext.Aria.initialize ...

                                                                                                                                                                                                                                                                                                  Injected as an override by Ext.Aria.initialize

                                                                                                                                                                                                                                                                                                  Available since: 4.1.0

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

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

                                                                                                                                                                                                                                                                                                  Available since: 4.0.0

                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                  • box : Object

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

                                                                                                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                                                                                  ...

                                                                                                                                                                                                                                                                                                  Available since: 4.1.0

                                                                                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                                                                                    Updates this component's layout. ...

                                                                                                                                                                                                                                                                                                    Updates this component's layout. If this update affects this components ownerCt, that component's updateLayout method will be called to perform the layout instead. Otherwise, just this component (and its child items) will layout.

                                                                                                                                                                                                                                                                                                    Available since: 4.1.0

                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                    • options : Object (optional)

                                                                                                                                                                                                                                                                                                      An object with layout options.

                                                                                                                                                                                                                                                                                                      • defer : Boolean

                                                                                                                                                                                                                                                                                                        true if this layout should be deferred.

                                                                                                                                                                                                                                                                                                      • isRoot : Boolean

                                                                                                                                                                                                                                                                                                        true if this layout should be the root of the layout.

                                                                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                      Available since: 4.0.0

                                                                                                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                                                                                                      • Boolean

                                                                                                                                                                                                                                                                                                        True if the value is valid, else false

                                                                                                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                                                                                                      Uses getErrors to build an array of validation errors. ...

                                                                                                                                                                                                                                                                                                      Uses getErrors to build an array of validation errors. If any errors are found, they are passed to markInvalid 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.

                                                                                                                                                                                                                                                                                                      Available since: 2.3.0

                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                      • value : Object

                                                                                                                                                                                                                                                                                                        The value to validate

                                                                                                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                                                                                                      • Boolean

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

                                                                                                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                                                                                                        Ext.form.field.Checkbox
                                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                                        ( value ) : Object
                                                                                                                                                                                                                                                                                                        private ...

                                                                                                                                                                                                                                                                                                        private

                                                                                                                                                                                                                                                                                                        Available since: 4.0.0

                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                                        • Object

                                                                                                                                                                                                                                                                                                          The converted raw value.

                                                                                                                                                                                                                                                                                                        Overrides: Ext.form.field.Base.valueToRaw

                                                                                                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                                                                                                        Available since: 4.1.0

                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                                                                                          Overrides: Ext.util.Renderable.wrapPrimaryEl

                                                                                                                                                                                                                                                                                                          Defined By

                                                                                                                                                                                                                                                                                                          Static methods

                                                                                                                                                                                                                                                                                                          ( config )privatestatic
                                                                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( members )chainableprivatestatic
                                                                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( name, member )chainableprivatestatic
                                                                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( members )chainablestatic
                                                                                                                                                                                                                                                                                                          Add methods / properties to the prototype of this class. ...

                                                                                                                                                                                                                                                                                                          Add methods / properties to the prototype of this class.

                                                                                                                                                                                                                                                                                                          Ext.define('My.awesome.Cat', {
                                                                                                                                                                                                                                                                                                              constructor: function() {
                                                                                                                                                                                                                                                                                                                  ...
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                           My.awesome.Cat.addMembers({
                                                                                                                                                                                                                                                                                                               meow: function() {
                                                                                                                                                                                                                                                                                                                  alert('Meowww...');
                                                                                                                                                                                                                                                                                                               }
                                                                                                                                                                                                                                                                                                           });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                           var kitty = new My.awesome.Cat;
                                                                                                                                                                                                                                                                                                           kitty.meow();
                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( members ) : Ext.Basechainablestatic
                                                                                                                                                                                                                                                                                                          Add / override static properties of this class. ...

                                                                                                                                                                                                                                                                                                          Add / override static properties of this class.

                                                                                                                                                                                                                                                                                                          Ext.define('My.cool.Class', {
                                                                                                                                                                                                                                                                                                              ...
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          My.cool.Class.addStatics({
                                                                                                                                                                                                                                                                                                              someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
                                                                                                                                                                                                                                                                                                              method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
                                                                                                                                                                                                                                                                                                              method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                          Available since: 4.0.2

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                                                                                                          ( xtype )chainableprivatestatic
                                                                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( fromClass, members ) : Ext.Basechainableprivatestatic
                                                                                                                                                                                                                                                                                                          Borrow another class' members to the prototype of this class. ...

                                                                                                                                                                                                                                                                                                          Borrow another class' members to the prototype of this class.

                                                                                                                                                                                                                                                                                                          Ext.define('Bank', {
                                                                                                                                                                                                                                                                                                              money: '$$$',
                                                                                                                                                                                                                                                                                                              printMoney: function() {
                                                                                                                                                                                                                                                                                                                  alert('$$$$$$$');
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          Ext.define('Thief', {
                                                                                                                                                                                                                                                                                                              ...
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          Thief.borrow(Bank, ['money', 'printMoney']);
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          var steve = new Thief();
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          alert(steve.money); // alerts '$$$'
                                                                                                                                                                                                                                                                                                          steve.printMoney(); // alerts '$$$$$$$'
                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                          Available since: 4.0.2

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          • fromClass : Ext.Base

                                                                                                                                                                                                                                                                                                            The class to borrow members from

                                                                                                                                                                                                                                                                                                          • members : Array/String

                                                                                                                                                                                                                                                                                                            The names of the members to borrow

                                                                                                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                                                                                                          Create a new instance of this Class. ...

                                                                                                                                                                                                                                                                                                          Create a new instance of this Class.

                                                                                                                                                                                                                                                                                                          Ext.define('My.cool.Class', {
                                                                                                                                                                                                                                                                                                              ...
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          My.cool.Class.create({
                                                                                                                                                                                                                                                                                                              someConfig: true
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                          All parameters are passed to the constructor of the class.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.2

                                                                                                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                                                                                                          Overrides: Ext.layout.Layout.create

                                                                                                                                                                                                                                                                                                          ( alias, origin )static
                                                                                                                                                                                                                                                                                                          Create aliases for existing prototype methods. ...

                                                                                                                                                                                                                                                                                                          Create aliases for existing prototype methods. Example:

                                                                                                                                                                                                                                                                                                          Ext.define('My.cool.Class', {
                                                                                                                                                                                                                                                                                                              method1: function() { ... },
                                                                                                                                                                                                                                                                                                              method2: function() { ... }
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          var test = new My.cool.Class();
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          My.cool.Class.createAlias({
                                                                                                                                                                                                                                                                                                              method3: 'method1',
                                                                                                                                                                                                                                                                                                              method4: 'method2'
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          test.method3(); // test.method1()
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          My.cool.Class.createAlias('method5', 'method3');
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          test.method5(); // test.method3() -> test.method1()
                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                          Available since: 4.0.2

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( config )privatestatic
                                                                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Get the current class' name in string format. ...

                                                                                                                                                                                                                                                                                                          Get the current class' name in string format.

                                                                                                                                                                                                                                                                                                          Ext.define('My.cool.Class', {
                                                                                                                                                                                                                                                                                                              constructor: function() {
                                                                                                                                                                                                                                                                                                                  alert(this.self.getName()); // alerts 'My.cool.Class'
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          My.cool.Class.getName(); // 'My.cool.Class'
                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                          Available since: 4.0.4

                                                                                                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                                                                                                          ( )deprecatedstatic
                                                                                                                                                                                                                                                                                                          Adds members to class. ...

                                                                                                                                                                                                                                                                                                          Adds members to class.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.2

                                                                                                                                                                                                                                                                                                          This method has been deprecated since 4.1

                                                                                                                                                                                                                                                                                                          Use addMembers instead.

                                                                                                                                                                                                                                                                                                          ( name, mixinClass )privatestatic
                                                                                                                                                                                                                                                                                                          Used internally by the mixins pre-processor ...

                                                                                                                                                                                                                                                                                                          Used internally by the mixins pre-processor

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( fn, scope )chainableprivatestatic
                                                                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( members ) : Ext.Basechainabledeprecatedstatic
                                                                                                                                                                                                                                                                                                          Override members of this class. ...

                                                                                                                                                                                                                                                                                                          Override members of this class. Overridden methods can be invoked via callParent.

                                                                                                                                                                                                                                                                                                          Ext.define('My.Cat', {
                                                                                                                                                                                                                                                                                                              constructor: function() {
                                                                                                                                                                                                                                                                                                                  alert("I'm a cat!");
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          My.Cat.override({
                                                                                                                                                                                                                                                                                                              constructor: function() {
                                                                                                                                                                                                                                                                                                                  alert("I'm going to be a cat!");
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                  this.callParent(arguments);
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                  alert("Meeeeoooowwww");
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                          var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                                                                                                                                                                                                                                                                                                                    // alerts "I'm a cat!"
                                                                                                                                                                                                                                                                                                                                    // alerts "Meeeeoooowwww"
                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                          As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

                                                                                                                                                                                                                                                                                                          Ext.define('My.CatOverride', {
                                                                                                                                                                                                                                                                                                              override: 'My.Cat',
                                                                                                                                                                                                                                                                                                              constructor: function() {
                                                                                                                                                                                                                                                                                                                  alert("I'm going to be a cat!");
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                  this.callParent(arguments);
                                                                                                                                                                                                                                                                                                          
                                                                                                                                                                                                                                                                                                                  alert("Meeeeoooowwww");
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                          The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

                                                                                                                                                                                                                                                                                                          Available since: 4.0.2

                                                                                                                                                                                                                                                                                                          This method has been deprecated since 4.1.0

                                                                                                                                                                                                                                                                                                          Use Ext.define instead

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          • members : Object

                                                                                                                                                                                                                                                                                                            The properties to add to this class. This should be specified as an object literal containing one or more properties.

                                                                                                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Defined By

                                                                                                                                                                                                                                                                                                          Events

                                                                                                                                                                                                                                                                                                          Fires after a Component has been visually activated. ...

                                                                                                                                                                                                                                                                                                          Fires after a Component has been visually activated.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( this, container, pos, eOpts )
                                                                                                                                                                                                                                                                                                          Fires after a Component had been added to a Container. ...

                                                                                                                                                                                                                                                                                                          Fires after a Component had been added to a Container.

                                                                                                                                                                                                                                                                                                          Available since: 3.4.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires after the component rendering is finished. ...

                                                                                                                                                                                                                                                                                                          Fires after the component rendering is finished.

                                                                                                                                                                                                                                                                                                          The afterrender event is fired after this Component has been rendered, been postprocessed by any afterRender method defined for the Component.

                                                                                                                                                                                                                                                                                                          Available since: 3.4.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires before a Component has been visually activated. ...

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

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires before a Component has been visually deactivated. ...

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

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires before the component is destroyed. ...

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

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

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

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

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires before the component is rendered. ...

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

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

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

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

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires before the state of the object is restored. ...

                                                                                                                                                                                                                                                                                                          Fires before the state of the object is restored. Return false from an event handler to stop the restore.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          • this : Ext.state.Stateful
                                                                                                                                                                                                                                                                                                          • state : Object

                                                                                                                                                                                                                                                                                                            The hash of state values returned from the StateProvider. If this event is not vetoed, then the state object is passed to applyState. By default, that simply copies property values into this object. The method maybe overriden to provide custom state restoration.

                                                                                                                                                                                                                                                                                                          • eOpts : Object

                                                                                                                                                                                                                                                                                                            The options object passed to Ext.util.Observable.addListener.

                                                                                                                                                                                                                                                                                                          Fires before the state of the object is saved to the configured state provider. ...

                                                                                                                                                                                                                                                                                                          Fires before the state of the object is saved to the configured state provider. Return false to stop the save.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires when this Component loses focus. ...

                                                                                                                                                                                                                                                                                                          Fires when this Component loses focus.

                                                                                                                                                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( this, width, height, eOpts )
                                                                                                                                                                                                                                                                                                          Fires one time - after the component has been laid out for the first time at its initial size. ...

                                                                                                                                                                                                                                                                                                          Fires one time - after the component has been laid out for the first time at its initial size.

                                                                                                                                                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( this, newValue, oldValue, eOpts )
                                                                                                                                                                                                                                                                                                          Fires when the value of a field is changed via the setValue method. ...

                                                                                                                                                                                                                                                                                                          Fires when the value of a field is changed via the setValue method.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires after a Component has been visually deactivated. ...

                                                                                                                                                                                                                                                                                                          Fires after a Component has been visually deactivated.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires after the component is destroyed. ...

                                                                                                                                                                                                                                                                                                          Fires after the component is destroyed.

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

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

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

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires after the component is disabled. ...

                                                                                                                                                                                                                                                                                                          Fires after the component is disabled.

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires after the component is enabled. ...

                                                                                                                                                                                                                                                                                                          Fires after the component is enabled.

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires when the active error message is changed via setActiveError. ...

                                                                                                                                                                                                                                                                                                          Fires when the active error message is changed via setActiveError.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires when this Component receives focus. ...

                                                                                                                                                                                                                                                                                                          Fires when this Component receives focus.

                                                                                                                                                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires after the component is hidden. ...

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

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires after the component is moved. ...

                                                                                                                                                                                                                                                                                                          Fires after the component is moved.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

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

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

                                                                                                                                                                                                                                                                                                          Available since: 3.4.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires after the component markup is rendered. ...

                                                                                                                                                                                                                                                                                                          Fires after the component markup is rendered.

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          ( this, width, height, oldWidth, oldHeight, eOpts )
                                                                                                                                                                                                                                                                                                          Fires after the component is resized. ...

                                                                                                                                                                                                                                                                                                          Fires after the component is resized. Note that this does not fire when the component is first laid out at its initial size. To hook that point in the life cycle, use the boxready event.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

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

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

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. ...

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

                                                                                                                                                                                                                                                                                                          var form = new Ext.form.Panel({
                                                                                                                                                                                                                                                                                                              ...
                                                                                                                                                                                                                                                                                                              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();
                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                              ],
                                                                                                                                                                                                                                                                                                              ...
                                                                                                                                                                                                                                                                                                          });
                                                                                                                                                                                                                                                                                                          

                                                                                                                                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires after the state of the object is restored. ...

                                                                                                                                                                                                                                                                                                          Fires after the state of the object is restored.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          • this : Ext.state.Stateful
                                                                                                                                                                                                                                                                                                          • state : Object

                                                                                                                                                                                                                                                                                                            The hash of state values returned from the StateProvider. This is passed to applyState. By default, that simply copies property values into this object. The method maybe overriden to provide custom state restoration.

                                                                                                                                                                                                                                                                                                          • eOpts : Object

                                                                                                                                                                                                                                                                                                            The options object passed to Ext.util.Observable.addListener.

                                                                                                                                                                                                                                                                                                          Fires after the state of the object is saved to the configured state provider. ...

                                                                                                                                                                                                                                                                                                          Fires after the state of the object is saved to the configured state provider.

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

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

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

                                                                                                                                                                                                                                                                                                          Available since: 4.0.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Fires when this field changes its read-only status. ...

                                                                                                                                                                                                                                                                                                          Fires when this field changes its read-only status.

                                                                                                                                                                                                                                                                                                          Available since: 4.1.0

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          Defined By

                                                                                                                                                                                                                                                                                                          CSS Variables

                                                                                                                                                                                                                                                                                                          Ext.form.field.Checkbox
                                                                                                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                                                                                                          : number
                                                                                                                                                                                                                                                                                                          The space between the label and the checkbox. ...

                                                                                                                                                                                                                                                                                                          The space between the label and the checkbox.

                                                                                                                                                                                                                                                                                                          Defaults to: 4px

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          Ext.form.field.Checkbox
                                                                                                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                                                                                                          : number
                                                                                                                                                                                                                                                                                                          The size of the checkbox ...

                                                                                                                                                                                                                                                                                                          The size of the checkbox

                                                                                                                                                                                                                                                                                                          Defaults to: 13px

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          Ext.form.field.Checkbox
                                                                                                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                                                                                                          : number
                                                                                                                                                                                                                                                                                                          adjustment for vertical positioning of checkbox. ...

                                                                                                                                                                                                                                                                                                          adjustment for vertical positioning of checkbox. An adjustment of a pixel or two may be needed to achieve the desired vertical alignment of the checkbox with the label in cetain combinations of field-height and checkbox height

                                                                                                                                                                                                                                                                                                          Defaults to: 0

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          Height for form error icons. ...

                                                                                                                                                                                                                                                                                                          Height for form error icons.

                                                                                                                                                                                                                                                                                                          Defaults to: 16px

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          Margin for error icons that are aligned to the side of the field ...

                                                                                                                                                                                                                                                                                                          Margin for error icons that are aligned to the side of the field

                                                                                                                                                                                                                                                                                                          Defaults to: 0 1px

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          Width for form error icons. ...

                                                                                                                                                                                                                                                                                                          Width for form error icons.

                                                                                                                                                                                                                                                                                                          Defaults to: 16px

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The text color of form error messages ...

                                                                                                                                                                                                                                                                                                          The text color of form error messages

                                                                                                                                                                                                                                                                                                          Defaults to: $form-field-invalid-border-color

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The font-family of form error messages ...

                                                                                                                                                                                                                                                                                                          The font-family of form error messages

                                                                                                                                                                                                                                                                                                          Defaults to: $font-family

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The font-size of form error messages ...

                                                                                                                                                                                                                                                                                                          The font-size of form error messages

                                                                                                                                                                                                                                                                                                          Defaults to: $font-size

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The font-weight of form error messages ...

                                                                                                                                                                                                                                                                                                          The font-weight of form error messages

                                                                                                                                                                                                                                                                                                          Defaults to: normal

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The line-height of form error messages ...

                                                                                                                                                                                                                                                                                                          The line-height of form error messages

                                                                                                                                                                                                                                                                                                          Defaults to: $form-error-icon-height

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The space between the icon and the message for errors that display under the field ...

                                                                                                                                                                                                                                                                                                          The space between the icon and the message for errors that display under the field

                                                                                                                                                                                                                                                                                                          Defaults to: 4px

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The padding on errors that display under the form field ...

                                                                                                                                                                                                                                                                                                          The padding on errors that display under the form field

                                                                                                                                                                                                                                                                                                          Defaults to: 2px 2px 2px 0

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          Background color for form fields. ...

                                                                                                                                                                                                                                                                                                          Background color for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: #fff

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Background image for form fields. ...

                                                                                                                                                                                                                                                                                                          Background image for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: 'form/text-bg'

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Border color for form fields. ...

                                                                                                                                                                                                                                                                                                          Border color for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: $neutral-color

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Border style for form fields. ...

                                                                                                                                                                                                                                                                                                          Border style for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: solid

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          Border width for form fields. ...

                                                                                                                                                                                                                                                                                                          Border width for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: 1px

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Text color for form fields. ...

                                                                                                                                                                                                                                                                                                          Text color for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: $color

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          ...

                                                                                                                                                                                                                                                                                                          Defaults to: .3

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          Text color for empty form fields. ...

                                                                                                                                                                                                                                                                                                          Text color for empty form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: gray

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Border color for focused form fields. ...

                                                                                                                                                                                                                                                                                                          Border color for focused form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: $base-color

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Font for form fields. ...

                                                                                                                                                                                                                                                                                                          Font for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: $form-field-font-weight $form-field-font-size $form-field-font-family

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Font family for form fields. ...

                                                                                                                                                                                                                                                                                                          Font family for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: $font-family

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Font size for form fields. ...

                                                                                                                                                                                                                                                                                                          Font size for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: $font-size

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Font weight for form fields. ...

                                                                                                                                                                                                                                                                                                          Font weight for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: normal

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Height for form fields. ...

                                                                                                                                                                                                                                                                                                          Height for form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: 22px

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Background color for invalid form fields. ...

                                                                                                                                                                                                                                                                                                          Background color for invalid form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: #fff

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Background image for invalid form fields. ...

                                                                                                                                                                                                                                                                                                          Background image for invalid form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: 'grid/invalid_line'

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Background position for invalid form fields. ...

                                                                                                                                                                                                                                                                                                          Background position for invalid form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: bottom

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Background repeat for invalid form fields. ...

                                                                                                                                                                                                                                                                                                          Background repeat for invalid form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: repeat-x

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Border color for invalid form fields. ...

                                                                                                                                                                                                                                                                                                          Border color for invalid form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: #c30

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          Padding around form fields. ...

                                                                                                                                                                                                                                                                                                          Padding around form fields.

                                                                                                                                                                                                                                                                                                          Defaults to: 1px 3px

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          The bottom margin to apply to form items when in auto, anchor, vbox, or table layout ...

                                                                                                                                                                                                                                                                                                          The bottom margin to apply to form items when in auto, anchor, vbox, or table layout

                                                                                                                                                                                                                                                                                                          Defaults to: 5px

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The text color of form field labels ...

                                                                                                                                                                                                                                                                                                          The text color of form field labels

                                                                                                                                                                                                                                                                                                          Defaults to: $color

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The font-family of form field labels ...

                                                                                                                                                                                                                                                                                                          The font-family of form field labels

                                                                                                                                                                                                                                                                                                          Defaults to: $font-family

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The font-size of form field labels ...

                                                                                                                                                                                                                                                                                                          The font-size of form field labels

                                                                                                                                                                                                                                                                                                          Defaults to: $font-size

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The font-weight of form field labels ...

                                                                                                                                                                                                                                                                                                          The font-weight of form field labels

                                                                                                                                                                                                                                                                                                          Defaults to: normal

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          The line-height of form field labels ...

                                                                                                                                                                                                                                                                                                          The line-height of form field labels

                                                                                                                                                                                                                                                                                                          Defaults to: 22px

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0

                                                                                                                                                                                                                                                                                                          Height for form fields in toolbar. ...

                                                                                                                                                                                                                                                                                                          Height for form fields in toolbar.

                                                                                                                                                                                                                                                                                                          Defaults to: $form-field-height

                                                                                                                                                                                                                                                                                                          Available since: 4.1.1

                                                                                                                                                                                                                                                                                                          The line-height of toolbar form field labels ...

                                                                                                                                                                                                                                                                                                          The line-height of toolbar form field labels

                                                                                                                                                                                                                                                                                                          Defaults to: $form-toolbar-field-height

                                                                                                                                                                                                                                                                                                          Available since: Ext JS 4.2.0