Ext JS Sencha Docs

Ext.Component

Alternate names

Ext.AbstractComponent

Hierarchy

Ext.Base
Ext.Component

Mixins

Requires

Subclasses

Uses

Ext.overrides.*

Files

Base class for all Ext components.

The Component base class has built-in support for basic hide/show and enable/disable and size control behavior.

xtypes

Every component has a specific xtype, which is its Ext-specific type name, along with methods for checking the xtype like getXType and isXType. See the Component Guide for more information on xtypes and the Component hierarchy.

Finding components

All Components are registered with the Ext.ComponentManager on construction so that they can be referenced at any time via Ext.getCmp, passing the id.

Additionally the Ext.ComponentQuery provides a CSS-selectors-like way to look up components by their xtype and many other attributes. For example the following code will find all textfield components inside component with id: 'myform':

Ext.ComponentQuery.query('#myform textfield');

Extending Ext.Component

All subclasses of Component may participate in the automated Ext component lifecycle of creation, rendering and destruction which is provided by the Container class. Components may be added to a Container through the items config option at the time the Container is created, or they may be added dynamically via the add method.

All user-developed visual widgets that are required to participate in automated lifecycle and size management should subclass Component.

See the Creating new UI controls chapter in Component Guide for details on how and to either extend or augment Ext JS base classes to create custom Components.

The Ext.Component class by itself

Usually one doesn't need to instantiate the Ext.Component class. There are subclasses which implement specialized use cases, covering most application needs. However it is possible to instantiate a base Component, and it can be rendered to document, or handled by layouts as the child item of a Container:

Ext.create('Ext.Component', {
    html: 'Hello world!',
    width: 300,
    height: 200,
    padding: 20,
    style: {
        color: '#FFFFFF',
        backgroundColor:'#000000'
    },
    renderTo: Ext.getBody()
});

The Component above creates its encapsulating div upon render, and use the configured HTML as content. More complex internal structure may be created using the renderTpl configuration, although to display database-derived mass data, it is recommended that an ExtJS data-backed Component such as a View, GridPanel, or TreePanel be used.

From override Ext.rtl.Component: This override adds RTL support and the rtl config option to AbstactComponent.

From override Ext.layout.container.border.Region: This override provides extra, border layout specific methods for Ext.Component. The Ext.layout.container.Border class requires this override so that the added functions are only included in a build when border layout is used.

Defined By

Config options

An incrementing numeric counter indicating activation index for use by the zIndexManager to sort its stack. ...

An incrementing numeric counter indicating activation index for use by the zIndexManager to sort its stack.

Defaults to: 0

A Component or Element by which to position this component according to the defaultAlign. ...

A Component or Element by which to position this component according to the defaultAlign. Defaults to ths owning Container.

Only applicable if this component is floating

Used upon first show.

A flag indicating that this component should be on the top of the z-index stack for use by the zIndexManager to sort ...

A flag indicating that this component should be on the top of the z-index stack for use by the zIndexManager to sort its stack.

This may be a positive number to prioritize the ordering of multiple visible always on top components.

This may be set to a negative number to prioritize a component to the bottom of the z-index stack.

Defaults to: false

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

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

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

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

Ext.Component
view source
: String
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: 'x-component'

Setting this config option adds or removes data bindings for other configs. ...

Setting this config option adds or removes data bindings for other configs. For example, to bind the title config:

 var panel = Ext.create({
     xtype: 'panel',
     bind: {
         title: 'Hello {user.name}'
     }
 });

To dynamically add bindings:

 panel.setBind({
     title: 'Greetings {user.name}!'
 });

To remove bindings:

 panel.setBind({
     title: null
 });

The bind expressions are presented to Ext.app.ViewModel.bind. The ViewModel instance is determined by lookupViewModel.

Defaults to: {$value: null, lazy: true}

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.

The canonical form of childEls is an object keyed by child's property name with values that are objects with the foll...

The canonical form of childEls is an object keyed by child's property name with values that are objects with the following properties.

  • 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.
  • leaf - Set to true to ignore content when scanning for childEls. This should be set on things like the generated content for an Ext.view.View.
  • select: A selector that will be passed to Ext.dom.Element.select.
  • selectNode: A selector that will be passed to Ext.dom.Element.selectNode.

For example:

 childEls: {
     button: true,
     buttonText: 'text',
     buttonImage: {
         itemId: 'image'
     }
 }

The above is translated into the following complete form:

 childEls: {
     button: {
         name: 'button',
         itemId: 'button'
     },
     buttonText: {
         name: 'buttonText',
         itemId: 'text'
     },
     buttonImage: {
         name: 'buttonImage',
         itemId: 'image'
     }
 }

The above can be provided as an array like so:

 childEls: [
     'button',
     { name: 'buttonText', itemId: 'text' },
     { name: 'buttonImage', itemId: 'image' }
 }

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

Ext.create('Ext.Component', {
    renderTo: Ext.getBody(),
    renderTpl: [
        '<h1 id="{id}-title" data-ref="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"});
        }
    }
});

When using select, the property will be an instance of Ext.CompositeElement. In all other cases, the property will be an Ext.dom.Element or null if not found.

Care should be taken when using select or selectNode to find child elements. The following issues should be considered:

  • Performance: using selectors can be 10x slower than id lookup.
  • Over-selecting: selectors are applied after the DOM elements for all children have been rendered, so selectors can match elements from child components (including nested versions of the same component) accidentally.

This above issues are most important when using select since it returns multiple elements.

Defaults to: {frameTable: {frame: true}, frameTL: {frame: 'tl'}, frameTC: {frame: 'tc'}, frameTR: {frame: 'tr'}, frameML: {frame: 'ml'}, frameBody: {frame: 'mc'}, frameMR: {frame: 'mr'}, frameBL: {frame: 'bl'}, frameBC: {frame: 'bc'}, frameBR: {frame: 'br'}}

Overrides: Ext.util.ElementContainer.childEls, Ext.Component.childEls, Ext.menu.Item.childEls, Ext.button.Button.childEls

Ext.Component
view source
: String
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.

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.

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: 'autocomponent'

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

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.

An object or a string (in TRBL order) specifying insets from the configured constrain region within which this compon...

An object or a string (in TRBL order) specifying insets from the configured constrain region within which this component must be constrained when positioning or sizing. example:

constraintInsets: '10 10 10 10' // Constrain with 10px insets from parent

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-hidden-display CSS class to prevent a brief flicker of the content before it is rendered to the panel.

Available since: 3.4.0

A string alias, a configuration object or an instance of a ViewController for this container. ...

A string alias, a configuration object or an instance of a ViewController for this container. Sample usage:

Ext.define('MyApp.UserController', {
    alias: 'controller.user'
});

Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: 'user'
});
// Or
Ext.define('UserContainer', {
    extend: 'Ext.container.container',
    controller: {
        type: 'user',
        someConfig: true
    }
});

// Can also instance at runtime
var ctrl = new MyApp.UserController();
var view = new UserContainer({
    controller: ctrl
});
Ext.Component
view source
: Object

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.dom.Element#getAlignToXY anchor position value for this component relative to its alignTarget (which ...

The default Ext.dom.Element#getAlignToXY anchor position value for this component relative to its alignTarget (which defaults to its owning Container).

Only applicable if this component is floating

Used upon first show.

Defaults to: "c-c"

If true, this component will be the default scope (this pointer) for events specified with string names so that the s...

If true, this component will be the default scope (this pointer) for events specified with string names so that the scope can be dynamically resolved. The component will automatically become the defaultListenerScope if a controller is specified.

See the introductory docs for Ext.container.Container for some sample usages.

NOTE: This value can only be reliably set at construction time. Setting it after that time may not correctly rewire all of the potentially effected listeners.

Defaults to: false

true to disable the component. ...

true to disable the component.

Defaults to: false

Available since: 2.3.0

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

CSS class to add when the Component is disabled.

Defaults to: 'x-item-disabled'

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

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.

Defaults to: false

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 sorts its stack according to an incrementing access counter and the alwaysOnTop config 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

CSS class that will be added to focused Component, and removed when Component blurs. ...

CSS class that will be added to focused Component, and removed when Component blurs.

Defaults to: 'x-focus'

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

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

Ext.Component
view source
: Boolean
Specify as true to have the Component inject framing elements within the Component at render time to provide a graphi...

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

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

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

The height of this component. ...

The height of this component. A numeric value will be interpreted as the number of pixels; a string value will be treated as a CSS value with units.

Ext.Component
view source
: Boolean
true to hide the component. ...

true to hide the component.

Defaults to: false

Available since: 2.3.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

Ext.Component
view source
: String
The unique id of this component instance. ...

The unique id of this component instance.

Use of this config should be considered carefully as this value must be unique across all existing components. Components created with an id may be accessed globally using Ext.getCmp.

Instead of using assigned ids, consider a reference config and a ViewController to respond to events and perform processing upon this Component.

Alternatively, itemId and ComponentQuery can be used to perform selector-based searching for Components analogous to DOM querying. The Container class contains several helpful 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.

Defaults to an auto-assigned id.

Note: Valid identifiers start with a letter or underscore and are followed by (optional) additional letters, underscores, digits or hyphens.

Available since: 1.1.0

Ext.Component
view source
: String
The unique id of this component instance within its container. ...

The unique id of this component instance within its container. See also the reference config.

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 getCmp, use itemId with getComponent which will retrieve itemId's or id's. Since itemId's are an index to the container's internal collection, the itemId is scoped locally to the container -- avoiding potential conflicts with Ext.ComponentManager which requires a unique id values.

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: Valid identifiers start with a letter or underscore and are followed by (optional) additional letters, underscores, digits or hyphens.

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

Available since: 3.4.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'); }
        }
    }
});
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()
});
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).

Related to the childEls configuration which specifies named properties which correspond to component sub-elements. ...

Related to the childEls configuration which specifies named properties which correspond to component sub-elements.

The name of the element property in this component to mask when masked by a LoadMask.

Defaults to null to indicate that Components cannot by default contain a LoadMask, and that any LoadMask should be rendered into the document body.

For example, Panels use "el" to indicate that the whole panel should be masked. This could be configured to be "body" so that only the body is masked and toolbars and the header are still mouse-accessible.

Defaults to: null

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.

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.

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.

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.

This config enables binding to your Ext.data.Model.validators. ...

This config enables binding to your Ext.data.Model.validators. This is only processed by form fields (e.g., Ext.form.field.Text) at present, but this setting is inherited and so can be set on a parent container.

When set to true by a component or not set by a component but inherited from an ancestor container, Ext.data.Validation records are used to automatically bind validation results for any form field to which a value is bound.

While this config can be set arbitrarily high in the component hierarchy, doing so can create a lot overhead if most of your form fields do not actually rely on validators in your data model.

Using this setting for a form that is bound to an Ext.data.Model might look like this:

 {
     xtype: 'panel',
     modelValidation: true,
     items: [{
         xtype: 'textfield',
         bind: '{theUser.firstName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.lastName}'
     },{
         xtype: 'textfield',
         bind: '{theUser.phoneNumber}'
     },{
         xtype: 'textfield',
         bind: '{theUser.email}'
     }]
 }

The above is equivalent to the following manual binding of validation:

 {
     xtype: 'panel',
     items: [{
         xtype: 'textfield',
         bind: {
             value:      '{theUser.firstName}'
             validation: '{theUser.validation.firstName}'
         }
     },{
         xtype: 'textfield',
         bind: {
             value:      '{theUser.lastName}'
             validation: '{theUser.validation.lastName}'
         }
     },{
         xtype: 'textfield',
         bind: {
             value:      '{theUser.phoneNumber}'
             validation: '{theUser.validation.phoneNumber}'
         }
     },{
         xtype: 'textfield',
         bind: {
             value:      '{theUser.email}'
             validation: '{theUser.validation.email}'
         }
     }]
 }

Notice that "validation" is a pseudo-association defined for all entities. See Ext.data.Model.getValidation for further details.

Ext.Component
view source
: String
An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and...

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. 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 (Style overflow-x: 'auto'). ...

Possible values are:

  • 'auto' to enable automatic horizontal scrollbar (Style overflow-x: 'auto').
  • 'scroll' to always enable horizontal scrollbar (Style overflow-x: 'scroll').

The default is overflow-x: 'hidden'. This should not be combined with autoScroll.

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

Possible values are:

  • 'auto' to enable automatic vertical scrollbar (Style overflow-y: 'auto').
  • 'scroll' to always enable vertical scrollbar (Style overflow-y: 'scroll').

The default is overflow-y: 'hidden'. This should not be combined with autoScroll.

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

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

One or more names of config properties that this component should publish to its ViewModel. ...

One or more names of config properties that this component should publish to its ViewModel. Some components override this and publish their most useful configs by default.

This config uses the reference to determine the name of the data object to place in the ViewModel. If reference is not set then this config is ignored.

By using this config and reference you can bind configs between components. For example:

 ...
     items: [{
         xtype: 'textfield',
         reference: 'somefield',  // component's name in the ViewModel
         publishes: 'value' // value is not published by default
     },{
         ...
     },{
         xtype: 'displayfield',
         bind: 'You have entered "{somefield.value}"'
     }]
 ...

Classes must provide this config as an Object:

 Ext.define('App.foo.Bar', {
     publishes: {
         foo: true,
         bar: true
     }
 });

This is required for the config system to properly merge values from derived classes.

For instances this value can be specified as a value as show above or an array or object as follows:

 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: [
         'value',
         'rawValue',
         'dirty'
     ]
 }

 // This achieves the same result as the above array form.
 {
     xtype: 'textfield',
     reference: 'somefield',
     publishes: {
         value: true,
         rawValue: true,
         dirty: true
     }
 }

Available since: 5.0.0

Specifies a name for this component inside its component hierarchy. ...

Specifies a name for this component inside its component hierarchy. This name must be unique within its view or its ViewController. See the documentation in Ext.container.Container for more information about references.

Note: Valid identifiers start with a letter or underscore and are followed by zero or more additional letters, underscores or digits. References are case sensitive.

Ext.Component
view source
: "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.
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.

Ext.Component
view source
: Objectdeprecated
An object containing properties specifying CSS selectors which identify child elements created by the render process. ...

An object containing properties specifying CSS 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"});
         }
     }
 });

The use of renderSelectors is deprecated (for performance reasons). The above code should be refactored into something like this:

 Ext.create('Ext.Component', {
     renderTo: Ext.getBody(),
     renderTpl: [
         '<h1 class="title" id="{id}-titleEl" data-ref="titleEl">{title}</h1>',
         '<p id="{id}-descEl" data-ref="descEl">{desc}</p>'
     ],
     renderData: {
         title: "Error",
         desc: "Something went wrong"
     },
     childEls: [
         'titleEl',
         'descEl'
     ]
 });

To use childEls yet retain the use of selectors (which remains as expensive as renderSelectors):

 Ext.create('Ext.Component', {
     renderTo: Ext.getBody(),
     renderTpl: [
         '<h1 class="title">{title}</h1>',
         '<p>{desc}</p>'
     ],
     renderData: {
         title: "Error",
         desc: "Something went wrong"
     },
     childEls: {
         titleEl: { selectNode: 'h1.title' },
         descEl: { selectNode: 'p' }
     }
 });

This cfg has been deprecated since 5.0

Use childEls instead.

Ext.Component
view source
: String/HTMLElement/Ext.dom.Element
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: ['<tpl if="renderScroller">', '<div class="{scrollerCls}" style="{%this.renderPadding(out, values)%}">', '</tpl>', '{%this.renderContent(out,values)%}', '<tpl if="renderScroller"></div></tpl>']

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

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

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

Defaults to: 'all'

Ext.Component
view source
: Boolean
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.Component.

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

If provided this creates a new Session instance for this component. ...

If provided this creates a new Session instance for this component. If this is a Container, this will then be inherited by all child components.

To create a new session you can specify true:

 Ext.create({
     xtype: 'viewport',
     session: true,

     items: [{
         ...
     }]
 });

Alternatively, a config object can be provided:

 Ext.create({
     xtype: 'viewport',
     session: {
         ...
     },

     items: [{
         ...
     }]
 });

Defaults to: null

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'

Number of pixels to offset the shadow.

Number of pixels to offset the shadow.

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

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

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

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

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

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.

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()+(10006060247)), //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 and store state (sorters and filters and grouper) 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

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

DOM tabIndex attribute for this Focusable

DOM tabIndex attribute for this Focusable

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

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

This object holds a map of config properties that will update their binding as they are modified. ...

This object holds a map of config properties that will update their binding as they are modified. For example, value is a key added by form fields. The form of this config is the same as publishes.

This config is defined so that updaters are not created and added for all bound properties since most cannot be modified by the end-user and hence are not appropriate for two-way binding.

Ext.Component
view source
: String
A UI style for a component. ...

A UI style for a component.

Defaults to: 'default'

Ext.Component
view source
: String[]private
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: []

The ViewModel is a data provider for this component and its children. ...

The ViewModel is a data provider for this component and its children. The data contained in the ViewModel is typically used by adding bind configs to the components that want present or edit this data.

When set, the ViewModel is created and links to any inherited viewModel instance from an ancestor container as the "parent". The ViewModel hierarchy, once established, only supports creation or destruction of children. The parent of a ViewModel cannot be changed on the fly.

If this is a root-level ViewModel, the data model connection is made to this component's associated Data Session. This is determined by calling getInheritedSession.

Defaults to: {$value: null, lazy: true}

Ext.Component
view source
: Number
A value to control how Components are laid out in a Border layout or as docked items. ...

A value to control how Components are laid out in a Border layout or as docked items.

In a Border layout, this can control how the regions (not the center) region lay out if the west or east take full height or if the north or south region take full width. Also look at the Ext.layout.container.Border.regionWeights on the Border layout. An example to show how you can take control of this is:

Ext.create('Ext.container.Viewport', {
    layout      : 'border',
    defaultType : 'panel',
    items       : [
        {
            region : 'north',
            title  : 'North',
            height : 100
        },
        {
            region : 'south',
            title  : 'South',
            height : 100,
            weight : -25
        },
        {
            region : 'west',
            title  : 'West',
            width  : 200,
            weight : 15
        },
        {
            region : 'east',
            title  : 'East',
            width  : 200
        },
        {
            region : 'center',
            title  : 'center'
        }
    ]
});

If docked items, the weight will order how the items are laid out. Here is an example to put a Ext.toolbar.Toolbar above a Ext.panel.Panel's header:

Ext.create('Ext.panel.Panel', {
    renderTo    : document.body,
    width       : 300,
    height      : 300,
    title       : 'Panel',
    html        : 'Panel Body',
    dockedItems : [
        {
            xtype : 'toolbar',
            items : [
                {
                    text : 'Save'
                }
            ]
        },
        {
            xtype  : 'toolbar',
            weight : -10,
            items  : [
                {
                    text : 'Remove'
                }
            ]
        }
    ]
});
The width of this component. ...

The width of this component. A numeric value will be interpreted as the number of pixels; a string value will be treated as a CSS value with units.

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

Ext.Component
view source
: Booleanprivate
We do not want "_hidden" style backing properties. ...

We do not want "_hidden" style backing properties.

Defaults to: false

Overrides: Ext.Base.$configPrefixed

Ext.Component
view source
: Booleanprivate
We also want non-config system properties to go to the instance. ...

We also want non-config system properties to go to the instance.

Defaults to: false

Overrides: Ext.Base.$configStrict

...

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

Ext.Component
view source
: Objectprivate
...

Defaults to: {isRoot: true}

Ext.Component
view source
: Booleanprotected
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

Ext.Component
view source
: Objectprivate
...

Defaults to: {isRoot: false}

...

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

This property holds one of the following values during the render process: 0 - The component is not rendered. ...

This property holds one of the following values during the render process:

  • 0 - The component is not rendered.
  • 1 - The component has fired beforerender and is about to call beforeRender. The component has just started rendering.
  • 2 - The component has finished the beforeRender process and is about to call onRender. This is when rendering is set to true.
  • 3 - The component has started onRender. This is when rendered is set to true.
  • 4 - The component has finished its afterrender process.

Defaults to: 0

Available since: 5.0.0

Ext.Component
view source
: Booleanprivate
private ...

private

Defaults to: true

Ext.Component
view source
: Booleanprivate
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

Ext.Component
view source
: Stringprivate
private ...

private

Defaults to: Ext.baseCSSPrefix + 'border-box'

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

The number of component layout calls made on this object.

Defaults to: 0

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'

By default this method does nothing but return the position spec passed to it. ...

By default this method does nothing but return the position spec passed to it. In rtl mode it is overridden to convert "l" to "r" and vice versa when required.

Ext.Component
view source
: Stringprotected
This property is used to determine the property of a bind config that is just the value. ...

This property is used to determine the property of a bind config that is just the value. For example, if defaultBindProperty="value", then this shorthand bind config:

 bind: '{name}'

Is equivalent to this object form:

 bind: {
     value: '{name}'
 }

The defaultBindProperty is set to "value" for form fields and to "store" for grids and trees.

Defaults to: 'html'

Overrides: Ext.mixin.Bindable.defaultBindProperty, Ext.Component.defaultBindProperty

Ext.Component
view source
: Booleanprivate
private ...

private

Defaults to: false

Ext.Component
view source
: Objectprivate

private

private

Ext.Component
view source
: RegExpprivate
http://www.w3.org/TR/html5/disabled-elements.html ...

http://www.w3.org/TR/html5/disabled-elements.html

Defaults to: /^(?:button|input|select|textarea|optgroup|option|fieldset)$/i

Initial suspended call count. ...

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

Defaults to: 0

Ext.Component
view source
: Ext.Containerreadonly
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

Plain Components are static, so not focusable ...

Plain Components are static, so not focusable

Defaults to: false

...

Defaults to: Ext.baseCSSPrefix + 'frame'

...

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

...

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

Ext.Component
view source
: Objectreadonly
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:

  • 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 id="{fgid}Table" data-ref="frameTable" class="{frameCls} ', Ext.baseCSSPrefix + 'table-plain" cellpadding="0" role="presentation">', '<tpl if="top">', '<tr role="presentation">', '<tpl if="left"><td id="{fgid}TL" data-ref="frameTL" 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" data-ref="frameTC" 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" data-ref="frameTR" 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 role="presentation">', '<tpl if="left"><td id="{fgid}ML" data-ref="frameML" 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}Body" data-ref="frameBody" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl>{frameElCls}" style="{mcStyle}" role="presentation">', '{%this.applyRenderTpl(out, values)%}', '</td>', '<tpl if="right"><td id="{fgid}MR" data-ref="frameMR" 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 role="presentation">', '<tpl if="left"><td id="{fgid}BL" data-ref="frameBL" 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" data-ref="frameBC" 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" data-ref="frameBR" class="{frameCls}-br {baseCls}-br {baseCls}-{ui}-br<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl>{frameElCls}" role="presentation"></td></tpl>', '</tr>', '</tpl>', '</table>', '{%this.renderDockedItems(out,values,1);%}']

...

Defaults to: ['{%this.renderDockedItems(out,values,0);%}', '<tpl if="top">', '<tpl if="left"><div id="{fgid}TL" data-ref="frameTL" 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" data-ref="frameTR" 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" data-ref="frameTC" 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" data-ref="frameML" 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" data-ref="frameMR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl>{frameElCls}" role="presentation"></tpl>', '<div id="{fgid}Body" data-ref="frameBody" 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" data-ref="frameBL" 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" data-ref="frameBR" 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" data-ref="frameBC" 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);%}']

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);
 }
Ext.Component
view source
: Stringprivate
private ...

private

Defaults to: 'left'

...

Defaults to: true

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

This property is set to true during the call to initConfig. ...

This property is set to true during the call to initConfig.

Defaults to: false

Available since: 5.0.0

This property is set to true if this instance is the first of its class. ...

This property is set to true if this instance is the first of its class.

Defaults to: false

Available since: 5.0.0

This value is true and is used to identify plain objects from instances of a defined class. ...

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to: true

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

private ...

private

Defaults to: 0

Ext.Component
view source
: Booleanprivate
Components that achieve their internal layout results using solely CSS with no JS intervention must set this to true. ...

Components that achieve their internal layout results using solely CSS with no JS intervention must set this to true. Failure to set this property to true may result in setSize failing to work if the component opted out of the layout run.

Defaults to: false

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: true

...

Defaults to: {id: 'inheritable'}

Overrides: Ext.mixin.Observable.mixinConfig

Ext.Component
view source
: Objectprivate
Ext.Component
view source
: Stringprivate
private ...

private

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

Ext.Component
view source
: Ext.Containerreadonly
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

Ext.Component
view source
: Objectprivate

End Positionable methods


Overridden in Ext.rtl.Component.


End Positionable methods


Overridden in Ext.rtl.Component.

Overrides: Ext.util.Focusable.privates

Ext.Component
view source
: Booleanreadonly
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

Ext.Component
view source
: Stringprivate
private ...

private

Defaults to: Ext.baseCSSPrefix + 'body'

Ext.Component
view source
: Objectreadonly
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:

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

Ext.Component
view source
: Stringprivate
private ...

private

Defaults to: Ext.baseCSSPrefix + 'touch-scroller'

Ext.Component
view source
: Stringprivate
...

Defaults to: '.' + Ext.baseCSSPrefix + 'touch-scroller'

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'
Ext.Component
view source
: Booleanprivate
This property is true if the component was created internally by the framework and is not explicitly user-defined. ...

This property is true if the component was created internally by the framework and is not explicitly user-defined. This is set for such things as Splitter instances managed by border and box layouts.

Defaults to: false

Ext.Component
view source
: Objectprivate
Regular expression used for validating reference values. ...

Regular expression used for validating reference values.

Defaults to: /^[a-z_][a-z0-9_]*$/i

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 Ext.Component.floating and zIndexParent

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

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

For Ext.Component.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 Ext.Component.floating and zIndexManager

Defined By

Static properties

...

Defaults to: []

Ext.Component
view source
: Numberprivatestatic
...

Defaults to: 1000

Ext.Component
view source
: Stringprivatestatic
...

Defaults to: 'bottom'

Ext.Component
view source
: Stringprivatestatic
...

Defaults to: 'left'

Ext.Component
view source
: Stringprivatestatic
...

Defaults to: 'right'

Ext.Component
view source
: Stringprivatestatic
Collapse/expand directions ...

Collapse/expand directions

Defaults to: 'top'

Ext.Component
view source
: RegExpprivatestatic
RegExp whih specifies characters in an xtype which must be translated to '-' when generating auto IDs. ...

RegExp whih specifies characters in an xtype which must be translated to '-' when generating auto IDs. This includes dot, comma and whitespace

Defaults to: /[\.,\s]/g

Ext.Component
view source
: RegExpprivatestatic
...

Defaults to: /^(?:top|bottom)$/

Ext.Component
view source
: Stringprivatestatic
Name of the element attribute containing its Component id. ...

Name of the element attribute containing its Component id. Used to look up Components by their Elements.

Defaults to: 'componentId'

Ext.Component
view source
: Numberprivatestatic
...

Defaults to: 0

Ext.Component
view source
: Objectprivatestatic

Methods

Defined By

Instance methods

Ext.Component
view source
new( config ) : Ext.Component
Creates new Component. ...

Creates new Component.

Parameters

  • config : Ext.dom.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.util.Floating.constructor, Ext.Component.constructor

Adds declarative listeners as nested arrays of listener objects. ...

Adds declarative listeners as nested arrays of listener objects.

Parameters

Returns

  • Boolean

    true if any listeners were added

Fires

    Ensures that the given property (if it is a Config System config) has a proper "updater" method on this instance to s...

    Ensures that the given property (if it is a Config System config) has a proper "updater" method on this instance to sync changes to the config.

    Available since: 5.0.0

    Parameters

    • property : String

      The name of the config property.

    Fires

      Ext.Component
      view source
      ( cls ) : Ext.Componentdeprecated
      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

      Ext.Component
      view source
      ( cls ) : Ext.Component
      Adds a CSS class to the top level element representing this component. ...

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

      Parameters

      Returns

      Ext.Component
      view source
      ( classes, [skip] )
      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.

      Parameters

      • classes : String/String[]

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

      • skip : Boolean (optional)

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

      Fires

        ( deprecations )private
        This method applies a versioned, deprecation declaration to this class. ...

        This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

        Parameters

        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.

        Fires

          Ext.Component
          view source
          ( element, listeners, scope, options ) : Object
          The on method is shorthand for addListener. ...

          The on method is shorthand for addListener.

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

          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.

            Parameters

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

              Ext.Component
              view source
              ( plugin )private
              Adds a plugin. ...

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

              Parameters

              Fires

                Ext.Component
                view source
                ( 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.

                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.

                  Parameters

                  • events : String/String[]

                    The event name or an array of event names.

                  Fires

                    Ext.Component
                    view source
                    ( uiCls )protected
                    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 add the UI to more than just the component's element.

                    Parameters

                    • uiCls : String

                      The UI class to add to the element.

                    Fires

                      Ext.Component
                      view source
                      ( )private
                      Method which adds a specified UI to the components element. ...

                      Method which adds a specified UI to the components element.

                      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?

                        Parameters

                        Fires

                          Ext.Component
                          view source
                          ( x, y )private
                          private ...

                          private

                          Parameters

                          Fires

                            Called after the mixin is applied. ...

                            Called after the mixin is applied. We need to see if childEls were used by the targetClass and apply them to the config.

                            Parameters

                            Ext.Component
                            view source
                            ( width, height, oldWidth, oldHeight )protectedtemplate
                            Called by the layout system after the Component has been laid out. ...

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

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

                            Parameters

                            • width : Number

                              The width that was set

                            • height : Number

                              The height that was set

                            • oldWidth : Number/undefined

                              The old width, or undefined if this was the initial layout.

                            • oldHeight : Number/undefined

                              The old height, or undefined if this was the initial layout.

                            Fires

                            ...

                            Parameters

                            Fires

                            • boxready
                            • move
                            Ext.Component
                            view source
                            ( [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.

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

                            Parameters

                            Fires

                            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.

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

                            Fires

                            • move
                            Ext.Component
                            view source
                            ( x, y )protectedtemplate
                            Template method called after a Component has been positioned. ...

                            Template method called after a Component has been positioned.

                            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.util.Positionable.afterSetPosition

                            Ext.Component
                            view source
                            ( [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.

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

                            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] Element animation config object

                            Returns

                            Fires

                              ( anchorToEl, [alignment], [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.

                              Parameters

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

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

                              • alignment : 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.

                                Parameters

                                Fires

                                  Ext.Component
                                  view source
                                  ( animObj ) : Object
                                  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%',
                                          margin: '5 0 5 5',
                                          flex: 1
                                      }, {
                                          title: 'Left: 66%',
                                          margin: '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.

                                  Parameters

                                  Returns

                                  Fires

                                    Overrides: Ext.util.Animate.animate

                                    ( binds, currentBindings ) : Objectprivate
                                    ...

                                    Available since: 5.0.0

                                    Parameters

                                    Returns

                                    Fires

                                      Ext.Component
                                      view source
                                      ( data )private
                                      ...

                                      Parameters

                                      Fires

                                        Sets references to elements inside the component. ...

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

                                        Fires

                                          Transforms a Session config to a proper instance. ...

                                          Transforms a Session config to a proper instance.

                                          Available since: 5.0.0

                                          Parameters

                                          Returns

                                          Fires

                                            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.

                                            Parameters

                                            Transforms a ViewModel config to a proper instance. ...

                                            Transforms a ViewModel config to a proper instance.

                                            Available since: 5.0.0

                                            Parameters

                                            Returns

                                            Fires

                                              Sets references to elements inside the component. ...

                                              Sets references to elements inside the component.

                                              Parameters

                                              Fires

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

                                                Template method to do any pre-blur processing.

                                                Parameters

                                                Ext.Component
                                                view source
                                                ( 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.

                                                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.Component
                                                view source
                                                ( )protectedtemplate
                                                Invoked before the Component is destroyed. ...

                                                Invoked before the Component is destroyed.

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

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

                                                Template method to do any pre-focus processing.

                                                Parameters

                                                Ext.Component
                                                view source
                                                ( )private
                                                ...
                                                Ext.Component
                                                view source
                                                ( )protectedtemplate
                                                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.

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

                                                Fires

                                                  Ext.Component
                                                  view source
                                                  ( x, y, animate )private
                                                  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.

                                                  Parameters

                                                  Fires

                                                    Ext.Component
                                                    view source
                                                    ( )protectedtemplate
                                                    Invoked before the Component is shown. ...

                                                    Invoked before the Component is shown.

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

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

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

                                                    Parameters

                                                    • fn : Function

                                                      The function to call

                                                    • scope : Object (optional)

                                                      The scope of the function. Defaults to current node.

                                                    • args : Array (optional)

                                                      The args to call the function with. Defaults to passing the current component.

                                                    Returns

                                                    Fires

                                                      Ensures that all elements with "data-ref" attributes get loaded into the cache. ...

                                                      Ensures that all elements with "data-ref" attributes get loaded into the cache. This really helps on IE8 where getElementById is a search not a lookup. By populating our cache with one search of the DOM we then have random access to the elements as we do our childEls wire up.

                                                      Parameters

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

                                                      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[]private
                                                        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.

                                                        Parameters

                                                        • constrainTo : String/HTMLElement/Ext.dom.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"
                                                          

                                                          This method has been deprecated

                                                          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.

                                                          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', {
                                                               extend: 'Ext.some.Class',
                                                          
                                                               method: function () {
                                                                   console.log('Bad');
                                                          
                                                                   // ... logic but with a bug ...
                                                          
                                                                   this.callParent();
                                                               }
                                                           });
                                                          

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

                                                           Ext.define('App.patches.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".

                                                          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

                                                          Fires

                                                            ...

                                                            Parameters

                                                            Center this Component in its container. ...

                                                            Center this Component in its container.

                                                            Returns

                                                            Fires

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

                                                            Removes all listeners for this object including the managed listeners

                                                            Fires

                                                              Removes all managed listeners for this object. ...

                                                              Removes all managed listeners for this object.

                                                              Fires

                                                                Ext.Component
                                                                view source
                                                                ( overrides ) : Ext.Component
                                                                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.

                                                                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

                                                                ...

                                                                Parameters

                                                                Fires

                                                                  Ext.Component
                                                                  view source
                                                                  ( ptype )private
                                                                  ...

                                                                  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.

                                                                  Ext.Component
                                                                  view source
                                                                  ( )private
                                                                  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.

                                                                  Fires

                                                                    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.

                                                                    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

                                                                    Ext.Component
                                                                    view source
                                                                    ( )private
                                                                    Destroys the Component. ...

                                                                    Destroys the Component. This method must not be overridden. To add extra functionality to destruction time in a subclass, implement the template method or {@link #onDestroy. And do not forget to callParent() in your implementation.

                                                                    Available since: 1.1.0

                                                                    Fires

                                                                    Overrides: Ext.Base.destroy

                                                                    Ext.Component
                                                                    view source
                                                                    ( [silent] )
                                                                    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.

                                                                    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

                                                                    Fires

                                                                    • afterrender
                                                                    • beforerender
                                                                    • render
                                                                    Ext.Component
                                                                    view source
                                                                    ( ) : Ext.Componentchainabledeprecated
                                                                    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.

                                                                    This method has been deprecated since 4.1

                                                                    Use updateLayout instead.

                                                                    Returns

                                                                    Fires

                                                                      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.

                                                                      Parameters

                                                                      • constrainTo : String/HTMLElement/Ext.dom.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
                                                                      ( eventName, args, bubbles )private
                                                                      Continue to fire event. ...

                                                                      Continue to fire event.

                                                                      Parameters

                                                                      Fires

                                                                        Ext.Component
                                                                        view source
                                                                        ( [silent] )
                                                                        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');
                                                                                }
                                                                            }
                                                                        });
                                                                        

                                                                        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.

                                                                        Parameters

                                                                        • runLayout : Boolean (optional)

                                                                          True to run the component's layout.

                                                                          Defaults to: false

                                                                        Fires

                                                                        • move
                                                                        Ext.Component
                                                                        view source
                                                                        ( node )private
                                                                        Walk the DOM tree upwards and find the Component these elements belong to. ...

                                                                        Walk the DOM tree upwards and find the Component these elements belong to.

                                                                        Parameters

                                                                        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.

                                                                        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.

                                                                          Parameters

                                                                          • xtype : String/Ext.Class

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

                                                                          Returns

                                                                          Fires

                                                                            Retrieves plugin from this component's collection by its ptype. ...

                                                                            Retrieves plugin from this component's collection by its ptype.

                                                                            Parameters

                                                                            • ptype : String

                                                                              The Plugin's ptype as specified by the class's alias configuration.

                                                                            Returns

                                                                            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.

                                                                            Parameters

                                                                            • containerIdx : Number

                                                                              The index into the Container items of this Component.

                                                                            Fires

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

                                                                            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.

                                                                              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

                                                                                Ext.Component
                                                                                view source
                                                                                ( eventName )private
                                                                                This method fires an event on Ext.GlobalEvents allowing interested parties to know of certain critical events for thi...

                                                                                This method fires an event on Ext.GlobalEvents allowing interested parties to know of certain critical events for this component. This is done globally because the (few) listeners can immediately receive the event rather than bubbling the event only to reach the top and have no listeners.

                                                                                The main usage for these events is to do with floating components. For example, the load mask is a floating component. The component it is masking may be inside several containers. As such, they need to know when component is hidden, either directly, or via a parent container being hidden. To do this they subscribe to these events and filter out the appropriate container.

                                                                                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 so that its hidden state can be synchronized.

                                                                                Available since: 4.2.0

                                                                                Parameters

                                                                                • eventName : String

                                                                                  The event name.

                                                                                ...

                                                                                Parameters

                                                                                Fires

                                                                                • move
                                                                                Sets up a reference on our current reference holder. ...

                                                                                Sets up a reference on our current reference holder.

                                                                                Fires

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

                                                                                  Try to focus this component.

                                                                                  Parameters

                                                                                  • selectText : Mixed (optional)

                                                                                    If applicable, true to also select all the text in this component, or an array consisting of start and end (defaults to start) position of selection.

                                                                                  • delay : Boolean/Number (optional)

                                                                                    Delay the focus this number of milliseconds (true for 10 milliseconds).

                                                                                  • callback : Function (optional)

                                                                                    Only needed if the delay parameter is used. A function to call upon focus.

                                                                                  • scope : Function (optional)

                                                                                    Only needed if the delay parameter is used. The scope (this reference) in which to execute the callback.

                                                                                  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

                                                                                  • tofront
                                                                                  Ext.Component
                                                                                  view source
                                                                                  ( [options] )deprecated
                                                                                  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.

                                                                                  This method has been deprecated since 4.1

                                                                                  Use updateLayout instead.

                                                                                  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.

                                                                                  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.

                                                                                  Returns

                                                                                  Ext.Component
                                                                                  view source
                                                                                  ( ) : Ext.Component/nullprivate
                                                                                  Return the currently active (focused) Component ...

                                                                                  Return the currently active (focused) Component

                                                                                  Returns

                                                                                  Returns the value of activeCounter. ...

                                                                                  Returns the value of activeCounter.

                                                                                  Returns

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

                                                                                  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

                                                                                    Returns the value of alwaysOnTop. ...

                                                                                    Returns the value of alwaysOnTop.

                                                                                    Returns

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


                                                                                    Begin Positionable methods


                                                                                    Overridden in Ext.rtl.Component.

                                                                                    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.

                                                                                    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

                                                                                      Ext.Component
                                                                                      view source
                                                                                      ( target )private
                                                                                      ...

                                                                                      Parameters

                                                                                      get animation properties ...
                                                                                      • get animation properties
                                                                                      Ext.Component
                                                                                      view source
                                                                                      ( )private
                                                                                      ...
                                                                                      Returns the value of bind. ...

                                                                                      Returns the value of bind.

                                                                                      Returns

                                                                                      Ext.Component
                                                                                      view source
                                                                                      ( ) : Objectprivate
                                                                                      Overridden in Ext.rtl.Component. ...

                                                                                      Overridden in Ext.rtl.Component.

                                                                                      Returns

                                                                                      • Object

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

                                                                                      Overrides: Ext.util.Positionable.getBorderPadding

                                                                                      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.

                                                                                      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

                                                                                        An object in the format

                                                                                        • x : Number

                                                                                          The element's X position.

                                                                                        • y : Number

                                                                                          The element's Y position.

                                                                                        • width : Number

                                                                                          The element's width.

                                                                                        • height : Number

                                                                                          The element's height.

                                                                                        • bottom : Number

                                                                                          The element's lower bound.

                                                                                        • right : Number

                                                                                          The 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

                                                                                        Returns

                                                                                        Fires

                                                                                          Ext.Component
                                                                                          view source
                                                                                          ( )protected
                                                                                          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.

                                                                                          Fires

                                                                                            Returns the value of childEls. ...

                                                                                            Returns the value of childEls.

                                                                                            Returns

                                                                                            Ext.Component
                                                                                            view source
                                                                                            ( el ) : Ext.Component/nullprivate
                                                                                            Find a Component that the given Element belongs to. ...

                                                                                            Find a Component that the given Element belongs to.

                                                                                            Parameters

                                                                                            Returns

                                                                                            Ext.Component
                                                                                            view source
                                                                                            ( )private
                                                                                            ...

                                                                                            Fires

                                                                                              Returns a specified config property value. ...

                                                                                              Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

                                                                                              Parameters

                                                                                              • name : String (optional)

                                                                                                The name of the config property to get.

                                                                                              • peek : Boolean (optional)

                                                                                                true to peek at the raw value without calling the getter.

                                                                                                Defaults to: false

                                                                                              Returns

                                                                                              • Object

                                                                                                The config property value.

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

                                                                                              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

                                                                                                Ext.Component
                                                                                                view source
                                                                                                ( ) : Object
                                                                                                Returns the value of data. ...

                                                                                                Returns the value of data.

                                                                                                Available since: 3.4.0

                                                                                                Returns

                                                                                                Returns the value of defaultListenerScope. ...

                                                                                                Returns the value of defaultListenerScope.

                                                                                                Returns

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

                                                                                                Retrieves the top level element representing this component.

                                                                                                Available since: 1.1.0

                                                                                                Returns

                                                                                                Returns the focus styling holder element associated with this Focusable. ...

                                                                                                Returns the focus styling holder element associated with this Focusable. By default it is the same element as getFocusEl.

                                                                                                Returns

                                                                                                Fires

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

                                                                                                  Returns the focus holder element associated with this Focusable. At the Focusable base mixin 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.

                                                                                                  Returns

                                                                                                  • Ext.Element

                                                                                                    undefined because raw Focusables cannot by default hold focus.

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

                                                                                                  On render, reads an encoded style attribute, "filter" 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.

                                                                                                  Fires

                                                                                                    ...

                                                                                                    Parameters

                                                                                                    Fires

                                                                                                      Ext.Component
                                                                                                      view source
                                                                                                      ( ) : Number
                                                                                                      Gets the current height of the component's underlying element. ...

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

                                                                                                      Returns

                                                                                                      Ext.Component
                                                                                                      view source
                                                                                                      ( ) : String
                                                                                                      Retrieves the id of this component. ...

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

                                                                                                      Returns

                                                                                                      Fires

                                                                                                        This method returns an object containing the inherited properties for this instance. ...

                                                                                                        This method returns an object containing the inherited properties for this instance.

                                                                                                        Available since: 5.0.0

                                                                                                        Parameters

                                                                                                        • inner : Boolean (optional)

                                                                                                          Pass true to return inheritedStateInner instead of the normal inheritedState object. This is only needed internally and should not be passed by user code.

                                                                                                          Defaults to: false

                                                                                                        Returns

                                                                                                        • Object

                                                                                                          The inheritedState object containing inherited properties.

                                                                                                        Fires

                                                                                                          This method returns the value of a config property that may be inherited from some ancestor. ...

                                                                                                          This method returns the value of a config property that may be inherited from some ancestor.

                                                                                                          In some cases, a config may be explicitly set on a component with the intent of only being presented to its children while that component should act upon the inherited value (see referenceHolder for example). In these cases the skipThis parameter should be specified as true.

                                                                                                          Available since: 5.0.0

                                                                                                          Parameters

                                                                                                          • property : String

                                                                                                            The name of the config property to return.

                                                                                                          • skipThis : Boolean (optional)

                                                                                                            Pass true if the property should be ignored if found on this instance. In other words, true means the property must be inherited and not explicitly set on this instance.

                                                                                                            Defaults to: false

                                                                                                          Returns

                                                                                                          • Mixed

                                                                                                            The value of the requested property.

                                                                                                          Fires

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

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

                                                                                                            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.

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

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

                                                                                                            Parameters

                                                                                                            Returns

                                                                                                            • HTMLElement

                                                                                                              DOM element that you can use in the insertBefore

                                                                                                            Ext.Component
                                                                                                            view source
                                                                                                            ( ) : String
                                                                                                            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.

                                                                                                            Returns

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

                                                                                                            Gets the Ext.ComponentLoader for this Component.

                                                                                                            Returns

                                                                                                            Ext.Component
                                                                                                            view source
                                                                                                            ( ) : Number
                                                                                                            Overridden in Ext.rtl.Component. ...

                                                                                                            Overridden in Ext.rtl.Component.

                                                                                                            Returns

                                                                                                            Overrides: Ext.util.Positionable.getLocalX

                                                                                                            Ext.Component
                                                                                                            view source
                                                                                                            ( ) : Number[]
                                                                                                            Overridden in Ext.rtl.Component. ...

                                                                                                            Overridden in Ext.rtl.Component.

                                                                                                            Returns

                                                                                                            • Number[]

                                                                                                              The local XY position of the element

                                                                                                            Overrides: Ext.util.Positionable.getLocalXY

                                                                                                            Ext.Component
                                                                                                            view source
                                                                                                            ( ) : Number
                                                                                                            Returns the y coordinate of this element reletive to its offsetParent. ...

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

                                                                                                            Returns

                                                                                                            Overrides: Ext.util.Positionable.getLocalY

                                                                                                            Ext.Component
                                                                                                            view source
                                                                                                            ( )protected
                                                                                                            Returns the element which is masked by the mask method, or into which the LoadMask is rendered into. ...

                                                                                                            Returns the element which is masked by the mask method, or into which the LoadMask is rendered into.

                                                                                                            The default implementation uses the maskElement configuration to access the Component's child element by name. By default, maskElement is null which means that null is returned from this method indicating that the mask needs to be rendered into the document because component structure should not be contaminated by mask elements.

                                                                                                            Some subclasses may override this method if they have knowledge about external structures where a mask could usefully be rendered.

                                                                                                            For example a GridView will request that its owning GridPanel be masked. The GridPanel will have its own implementation of getMaskTarget which will return the element dicated by its own maskElement Panels use "el" as their maskElement by default, but that could be overridden to be "body" to leave toolbars and the header mouse-accessible.

                                                                                                            Returns the value of maxHeight. ...

                                                                                                            Returns the value of maxHeight.

                                                                                                            Returns

                                                                                                            Ext.Component
                                                                                                            view source
                                                                                                            ( ) : Number
                                                                                                            Returns the value of maxWidth. ...

                                                                                                            Returns the value of maxWidth.

                                                                                                            Returns

                                                                                                            Returns the value of minHeight. ...

                                                                                                            Returns the value of minHeight.

                                                                                                            Returns

                                                                                                            Ext.Component
                                                                                                            view source
                                                                                                            ( ) : Number
                                                                                                            Returns the value of minWidth. ...

                                                                                                            Returns the value of minWidth.

                                                                                                            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.

                                                                                                            Parameters

                                                                                                            Returns

                                                                                                            • Number[]

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

                                                                                                            Fires

                                                                                                              Ext.Component
                                                                                                              view source
                                                                                                              ( )private
                                                                                                              Get an el for overflowing, defaults to the target el ...

                                                                                                              Get an el for overflowing, defaults to the target el

                                                                                                              Fires

                                                                                                                Ext.Component
                                                                                                                view source
                                                                                                                ( )private
                                                                                                                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.

                                                                                                                Returns the owning container if that container uses border layout. ...

                                                                                                                Returns the owning container if that container uses border layout. Otherwise this method returns null.

                                                                                                                Defined in override Ext.layout.container.border.Region.

                                                                                                                Returns

                                                                                                                Fires

                                                                                                                  Returns the owning border (Ext.layout.container.Border) instance if there is one. ...

                                                                                                                  Returns the owning border (Ext.layout.container.Border) instance if there is one. Otherwise this method returns null.

                                                                                                                  Defined in override Ext.layout.container.border.Region.

                                                                                                                  Returns

                                                                                                                  Ext.Component
                                                                                                                  view source
                                                                                                                  ( pluginId ) : Ext.plugin.Abstract
                                                                                                                  Retrieves a plugin from this component's collection by its pluginId. ...

                                                                                                                  Retrieves a plugin from this component's collection by its pluginId.

                                                                                                                  Parameters

                                                                                                                  Returns

                                                                                                                  Ext.Component
                                                                                                                  view source
                                                                                                                  ( )private
                                                                                                                  Returns an array of current fully constructed plugin instances. ...

                                                                                                                  Returns an array of current fully constructed plugin instances.

                                                                                                                  Fires

                                                                                                                    Ext.Component
                                                                                                                    view source
                                                                                                                    ( [local] ) : Number[]
                                                                                                                    Gets the current XY position of the component's underlying element. ...

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

                                                                                                                    Parameters

                                                                                                                    • local : Boolean (optional)

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

                                                                                                                      Defaults to: false

                                                                                                                    Returns

                                                                                                                    • Number[]

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

                                                                                                                    Fires

                                                                                                                      Returns the value of publishes. ...

                                                                                                                      Returns the value of publishes.

                                                                                                                      Available since: 5.0.0

                                                                                                                      Returns

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

                                                                                                                      Returns the value of reference. ...

                                                                                                                      Returns the value of reference.

                                                                                                                      Returns

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

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

                                                                                                                      Returns

                                                                                                                      Fires

                                                                                                                        ...

                                                                                                                        Fires

                                                                                                                        • beforerender
                                                                                                                        Ext.Component
                                                                                                                        view source
                                                                                                                        ( ) : Number
                                                                                                                        Returns the "x" scroll position for this component. ...

                                                                                                                        Returns the "x" scroll position for this component. Only applicable for components that have been configured with autoScroll or overflowX.

                                                                                                                        Returns

                                                                                                                        Fires

                                                                                                                          Ext.Component
                                                                                                                          view source
                                                                                                                          ( ) : Number
                                                                                                                          Returns the "y" scroll position for this component. ...

                                                                                                                          Returns the "y" scroll position for this component. Only applicable for components that have been configured with autoScroll or overflowY.

                                                                                                                          Returns

                                                                                                                          Fires

                                                                                                                            Returns the value of session. ...

                                                                                                                            Returns the value of session.

                                                                                                                            Returns

                                                                                                                            Ext.Component
                                                                                                                            view source
                                                                                                                            ( [contentSize] ) : Object
                                                                                                                            Gets the current size of the component's underlying element. ...

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

                                                                                                                            Parameters

                                                                                                                            • contentSize : Boolean (optional)

                                                                                                                              true to get the width/size minus borders and padding

                                                                                                                            Returns

                                                                                                                            Ext.Component
                                                                                                                            view source
                                                                                                                            ( ownerCtSizeModel ) : Objectprotected
                                                                                                                            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.

                                                                                                                            Parameters

                                                                                                                            Returns

                                                                                                                            Ext.Component
                                                                                                                            view source
                                                                                                                            ( ) : Object
                                                                                                                            The supplied default state gathering method for the Component class. ...

                                                                                                                            The supplied default state gathering method for the Component 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.

                                                                                                                            Returns

                                                                                                                            Fires

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

                                                                                                                              Gets the state id for this object. ...

                                                                                                                              Gets the state id for this object.

                                                                                                                              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.

                                                                                                                              Parameters

                                                                                                                              Return the actual tabIndex for this Focusable. ...

                                                                                                                              Return the actual tabIndex for this Focusable.

                                                                                                                              Returns

                                                                                                                              • Number

                                                                                                                                tabIndex attribute value

                                                                                                                              Fires

                                                                                                                                Ext.Component
                                                                                                                                view source
                                                                                                                                ( )private
                                                                                                                                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.

                                                                                                                                Ext.Component
                                                                                                                                view source
                                                                                                                                ( )private
                                                                                                                                Needed for when widget is rendered into a grid cell. ...

                                                                                                                                Needed for when widget is rendered into a grid cell. The class to add to the cell element.

                                                                                                                                Fires

                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( )private
                                                                                                                                  Partner method to getTdCls. ...

                                                                                                                                  Partner method to getTdCls.

                                                                                                                                  Returns the base type for the component. Defaults to return this.xtype, but All derived classes of TextField can return the type 'textfield', and all derived classes of Button can return the type 'button'

                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( name )private
                                                                                                                                  ...

                                                                                                                                  Parameters

                                                                                                                                  Returns the value of twoWayBindable. ...

                                                                                                                                  Returns the value of twoWayBindable.

                                                                                                                                  Returns

                                                                                                                                  Returns the value of viewModel. ...

                                                                                                                                  Returns the value of viewModel.

                                                                                                                                  Returns

                                                                                                                                  Returns the content region of this element. ...

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

                                                                                                                                  Returns

                                                                                                                                  • Ext.util.Region

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

                                                                                                                                  Fires

                                                                                                                                    Ext.Component
                                                                                                                                    view source
                                                                                                                                    ( ) : Number
                                                                                                                                    Gets the current width of the component's underlying element. ...

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

                                                                                                                                    Returns

                                                                                                                                    Ext.Component
                                                                                                                                    view source
                                                                                                                                    ( ) : Number
                                                                                                                                    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.

                                                                                                                                    Returns

                                                                                                                                    • Number

                                                                                                                                      The X position of the element

                                                                                                                                    Overrides: Ext.util.Positionable.getX

                                                                                                                                    Ext.Component
                                                                                                                                    view source
                                                                                                                                    ( ) : String
                                                                                                                                    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'
                                                                                                                                    

                                                                                                                                    Returns

                                                                                                                                    Ext.Component
                                                                                                                                    view source
                                                                                                                                    ( ) : String
                                                                                                                                    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

                                                                                                                                    Ext.Component
                                                                                                                                    view source
                                                                                                                                    ( ) : Number[]
                                                                                                                                    Gets the current position of the DOM element based on page coordinates. ...

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

                                                                                                                                    Returns

                                                                                                                                    • Number[]

                                                                                                                                      The XY position of the element

                                                                                                                                    Overrides: Ext.util.Positionable.getXY

                                                                                                                                    Ext.Component
                                                                                                                                    view source
                                                                                                                                    ( ) : Number
                                                                                                                                    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.

                                                                                                                                    Returns

                                                                                                                                    • Number

                                                                                                                                      The Y position of the element

                                                                                                                                    Overrides: Ext.util.Positionable.getY

                                                                                                                                    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.

                                                                                                                                    This method has been deprecated since 4.0

                                                                                                                                    Replaced by getActiveAnimation

                                                                                                                                    Returns

                                                                                                                                    Ext.Component
                                                                                                                                    view source
                                                                                                                                    ( className ) : Boolean
                                                                                                                                    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.

                                                                                                                                    Parameters

                                                                                                                                    • className : String

                                                                                                                                      The CSS class to check for.

                                                                                                                                    Returns

                                                                                                                                    • Boolean

                                                                                                                                      true if the class exists, else false.

                                                                                                                                    ...

                                                                                                                                    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.

                                                                                                                                    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

                                                                                                                                    Ext.Component
                                                                                                                                    view source
                                                                                                                                    ( cls )
                                                                                                                                    Checks if there is currently a specified uiCls. ...

                                                                                                                                    Checks if there is currently a specified uiCls.

                                                                                                                                    Parameters

                                                                                                                                    • cls : String

                                                                                                                                      The cls to check.

                                                                                                                                    Ext.Component
                                                                                                                                    view source
                                                                                                                                    ( [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.

                                                                                                                                    Parameters

                                                                                                                                    • animateTarget : String/Ext.dom.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

                                                                                                                                    This method triggers the lazy configs and must be called when it is time to fully boot up. ...

                                                                                                                                    This method triggers the lazy configs and must be called when it is time to fully boot up. The configs that must be initialized are: bind, publishes, session, twoWayBindable and viewModel.

                                                                                                                                    Available since: 5.0.0

                                                                                                                                    Fires

                                                                                                                                      Ext.Component
                                                                                                                                      view source
                                                                                                                                      ( )private
                                                                                                                                      This method is called by the Ext.layout.container.Border class when instances are added as regions to the layout. ...

                                                                                                                                      This method is called by the Ext.layout.container.Border class when instances are added as regions to the layout. Since it is valid to add any component to a border layout as a region, this method must be added to Ext.Component but is only ever called when that component is owned by a border layout.

                                                                                                                                      Defined in override Ext.layout.container.border.Region.

                                                                                                                                      Fires

                                                                                                                                        Ext.Component
                                                                                                                                        view source
                                                                                                                                        ( )protectedtemplate
                                                                                                                                        The initComponent template method is an important initialization step for a Component. ...

                                                                                                                                        The initComponent template method is an important initialization step for a Component. It is intended to be implemented by each subclass of Ext.Component to provide any needed constructor logic. The initComponent method of the class being created is called first, with each initComponent method up the hierarchy to Ext.Component being called thereafter. This makes it easy to implement and, if needed, override the constructor logic of the Component at any step in the hierarchy.

                                                                                                                                        The initComponent method must contain a call to callParent in order to ensure that the parent class' initComponent method is also called.

                                                                                                                                        All config options passed to the constructor are applied to this before initComponent is called, so you can simply access them with this.someOption.

                                                                                                                                        The following example demonstrates using a dynamic string for the text of a button at the time of instantiation of the class.

                                                                                                                                        Ext.define('DynamicButtonText', {
                                                                                                                                            extend: 'Ext.button.Button',
                                                                                                                                        
                                                                                                                                            initComponent: function() {
                                                                                                                                                this.text = new Date();
                                                                                                                                                this.renderTo = Ext.getBody();
                                                                                                                                                this.callParent();
                                                                                                                                            }
                                                                                                                                        });
                                                                                                                                        
                                                                                                                                        Ext.onReady(function() {
                                                                                                                                            Ext.create('DynamicButtonText');
                                                                                                                                        });
                                                                                                                                        

                                                                                                                                        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

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

                                                                                                                                          Parameters

                                                                                                                                          Returns

                                                                                                                                          Fires

                                                                                                                                            Ext.Component
                                                                                                                                            view source
                                                                                                                                            ( )protected
                                                                                                                                            Initialize any events on this component ...

                                                                                                                                            Initialize any events on this component

                                                                                                                                            Fires

                                                                                                                                              Template method to do any Focusable related initialization that does not involve event listeners creation. ...

                                                                                                                                              Template method to do any Focusable related initialization that does not involve event listeners creation.

                                                                                                                                              Template method to do any event listener initialization for a Focusable. ...

                                                                                                                                              Template method to do any event listener initialization for a Focusable. This generally happens after the focusEl is available.

                                                                                                                                              Fires

                                                                                                                                                Ext.Component
                                                                                                                                                view source
                                                                                                                                                ( inheritedState )protected
                                                                                                                                                Called by getInherited to initialize the inheritedState the first time it is requested. ...

                                                                                                                                                Called by getInherited to initialize the inheritedState the first time it is requested.

                                                                                                                                                Overridden in Ext.rtl.Component.

                                                                                                                                                Parameters

                                                                                                                                                Overrides: Ext.mixin.Bindable.initInheritedState

                                                                                                                                                Ext.Component
                                                                                                                                                view source
                                                                                                                                                ( targetEl )private
                                                                                                                                                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".

                                                                                                                                                Parameters

                                                                                                                                                Fires

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

                                                                                                                                                  Initialized the renderData to be used when rendering the renderTpl.

                                                                                                                                                  Returns

                                                                                                                                                  • Object

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

                                                                                                                                                  Initializes the renderTpl. ...

                                                                                                                                                  Initializes the renderTpl.

                                                                                                                                                  Returns

                                                                                                                                                  Fires

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

                                                                                                                                                    Initializes the state of the object upon construction.

                                                                                                                                                    Fires

                                                                                                                                                    Ext.Component
                                                                                                                                                    view source
                                                                                                                                                    ( targetEl )private
                                                                                                                                                    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.

                                                                                                                                                    Parameters

                                                                                                                                                    Fires

                                                                                                                                                      This method marks the current inherited state as invalid. ...

                                                                                                                                                      This method marks the current inherited state as invalid. The next time a call is made to getInherited the objects will be recreated and initialized.

                                                                                                                                                      Available since: 5.0.0

                                                                                                                                                      Ext.Component
                                                                                                                                                      view source
                                                                                                                                                      ( selector ) : Boolean
                                                                                                                                                      Tests whether this Component matches a ComponentQuery selector string. ...

                                                                                                                                                      Tests whether this Component matches a ComponentQuery selector string.

                                                                                                                                                      Parameters

                                                                                                                                                      • selector : String

                                                                                                                                                        The selector string to test against.

                                                                                                                                                      Returns

                                                                                                                                                      • Boolean

                                                                                                                                                        true if this Component matches the selector.

                                                                                                                                                      Ext.Component
                                                                                                                                                      view source
                                                                                                                                                      ( container ) : Boolean
                                                                                                                                                      Determines whether this component is the descendant of a particular container. ...

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

                                                                                                                                                      Parameters

                                                                                                                                                      Returns

                                                                                                                                                      • Boolean

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

                                                                                                                                                      Fires

                                                                                                                                                        Ext.Component
                                                                                                                                                        view source
                                                                                                                                                        ( ) : Boolean
                                                                                                                                                        Method to determine whether this Component is currently disabled. ...

                                                                                                                                                        Method to determine whether this Component is currently disabled.

                                                                                                                                                        Returns

                                                                                                                                                        • Boolean

                                                                                                                                                          the disabled state of this Component.

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

                                                                                                                                                        Method to determine whether this Component is draggable.

                                                                                                                                                        Returns

                                                                                                                                                        • Boolean

                                                                                                                                                          the draggable state of this component.

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

                                                                                                                                                        Method to determine whether this Component is droppable.

                                                                                                                                                        Returns

                                                                                                                                                        • Boolean

                                                                                                                                                          the droppable state of this component.

                                                                                                                                                        Ext.Component
                                                                                                                                                        view source
                                                                                                                                                        ( ) : Boolean
                                                                                                                                                        Method to determine whether this Component is floating. ...

                                                                                                                                                        Method to determine whether this Component is floating.

                                                                                                                                                        Returns

                                                                                                                                                        • Boolean

                                                                                                                                                          the floating state of this component.

                                                                                                                                                        Ext.Component
                                                                                                                                                        view source
                                                                                                                                                        ( ) : Boolean
                                                                                                                                                        Method to determine whether this Component is currently set to hidden. ...

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

                                                                                                                                                        Returns

                                                                                                                                                        • Boolean

                                                                                                                                                          the hidden state of this Component.

                                                                                                                                                        Ext.Component
                                                                                                                                                        view source
                                                                                                                                                        ( )private
                                                                                                                                                        ...

                                                                                                                                                        Fires

                                                                                                                                                          Ext.Component
                                                                                                                                                          view source
                                                                                                                                                          ( )protected
                                                                                                                                                          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.

                                                                                                                                                          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.

                                                                                                                                                          Returns

                                                                                                                                                          • Boolean

                                                                                                                                                            true layout of this component is suspended.

                                                                                                                                                          Ext.Component
                                                                                                                                                          view source
                                                                                                                                                          ( ) : Booleanprivate
                                                                                                                                                          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.Component.

                                                                                                                                                          Returns

                                                                                                                                                          Fires

                                                                                                                                                            Ext.Component
                                                                                                                                                            view source
                                                                                                                                                            ( [deep] ) : Boolean
                                                                                                                                                            Returns masked state for this Component. ...

                                                                                                                                                            Returns masked state for this Component.

                                                                                                                                                            Parameters

                                                                                                                                                            • deep : Boolean (optional)

                                                                                                                                                              True to look up this Component's parent masked state.

                                                                                                                                                              Defaults to: false

                                                                                                                                                            Returns

                                                                                                                                                            • Boolean

                                                                                                                                                              True if masked, false otherwise.

                                                                                                                                                            Fires

                                                                                                                                                              Ext.Component
                                                                                                                                                              view source
                                                                                                                                                              ( )private
                                                                                                                                                              Defined in override Ext.rtl.Component. ...

                                                                                                                                                              Defined in override Ext.rtl.Component.

                                                                                                                                                              Fires

                                                                                                                                                                Ext.Component
                                                                                                                                                                view source
                                                                                                                                                                ( ) : Booleanprivate
                                                                                                                                                                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.Component.

                                                                                                                                                                Returns

                                                                                                                                                                Fires

                                                                                                                                                                  Checks if all events, or a specific event, is suspended. ...

                                                                                                                                                                  Checks if all events, or a specific event, is suspended.

                                                                                                                                                                  Parameters

                                                                                                                                                                  • event : String (optional)

                                                                                                                                                                    The name of the specific event to check

                                                                                                                                                                  Returns

                                                                                                                                                                  • Boolean

                                                                                                                                                                    true if events are suspended

                                                                                                                                                                  Ext.Component
                                                                                                                                                                  view source
                                                                                                                                                                  ( [deep] ) : Boolean
                                                                                                                                                                  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

                                                                                                                                                                    Ext.Component
                                                                                                                                                                    view source
                                                                                                                                                                    ( xtype, [shallow] ) : Boolean
                                                                                                                                                                    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.

                                                                                                                                                                    Gets the controller that controls this view. ...

                                                                                                                                                                    Gets the controller that controls this view. May be a controller that belongs to a view higher in the hierarchy.

                                                                                                                                                                    Available since: 5.0.1

                                                                                                                                                                    Parameters

                                                                                                                                                                    • skipThis : Boolean (optional)

                                                                                                                                                                      true to not consider the controller directly attached to this view (if it exists).

                                                                                                                                                                      Defaults to: false

                                                                                                                                                                    Returns

                                                                                                                                                                    Fires

                                                                                                                                                                      Gets the Controller or Component that is used as the reference holder for this view. ...

                                                                                                                                                                      Gets the Controller or Component that is used as the reference holder for this view.

                                                                                                                                                                      Available since: 5.0.0

                                                                                                                                                                      Parameters

                                                                                                                                                                      • skipThis : Boolean (optional)

                                                                                                                                                                        false to return this as the reference holder if this instance has set referenceHolder. Unlike getInheritedConfig this method defaults to true because it is possible that a reference property set by the owner of a component that is also a referenceHolder itself. In this case, the reference connects not to this component but to the parent referenceHolder.

                                                                                                                                                                        Defaults to: true

                                                                                                                                                                      Returns

                                                                                                                                                                      Fires

                                                                                                                                                                        Returns the Ext.data.Session for this instance. ...

                                                                                                                                                                        Returns the Ext.data.Session for this instance. This property may come from this instance's session or be inherited from this object's parent.

                                                                                                                                                                        Available since: 5.0.0

                                                                                                                                                                        Parameters

                                                                                                                                                                        • skipThis : Boolean (optional)

                                                                                                                                                                          Pass true to ignore a session configured on this instance and only consider an inherited session.

                                                                                                                                                                          Defaults to: false

                                                                                                                                                                        Returns

                                                                                                                                                                        Fires

                                                                                                                                                                          Returns the Ext.app.ViewModel for this instance. ...

                                                                                                                                                                          Returns the Ext.app.ViewModel for this instance. This property may come from this this instance's viewModel or be inherited from this object's parent.

                                                                                                                                                                          Available since: 5.0.0

                                                                                                                                                                          Parameters

                                                                                                                                                                          • skipThis : Boolean (optional)

                                                                                                                                                                            Pass true to ignore a viewModel configured on this instance and only consider an inherited view model.

                                                                                                                                                                            Defaults to: false

                                                                                                                                                                          Returns

                                                                                                                                                                          Fires

                                                                                                                                                                            Returns an update method for the given Config that will call publishState to ensure two-way bindings (via bind) as we...

                                                                                                                                                                            Returns an update method for the given Config that will call publishState to ensure two-way bindings (via bind) as well as any publishes are updated. This method is cached on the cfg instance for re-use.

                                                                                                                                                                            Available since: 5.0.0

                                                                                                                                                                            Parameters

                                                                                                                                                                            Returns

                                                                                                                                                                            Fires

                                                                                                                                                                              Ext.Component
                                                                                                                                                                              view source
                                                                                                                                                                              ( [msg], [msgCls] )
                                                                                                                                                                              Masks this component with a semi-opaque layer and makes the contents unavailable to clicks. ...

                                                                                                                                                                              Masks this component with a semi-opaque layer and makes the contents unavailable to clicks.

                                                                                                                                                                              See unmask.

                                                                                                                                                                              Parameters

                                                                                                                                                                              • msg : String (optional)

                                                                                                                                                                                A message to show in the center of the mask layer.

                                                                                                                                                                              • msgCls : String (optional)

                                                                                                                                                                                A CSS clas name to use on the message element in the center of the layer.

                                                                                                                                                                              Fires

                                                                                                                                                                                ( item, ename, [fn], [scope], [options] ) : Object
                                                                                                                                                                                Shorthand for addManagedListener. ...

                                                                                                                                                                                Shorthand for addManagedListener.

                                                                                                                                                                                Parameters

                                                                                                                                                                                • item : Ext.util.Observable/Ext.dom.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();
                                                                                                                                                                                  
                                                                                                                                                                                Move the element relative to its current position. ...

                                                                                                                                                                                Move the element relative to its current position.

                                                                                                                                                                                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

                                                                                                                                                                                Fires

                                                                                                                                                                                  ( item, ename, [fn], [scope] )
                                                                                                                                                                                  Shorthand for removeManagedListener. ...

                                                                                                                                                                                  Shorthand for removeManagedListener.

                                                                                                                                                                                  Parameters

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

                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                  view source
                                                                                                                                                                                  ( [selector] ) : Ext.Component
                                                                                                                                                                                  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.

                                                                                                                                                                                  Parameters

                                                                                                                                                                                  Returns

                                                                                                                                                                                  • Ext.Component

                                                                                                                                                                                    The next node (or the next node which matches the selector). Returns null if there is no matching node.

                                                                                                                                                                                  Fires

                                                                                                                                                                                    Ext.Component
                                                                                                                                                                                    view source
                                                                                                                                                                                    ( [selector] ) : Ext.Component
                                                                                                                                                                                    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

                                                                                                                                                                                    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
                                                                                                                                                                                    The on method is shorthand for addListener. ...

                                                                                                                                                                                    The on method is shorthand for addListener.

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

                                                                                                                                                                                    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.

                                                                                                                                                                                      • onFrame : Number

                                                                                                                                                                                        Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

                                                                                                                                                                                      • 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();
                                                                                                                                                                                      
                                                                                                                                                                                    Ext.Component
                                                                                                                                                                                    view source
                                                                                                                                                                                    ( container, pos, instanced )protectedtemplate
                                                                                                                                                                                    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.

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    • container : Ext.container.Container

                                                                                                                                                                                      Container which holds the component.

                                                                                                                                                                                    • pos : Number

                                                                                                                                                                                      Position at which the component was added.

                                                                                                                                                                                    • instanced : Boolean

                                                                                                                                                                                      false if this component was instanced by the parent container. true if the instance already existed when it was passed to the container.

                                                                                                                                                                                    Fires

                                                                                                                                                                                    private ...

                                                                                                                                                                                    private

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    Fires

                                                                                                                                                                                    Ext.Component
                                                                                                                                                                                    view source
                                                                                                                                                                                    ( width, height )protectedtemplate
                                                                                                                                                                                    Invoked when this component has first achieved size. ...

                                                                                                                                                                                    Invoked when this component has first achieved size. Occurs after the componentLayout has completed its initial run.

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

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    • width : Number

                                                                                                                                                                                      The width of this component

                                                                                                                                                                                    • height : Number

                                                                                                                                                                                      The height of this component

                                                                                                                                                                                    Fires

                                                                                                                                                                                    ...

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    Fires

                                                                                                                                                                                      Ext.Component
                                                                                                                                                                                      view source
                                                                                                                                                                                      ( )protectedtemplate
                                                                                                                                                                                      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.

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

                                                                                                                                                                                      Fires

                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                        view source
                                                                                                                                                                                        ( )protectedtemplate
                                                                                                                                                                                        Allows addition of behavior to the disable operation. ...

                                                                                                                                                                                        Allows addition of behavior to the disable operation. After calling the superclass's onDisable, the Component will be disabled.

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

                                                                                                                                                                                        Fires

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( )protectedtemplate
                                                                                                                                                                                          Allows addition of behavior to the enable operation. ...

                                                                                                                                                                                          Allows addition of behavior to the enable operation. After calling the superclass's onEnable, the Component will be enabled.

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

                                                                                                                                                                                          Fires

                                                                                                                                                                                            ...

                                                                                                                                                                                            Fires

                                                                                                                                                                                            • move
                                                                                                                                                                                            • tofront
                                                                                                                                                                                            private ...

                                                                                                                                                                                            private

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            Fires

                                                                                                                                                                                            Ext.Component
                                                                                                                                                                                            view source
                                                                                                                                                                                            ( [animateTarget], [callback], [scope] )protectedtemplate
                                                                                                                                                                                            Allows addition of behavior to the hide operation. ...

                                                                                                                                                                                            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.

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

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            Fires

                                                                                                                                                                                            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

                                                                                                                                                                                            Parameters

                                                                                                                                                                                            Fires

                                                                                                                                                                                              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*

                                                                                                                                                                                              Parameters

                                                                                                                                                                                              Fires

                                                                                                                                                                                              • tofront
                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                              view source
                                                                                                                                                                                              ( x, y )protectedtemplate
                                                                                                                                                                                              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.

                                                                                                                                                                                              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.

                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                              view source
                                                                                                                                                                                              ( 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

                                                                                                                                                                                              ( parentNode, containerIdx )protectedtemplate
                                                                                                                                                                                              Template method called when this Component's DOM structure is created. ...

                                                                                                                                                                                              Template method called when this Component's DOM structure is created.

                                                                                                                                                                                              At this point, this Component's (and all descendants') DOM structure exists but it has not been layed out (positioned and sized).

                                                                                                                                                                                              Subclasses which override this to gain access to the structure at render time should call the parent class's method before attempting to access any child elements of the Component.

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

                                                                                                                                                                                              Parameters

                                                                                                                                                                                              • parentNode : Ext.dom.Element

                                                                                                                                                                                                The parent Element in which this Component's encapsulating element is contained.

                                                                                                                                                                                              • containerIdx : Number

                                                                                                                                                                                                The index within the parent Container's child collection of this Component.

                                                                                                                                                                                              Fires

                                                                                                                                                                                                Ext.Component
                                                                                                                                                                                                view source
                                                                                                                                                                                                ( 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.

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

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                Fires

                                                                                                                                                                                                Ext.Component
                                                                                                                                                                                                view source
                                                                                                                                                                                                ( [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.

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

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                Fires

                                                                                                                                                                                                Ext.Component
                                                                                                                                                                                                view source
                                                                                                                                                                                                ( [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.

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

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                Fires

                                                                                                                                                                                                Ext.Component
                                                                                                                                                                                                view source
                                                                                                                                                                                                ( )private
                                                                                                                                                                                                ...
                                                                                                                                                                                                This method is called when any of the stateEvents are fired. ...

                                                                                                                                                                                                This method is called when any of the stateEvents are fired.

                                                                                                                                                                                                Fires

                                                                                                                                                                                                Ext.Component
                                                                                                                                                                                                view source
                                                                                                                                                                                                ( element )private
                                                                                                                                                                                                Returns true if the passed element is within the container tree of this component. ...

                                                                                                                                                                                                Returns true if the passed element is within the container tree of this component.

                                                                                                                                                                                                For example if a menu's submenu contains an Ext.form.field.Date, that top level menu owns the elements of the date picker. Using this method, you can tell if an event took place within a certain component tree.

                                                                                                                                                                                                Parameters

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

                                                                                                                                                                                                Template method to do any post-blur processing.

                                                                                                                                                                                                Parameters

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

                                                                                                                                                                                                Template method to do any post-focus processing.

                                                                                                                                                                                                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.

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                • T : Function

                                                                                                                                                                                                  The class constructor to prepare.

                                                                                                                                                                                                • mixin : Ext.util.Observable

                                                                                                                                                                                                  The mixin if being used as a mixin.

                                                                                                                                                                                                • data : Object

                                                                                                                                                                                                  The raw class creation data if this is an extend.

                                                                                                                                                                                                Ext.Component
                                                                                                                                                                                                view source
                                                                                                                                                                                                ( [selector] ) : Ext.Component
                                                                                                                                                                                                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.

                                                                                                                                                                                                Parameters

                                                                                                                                                                                                Returns

                                                                                                                                                                                                • Ext.Component

                                                                                                                                                                                                  The previous node (or the previous node which matches the selector). Returns null if there is no matching node.

                                                                                                                                                                                                Fires

                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                  view source
                                                                                                                                                                                                  ( [selector] ) : Ext.Component
                                                                                                                                                                                                  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

                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                  Returns

                                                                                                                                                                                                  • Ext.Component

                                                                                                                                                                                                    The previous sibling (or the previous sibling which matches the selector). Returns null if there is no matching sibling.

                                                                                                                                                                                                  ( [property], [value] )protected
                                                                                                                                                                                                  Publish this components state to the ViewModel. ...

                                                                                                                                                                                                  Publish this components state to the ViewModel. If no arguments are given (or if this is the first call), the entire state is published. This state is determined by the publishes property.

                                                                                                                                                                                                  This method is called only by component authors.

                                                                                                                                                                                                  Available since: 5.0.0

                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                  • property : String (optional)

                                                                                                                                                                                                    The name of the property to update.

                                                                                                                                                                                                  • value : Object (optional)

                                                                                                                                                                                                    The value of property. Only needed if property is given.

                                                                                                                                                                                                  Fires

                                                                                                                                                                                                    Ext.Component
                                                                                                                                                                                                    view source
                                                                                                                                                                                                    ( )private
                                                                                                                                                                                                    Implementation which updates the scroll range of a touch scroller. ...

                                                                                                                                                                                                    Implementation which updates the scroll range of a touch scroller. Subclasses may change implementation.

                                                                                                                                                                                                    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.

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    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 (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

                                                                                                                                                                                                    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.

                                                                                                                                                                                                      Returns

                                                                                                                                                                                                      Fires

                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                        view source
                                                                                                                                                                                                        ( cls ) : Ext.Componentdeprecated
                                                                                                                                                                                                        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: 2.3.0

                                                                                                                                                                                                        This method has been deprecated since 4.1

                                                                                                                                                                                                        Use addCls instead.

                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                        Returns

                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                        view source
                                                                                                                                                                                                        ( cls ) : Ext.Component
                                                                                                                                                                                                        Removes a CSS class from the top level element representing this component. ...

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

                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                        Returns

                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                        view source
                                                                                                                                                                                                        ( cls )
                                                                                                                                                                                                        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.

                                                                                                                                                                                                        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.

                                                                                                                                                                                                          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.

                                                                                                                                                                                                            Parameters

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

                                                                                                                                                                                                              Remove a single managed listener item ...

                                                                                                                                                                                                              Remove a single managed listener item

                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                              • isClear : Boolean

                                                                                                                                                                                                                True if this is being called during a clear

                                                                                                                                                                                                              • managedListener : Object

                                                                                                                                                                                                                The managed listener item See removeManagedListener for other args

                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                              view source
                                                                                                                                                                                                              ( uiCls )protected
                                                                                                                                                                                                              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 + uiCls.

                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                              • uiCls : String

                                                                                                                                                                                                                The UI class to remove from the element.

                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                Ext.Component
                                                                                                                                                                                                                view source
                                                                                                                                                                                                                ( )private
                                                                                                                                                                                                                Method which removes a specified UI from the components element. ...

                                                                                                                                                                                                                Method which removes a specified UI from the components element.

                                                                                                                                                                                                                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.

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  • container : Ext.dom.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
                                                                                                                                                                                                                  Gets the default scope for firing late bound events (string names with no scope attached) at runtime. ...

                                                                                                                                                                                                                  Gets the default scope for firing late bound events (string names with no scope attached) at runtime.

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  • defaultScope : Object (optional)

                                                                                                                                                                                                                    The default scope to return if none is found.

                                                                                                                                                                                                                    Defaults to: this

                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                  • Object

                                                                                                                                                                                                                    The default event scope

                                                                                                                                                                                                                  Overrides: Ext.mixin.Inheritable.resolveListenerScope

                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                  • discardQueue : Boolean (optional)

                                                                                                                                                                                                                    true to prevent any previously queued events from firing while we were suspended. See suspendEvents.

                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                  ( flushOptions )private
                                                                                                                                                                                                                  ...

                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                        ( deltaX, deltaY, animate )
                                                                                                                                                                                                                        Scrolls this Component by the passed delta values, optionally animating. ...

                                                                                                                                                                                                                        Scrolls this Component 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);
                                                                                                                                                                                                                        

                                                                                                                                                                                                                        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

                                                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                          ( x, y, [animate] )
                                                                                                                                                                                                                          Scrolls this component to the specified x and y coordinates. ...

                                                                                                                                                                                                                          Scrolls this component to the specified x and y coordinates. Only applicable for components that have been configured with autoScroll or overflowX and overflowY.

                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                          • x : Number
                                                                                                                                                                                                                          • y : Number
                                                                                                                                                                                                                          • animate : Boolean/Object (optional)

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

                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                            ( [active], [newActive] )private
                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            • active : Boolean (optional)

                                                                                                                                                                                                                              True to activate the Component, false to deactivate it.

                                                                                                                                                                                                                              Defaults to: false

                                                                                                                                                                                                                            • newActive : Ext.Component (optional)

                                                                                                                                                                                                                              If deactivating, the newly active Component which is taking over topmost zIndex position.

                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                            • activate
                                                                                                                                                                                                                            • deactivate
                                                                                                                                                                                                                            • tofront
                                                                                                                                                                                                                            Sets the value of activeCounter. ...

                                                                                                                                                                                                                            Sets the value of activeCounter.

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Sets the value of alwaysOnTop. ...

                                                                                                                                                                                                                            Sets the value of alwaysOnTop.

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Ext.Component
                                                                                                                                                                                                                            view source
                                                                                                                                                                                                                            ( scroll ) : Ext.Componentchainable
                                                                                                                                                                                                                            Sets the overflow on the content element of the component. ...

                                                                                                                                                                                                                            Sets the overflow on the content element of the component.

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            • scroll : Boolean

                                                                                                                                                                                                                              True to allow the Component to auto scroll.

                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                              Sets the value of bind. ...

                                                                                                                                                                                                                              Sets the value of bind.

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                              ( border )
                                                                                                                                                                                                                              ...

                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                • box : Object

                                                                                                                                                                                                                                  The box to fill {x, y, width, height}

                                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                                • move
                                                                                                                                                                                                                                Sets the value of childEls. ...

                                                                                                                                                                                                                                Sets the value of childEls.

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                ( name, [value] ) : Ext.Basechainable
                                                                                                                                                                                                                                Sets a single/multiple configuration options. ...

                                                                                                                                                                                                                                Sets a single/multiple configuration options.

                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                • name : String/Object

                                                                                                                                                                                                                                  The name of the property to set, or a set of key value pairs to set.

                                                                                                                                                                                                                                • value : Object (optional)

                                                                                                                                                                                                                                  The value to set for the name parameter.

                                                                                                                                                                                                                                Returns

                                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                                  Sets the value of controller. ...

                                                                                                                                                                                                                                  Sets the value of controller.

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                  ( data )
                                                                                                                                                                                                                                  Sets the value of data. ...

                                                                                                                                                                                                                                  Sets the value of data.

                                                                                                                                                                                                                                  Available since: 3.4.0

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  Sets the value of defaultListenerScope. ...

                                                                                                                                                                                                                                  Sets the value of defaultListenerScope.

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                  ( disabled )
                                                                                                                                                                                                                                  Enable or disable the component. ...

                                                                                                                                                                                                                                  Enable or disable the component.

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  • disabled : Boolean

                                                                                                                                                                                                                                    true to disable.

                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                  ( dock ) : Ext.Componentchainable
                                                                                                                                                                                                                                  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)

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  • dock : Object

                                                                                                                                                                                                                                    The dock position.

                                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                  ( dock ) : Ext.Componentchainabledeprecated
                                                                                                                                                                                                                                  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)

                                                                                                                                                                                                                                  This method has been deprecated since 5.0

                                                                                                                                                                                                                                  Use setDock instead.

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  • dock : Object

                                                                                                                                                                                                                                    The dock position.

                                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                  ( flex )private
                                                                                                                                                                                                                                  Sets the flex property of this component. ...

                                                                                                                                                                                                                                  Sets the flex property of this component. Only applicable when this component is an item of a box layout

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                  ( height ) : Ext.Componentchainable
                                                                                                                                                                                                                                  Sets the height of the component. ...

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

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  • height : Number

                                                                                                                                                                                                                                    The new height to set. This may be one of:

                                                                                                                                                                                                                                    • A Number specifying the new height in pixels.
                                                                                                                                                                                                                                    • A String used to set the CSS height style.
                                                                                                                                                                                                                                    • undefined to leave the height unchanged.

                                                                                                                                                                                                                                  Returns

                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                    Ext.Component
                                                                                                                                                                                                                                    view source
                                                                                                                                                                                                                                    ( hidden ) : Ext.Component
                                                                                                                                                                                                                                    Sets the hidden state of this component. ...

                                                                                                                                                                                                                                    Sets the hidden state of this component. This is basically the same as setVisible but the boolean parameter has the opposite meaning.

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                      Ext.Component
                                                                                                                                                                                                                                      view source
                                                                                                                                                                                                                                      ( html )private
                                                                                                                                                                                                                                      ...

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                        ( load ) : Ext.LoadMask
                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                        The mask will be rendered into the element returned by getMaskTarget which for most Components is the Component's element. See getMaskTarget and maskElement.

                                                                                                                                                                                                                                        Most Components will return null indicating that their LoadMask cannot reside inside their element, but must be rendered into the document body.

                                                                                                                                                                                                                                        Grid Views however will direct a LoadMask to be rendered into the owning GridPanel.

                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                        • Ext.LoadMask

                                                                                                                                                                                                                                          The LoadMask instance that has just been shown.

                                                                                                                                                                                                                                        Overridden in Ext.rtl.Component. ...

                                                                                                                                                                                                                                        Overridden in Ext.rtl.Component.

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                        Overrides: Ext.util.Positionable.setLocalX

                                                                                                                                                                                                                                        Overridden in Ext.rtl.Component. ...

                                                                                                                                                                                                                                        Overridden in Ext.rtl.Component.

                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                        Overrides: Ext.util.Positionable.setLocalY

                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                        ( margin )
                                                                                                                                                                                                                                        Sets the margin on the target element. ...

                                                                                                                                                                                                                                        Sets the margin on the target element.

                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                                          ( isMasked )private
                                                                                                                                                                                                                                          Set masked state for this Component. ...

                                                                                                                                                                                                                                          Set masked state for this Component.

                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                          • isMasked : Boolean

                                                                                                                                                                                                                                            True if masked, false otherwise.

                                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                                            Ext.Component
                                                                                                                                                                                                                                            view source
                                                                                                                                                                                                                                            ( maxHeight )
                                                                                                                                                                                                                                            Sets the value of maxHeight. ...

                                                                                                                                                                                                                                            Sets the value of maxHeight.

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            Ext.Component
                                                                                                                                                                                                                                            view source
                                                                                                                                                                                                                                            ( maxWidth )
                                                                                                                                                                                                                                            Sets the value of maxWidth. ...

                                                                                                                                                                                                                                            Sets the value of maxWidth.

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            Ext.Component
                                                                                                                                                                                                                                            view source
                                                                                                                                                                                                                                            ( minHeight )
                                                                                                                                                                                                                                            Sets the value of minHeight. ...

                                                                                                                                                                                                                                            Sets the value of minHeight.

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            Ext.Component
                                                                                                                                                                                                                                            view source
                                                                                                                                                                                                                                            ( minWidth )
                                                                                                                                                                                                                                            Sets the value of minWidth. ...

                                                                                                                                                                                                                                            Sets the value of minWidth.

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            Ext.Component
                                                                                                                                                                                                                                            view source
                                                                                                                                                                                                                                            ( 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.

                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                            • overflowX : String

                                                                                                                                                                                                                                              The overflow-x value.

                                                                                                                                                                                                                                            • overflowY : String

                                                                                                                                                                                                                                              The overflow-y value.

                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                              ( x, [y], [animate] ) : Ext.Componentchainable
                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                              ( 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.

                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                              Sets the value of publishes. ...

                                                                                                                                                                                                                                              Sets the value of publishes.

                                                                                                                                                                                                                                              Available since: 5.0.0

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              Sets the value of reference. ...

                                                                                                                                                                                                                                              Sets the value of reference.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                              ( region ) : String
                                                                                                                                                                                                                                              This method changes the region config property for this border region. ...

                                                                                                                                                                                                                                              This method changes the region config property for this border region. This is only valid if this component is in a border layout (Ext.layout.container.Border).

                                                                                                                                                                                                                                              Defined in override Ext.layout.container.border.Region.

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • region : String

                                                                                                                                                                                                                                                The new region value ("north", "south", "east" or "west").

                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                              • String

                                                                                                                                                                                                                                                The previous value of the region property.

                                                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                                                Ext.Component
                                                                                                                                                                                                                                                view source
                                                                                                                                                                                                                                                ( x )
                                                                                                                                                                                                                                                Sets the "x" scroll position for this component. ...

                                                                                                                                                                                                                                                Sets the "x" scroll position for this component. Only applicable for components that have been configured with autoScroll or overflowX.

                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                                  ( y )
                                                                                                                                                                                                                                                  Sets the "y" scroll position for this component. ...

                                                                                                                                                                                                                                                  Sets the "y" scroll position for this component. Only applicable for components that have been configured with autoScroll or overflowY.

                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                                    Sets the value of session. ...

                                                                                                                                                                                                                                                    Sets the value of session.

                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                    Ext.Component
                                                                                                                                                                                                                                                    view source
                                                                                                                                                                                                                                                    ( width, height ) : Ext.Componentchainable
                                                                                                                                                                                                                                                    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}.

                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                    • width : Number/String/Object

                                                                                                                                                                                                                                                      The new width to set. This may be one of:

                                                                                                                                                                                                                                                      • A Number specifying the new width in 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 pixels.
                                                                                                                                                                                                                                                      • A String used to set the CSS height style. Animation may not be used.
                                                                                                                                                                                                                                                      • undefined to leave the height unchanged.

                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                      Ext.Component
                                                                                                                                                                                                                                                      view source
                                                                                                                                                                                                                                                      ( property, [value] ) : Ext.Componentchainable
                                                                                                                                                                                                                                                      Sets the style for this Component's primary element. ...

                                                                                                                                                                                                                                                      Sets the style for this Component's primary element.

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • property : String/Object

                                                                                                                                                                                                                                                        The style property to be set, or an object of multiple styles.

                                                                                                                                                                                                                                                      • value : String (optional)

                                                                                                                                                                                                                                                        The value to apply to the given property, or null if an object was passed.

                                                                                                                                                                                                                                                      Returns

                                                                                                                                                                                                                                                      Set the tabIndex property for this Focusable. ...

                                                                                                                                                                                                                                                      Set the tabIndex property for this Focusable. If the focusEl is avalable, set tabIndex attribute on it, too.

                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                      • newTabIndex : Number

                                                                                                                                                                                                                                                        new tabIndex to set

                                                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                                                        Sets the value of twoWayBindable. ...

                                                                                                                                                                                                                                                        Sets the value of twoWayBindable.

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                        ( ui )
                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        • ui : String

                                                                                                                                                                                                                                                          The new UI for the component.

                                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                                          Sets the value of viewModel. ...

                                                                                                                                                                                                                                                          Sets the value of viewModel.

                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                                                          ( visible ) : Ext.Componentchainable
                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                                                          ( weight ) : Number
                                                                                                                                                                                                                                                          Sets the weight config property for this component. ...

                                                                                                                                                                                                                                                          Sets the weight config property for this component. This is only valid if this component is in a border layout (Ext.layout.container.Border).

                                                                                                                                                                                                                                                          Defined in override Ext.layout.container.border.Region.

                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                          • weight : Number

                                                                                                                                                                                                                                                            The new weight value.

                                                                                                                                                                                                                                                          Returns

                                                                                                                                                                                                                                                          • Number

                                                                                                                                                                                                                                                            The previous value of the weight property.

                                                                                                                                                                                                                                                          Fires

                                                                                                                                                                                                                                                            Ext.Component
                                                                                                                                                                                                                                                            view source
                                                                                                                                                                                                                                                            ( width ) : Ext.Componentchainable
                                                                                                                                                                                                                                                            Sets the width of the component. ...

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

                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                            • width : Number

                                                                                                                                                                                                                                                              The new width to setThis may be one of:

                                                                                                                                                                                                                                                              • A Number specifying the new width in pixels.
                                                                                                                                                                                                                                                              • A String used to set the CSS width style.

                                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                                              ( x, animate ) : Ext.util.Positionable
                                                                                                                                                                                                                                                              Sets the X position of the DOM element based on page coordinates. ...

                                                                                                                                                                                                                                                              Sets the X position of the DOM element based on page coordinates.

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                              Overrides: Ext.util.Positionable.setX

                                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                                              ( xy, animate ) : Ext.util.Positionable
                                                                                                                                                                                                                                                              Sets the position of the DOM element in page coordinates. ...

                                                                                                                                                                                                                                                              Sets the position of the DOM element in page coordinates.

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                              Overrides: Ext.util.Positionable.setXY

                                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                                              ( y, animate ) : Ext.util.Positionable
                                                                                                                                                                                                                                                              Sets the Y position of the DOM element based on page coordinates. ...

                                                                                                                                                                                                                                                              Sets the Y position of the DOM element based on page coordinates.

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                                              ( [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.

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              • animateTarget : String/Ext.dom.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

                                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                                              ( 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());
                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                                              ( 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.

                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                              

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              • eventName : String...

                                                                                                                                                                                                                                                                Multiple event names to suspend.

                                                                                                                                                                                                                                                              Suspends the firing of all events. ...

                                                                                                                                                                                                                                                              Suspends the firing of all events. (see resumeEvents)

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              • queueSuspended : Boolean

                                                                                                                                                                                                                                                                true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

                                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                                              ( )private
                                                                                                                                                                                                                                                              ...
                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                                                              • afterrender
                                                                                                                                                                                                                                                              • beforehide
                                                                                                                                                                                                                                                              • beforerender
                                                                                                                                                                                                                                                              • beforeshow
                                                                                                                                                                                                                                                              • move
                                                                                                                                                                                                                                                              • render
                                                                                                                                                                                                                                                              • tofront
                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                              • preventFocus : Boolean (optional)

                                                                                                                                                                                                                                                                Specify true to prevent the Component from being focused.

                                                                                                                                                                                                                                                                Defaults to: false

                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                                                              • tofront
                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                              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

                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                  ( eventName, fn, [scope] )
                                                                                                                                                                                                                                                                  Shorthand for removeListener. ...

                                                                                                                                                                                                                                                                  Shorthand for removeListener.

                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                                                  ( box )private
                                                                                                                                                                                                                                                                  Overridden in Ext.rtl.Component. ...

                                                                                                                                                                                                                                                                  Overridden in Ext.rtl.Component.

                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                                                  ( )
                                                                                                                                                                                                                                                                  Removes the mask applied by mask ...

                                                                                                                                                                                                                                                                  Removes the mask applied by mask

                                                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                                                    Ext.Component
                                                                                                                                                                                                                                                                    view source
                                                                                                                                                                                                                                                                    ( cmp )private
                                                                                                                                                                                                                                                                    ...

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    Ext.Component
                                                                                                                                                                                                                                                                    view source
                                                                                                                                                                                                                                                                    ( [selector], [limit] ) : Ext.container.Container
                                                                                                                                                                                                                                                                    Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed selector or component. ...

                                                                                                                                                                                                                                                                    Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed 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');
                                                                                                                                                                                                                                                                    

                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                    • selector : String/Ext.Component (optional)

                                                                                                                                                                                                                                                                      The selector component or actual component to test. If not passed the immediate owner/activater is returned.

                                                                                                                                                                                                                                                                    • limit : String/Number/Ext.Component (optional)

                                                                                                                                                                                                                                                                      This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

                                                                                                                                                                                                                                                                    Returns

                                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                                      Ext.Component
                                                                                                                                                                                                                                                                      view source
                                                                                                                                                                                                                                                                      ( 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

                                                                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                        ( box ) : Ext.Componentchainable
                                                                                                                                                                                                                                                                        Sets the current box measurements of the component's underlying element. ...

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

                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                        • box : Object

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

                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                                                        Updates the frame elements to match new framing. ...

                                                                                                                                                                                                                                                                        Updates the frame elements to match new framing. The current frameBody is preserved by transplanting it into the new frame. All other frame childEls are destroyed and recreated if needed by the new frame. This method cannot transition from framed to non-framed or vise-versa or between table and div based framing.

                                                                                                                                                                                                                                                                        Fires

                                                                                                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                                                                                                          view source
                                                                                                                                                                                                                                                                          ( [options] )
                                                                                                                                                                                                                                                                          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.

                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                            Ext.Component
                                                                                                                                                                                                                                                                            view source
                                                                                                                                                                                                                                                                            ( maxHeight, oldMaxHeight )private
                                                                                                                                                                                                                                                                            ...

                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                            Fires

                                                                                                                                                                                                                                                                              Ext.Component
                                                                                                                                                                                                                                                                              view source
                                                                                                                                                                                                                                                                              ( maxWidth, oldMaxWidth )private
                                                                                                                                                                                                                                                                              ...

                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                              Fires

                                                                                                                                                                                                                                                                                Ext.Component
                                                                                                                                                                                                                                                                                view source
                                                                                                                                                                                                                                                                                ( minHeight, oldMinHeight )private
                                                                                                                                                                                                                                                                                ...

                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                Fires

                                                                                                                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                                                                                                                  view source
                                                                                                                                                                                                                                                                                  ( minWidth, oldMinWidth )private
                                                                                                                                                                                                                                                                                  ...

                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                  Fires

                                                                                                                                                                                                                                                                                    Updates the session config. ...

                                                                                                                                                                                                                                                                                    Updates the session config.

                                                                                                                                                                                                                                                                                    Available since: 5.0.0

                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                    Fires

                                                                                                                                                                                                                                                                                      Updates the viewModel config. ...

                                                                                                                                                                                                                                                                                      Updates the viewModel config.

                                                                                                                                                                                                                                                                                      Available since: 5.0.0

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      Fires

                                                                                                                                                                                                                                                                                        Defined By

                                                                                                                                                                                                                                                                                        Static methods

                                                                                                                                                                                                                                                                                        ( config, [mixinClass] )privatestatic
                                                                                                                                                                                                                                                                                        Adds new config properties to this class. ...

                                                                                                                                                                                                                                                                                        Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        • config : Object
                                                                                                                                                                                                                                                                                        • mixinClass : Class (optional)

                                                                                                                                                                                                                                                                                          The mixin class if the configs are from a mixin.

                                                                                                                                                                                                                                                                                        ( members )chainableprivatestatic
                                                                                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        ( name, member )chainableprivatestatic
                                                                                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        ( members, [isStatic], [privacy] )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();
                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        • members : Object

                                                                                                                                                                                                                                                                                          The members to add to this class.

                                                                                                                                                                                                                                                                                        • isStatic : Boolean (optional)

                                                                                                                                                                                                                                                                                          Pass true if the members are static.

                                                                                                                                                                                                                                                                                          Defaults to: false

                                                                                                                                                                                                                                                                                        • privacy : Boolean (optional)

                                                                                                                                                                                                                                                                                          Pass true if the members are private. This only has meaning in debug mode and only for methods.

                                                                                                                                                                                                                                                                                          Defaults to: false

                                                                                                                                                                                                                                                                                        ( 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() { ... };
                                                                                                                                                                                                                                                                                        });
                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                        ( fromClass, members ) : Ext.Baseprivatestatic
                                                                                                                                                                                                                                                                                        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 '$$$$$$$'
                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        • fromClass : Ext.Base

                                                                                                                                                                                                                                                                                          The class to borrow members from

                                                                                                                                                                                                                                                                                        • members : Array/String

                                                                                                                                                                                                                                                                                          The names of the members to borrow

                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                        ( args )protectedstatic
                                                                                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        ( args )protectedstatic
                                                                                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( comp )static
                                                                                                                                                                                                                                                                                        Cancels layout of a component. ...

                                                                                                                                                                                                                                                                                        Cancels layout of a component.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                        Returns

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

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        ( config )privatestatic
                                                                                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( )static
                                                                                                                                                                                                                                                                                        Performs all pending layouts that were scheduled while suspendLayouts was in effect. ...

                                                                                                                                                                                                                                                                                        Performs all pending layouts that were scheduled while suspendLayouts was in effect.

                                                                                                                                                                                                                                                                                        Returns the Ext.Configurator for this class. ...

                                                                                                                                                                                                                                                                                        Returns the Ext.Configurator for this class.

                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                        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'
                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                        ( name, mixinClass )privatestatic
                                                                                                                                                                                                                                                                                        Used internally by the mixins pre-processor ...

                                                                                                                                                                                                                                                                                        Used internally by the mixins pre-processor

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        ( fn, scope )chainableprivatestatic
                                                                                                                                                                                                                                                                                        ...

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        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"
                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                        Direct use of this method should be rare. 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).

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        • members : Object

                                                                                                                                                                                                                                                                                          The properties to add to this class. This should be specified as an object literal containing one or more properties.

                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( [flush] )static
                                                                                                                                                                                                                                                                                        Resumes layout activity in the whole framework. ...

                                                                                                                                                                                                                                                                                        Resumes layout activity in the whole framework.

                                                                                                                                                                                                                                                                                        Ext.suspendLayouts is alias of suspendLayouts.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        • flush : Boolean (optional)

                                                                                                                                                                                                                                                                                          true to perform all the pending layouts. This can also be achieved by calling flushLayouts directly.

                                                                                                                                                                                                                                                                                          Defaults to: false

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( )static
                                                                                                                                                                                                                                                                                        Stops layouts from happening in the whole framework. ...

                                                                                                                                                                                                                                                                                        Stops layouts from happening in the whole framework.

                                                                                                                                                                                                                                                                                        It's useful to suspend the layout activity while updating multiple components and containers:

                                                                                                                                                                                                                                                                                        Ext.suspendLayouts();
                                                                                                                                                                                                                                                                                        // batch of updates...
                                                                                                                                                                                                                                                                                        Ext.resumeLayouts(true);
                                                                                                                                                                                                                                                                                        

                                                                                                                                                                                                                                                                                        Ext.suspendLayouts is alias of suspendLayouts.

                                                                                                                                                                                                                                                                                        See also Ext.batchLayouts for more abstract way of doing this.

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( comp, [defer] )static
                                                                                                                                                                                                                                                                                        Updates layout of a component. ...

                                                                                                                                                                                                                                                                                        Updates layout of a component.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        • comp : Ext.Component

                                                                                                                                                                                                                                                                                          The component to update.

                                                                                                                                                                                                                                                                                        • defer : Boolean (optional)

                                                                                                                                                                                                                                                                                          true to just queue the layout if this component.

                                                                                                                                                                                                                                                                                          Defaults to: false

                                                                                                                                                                                                                                                                                        Defined By

                                                                                                                                                                                                                                                                                        Events

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        Fires after a Component has been visually activated. ...

                                                                                                                                                                                                                                                                                        Fires after a Component has been visually activated.

                                                                                                                                                                                                                                                                                        Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout or this Component is a floating Component.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( 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

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                        Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                        Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        ( this, event, eOpts )
                                                                                                                                                                                                                                                                                        Fires when this Component loses focus. ...

                                                                                                                                                                                                                                                                                        Fires when this Component loses focus.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( 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.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        Fires after a Component has been visually deactivated. ...

                                                                                                                                                                                                                                                                                        Fires after a Component has been visually deactivated.

                                                                                                                                                                                                                                                                                        Note This event is only fired if this Component is a child of a Ext.container.Container that uses Ext.layout.container.Card as it's layout or this Component is a floating Component.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        Fires after the component is destroyed. ...

                                                                                                                                                                                                                                                                                        Fires after the component is destroyed.

                                                                                                                                                                                                                                                                                        Available since: 1.1.0

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        Fires after the component is disabled. ...

                                                                                                                                                                                                                                                                                        Fires after the component is disabled.

                                                                                                                                                                                                                                                                                        Available since: 1.1.0

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        Fires after the component is enabled. ...

                                                                                                                                                                                                                                                                                        Fires after the component is enabled.

                                                                                                                                                                                                                                                                                        Available since: 1.1.0

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Fires when this Component receives focus. ...

                                                                                                                                                                                                                                                                                        Fires when this Component receives focus.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, x, y, eOpts )
                                                                                                                                                                                                                                                                                        Fires after the component is moved. ...

                                                                                                                                                                                                                                                                                        Fires after the component is moved.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, ownerCt, eOpts )
                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        Fires after the component markup is rendered. ...

                                                                                                                                                                                                                                                                                        Fires after the component markup is rendered.

                                                                                                                                                                                                                                                                                        Available since: 1.1.0

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( 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.

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                                                                                                                        view source
                                                                                                                                                                                                                                                                                        ( this, eOpts )
                                                                                                                                                                                                                                                                                        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 after the state of the object is restored. ...

                                                                                                                                                                                                                                                                                        Fires after the state of the object is restored.

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

                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                        Defined By

                                                                                                                                                                                                                                                                                        CSS Variables

                                                                                                                                                                                                                                                                                        The background color of scroll indicators when touch scrolling is enabled ...

                                                                                                                                                                                                                                                                                        The background color of scroll indicators when touch scrolling is enabled

                                                                                                                                                                                                                                                                                        Defaults to: #000

                                                                                                                                                                                                                                                                                        The border-radius of scroll indicators when touch scrolling is enabled ...

                                                                                                                                                                                                                                                                                        The border-radius of scroll indicators when touch scrolling is enabled

                                                                                                                                                                                                                                                                                        Defaults to: 3px

                                                                                                                                                                                                                                                                                        The space between scroll indicators and the edge of their container ...

                                                                                                                                                                                                                                                                                        The space between scroll indicators and the edge of their container

                                                                                                                                                                                                                                                                                        Defaults to: 2px

                                                                                                                                                                                                                                                                                        The opacity of scroll indicators when touch scrolling is enabled ...

                                                                                                                                                                                                                                                                                        The opacity of scroll indicators when touch scrolling is enabled

                                                                                                                                                                                                                                                                                        Defaults to: .5

                                                                                                                                                                                                                                                                                        The background color of scroll indicators when touch scrolling is enabled ...

                                                                                                                                                                                                                                                                                        The background color of scroll indicators when touch scrolling is enabled

                                                                                                                                                                                                                                                                                        Defaults to: 6px