Touch 2.1.1 Sencha Docs

Ext.Component

Alternate names

Ext.lib.Component

Hierarchy

Mixins

Inherited mixins

Requires

Subclasses

Files

Guide

Events

Most of the visual classes you interact with in Sencha Touch are Components. Every Component in Sencha Touch is a subclass of Ext.Component, which means they can all:

  • Render themselves onto the page using a template
  • Show and hide themselves at any time
  • Center themselves on the screen
  • Enable and disable themselves

They can also do a few more advanced things:

  • Float above other components (windows, message boxes and overlays)
  • Change size and position on the screen with animation
  • Dock other Components inside themselves (useful for toolbars)
  • Align to other components, allow themselves to be dragged around, make their content scrollable & more

Available Components

There are many components available in Sencha Touch, separated into 4 main groups:

Navigation components

Store-bound components

Form components

General components

Instantiating Components

Components are created the same way as all other classes in Sencha Touch - using Ext.create. Here's how we can create a Text field:

var panel = Ext.create('Ext.Panel', {
    html: 'This is my panel'
});

This will create a Panel instance, configured with some basic HTML content. A Panel is just a simple Component that can render HTML and also contain other items. In this case we've created a Panel instance but it won't show up on the screen yet because items are not rendered immediately after being instantiated. This allows us to create some components and move them around before rendering and laying them out, which is a good deal faster than moving them after rendering.

To show this panel on the screen now we can simply add it to the global Viewport:

Ext.Viewport.add(panel);

Panels are also Containers, which means they can contain other Components, arranged by a layout. Let's revisit the above example now, this time creating a panel with two child Components and a hbox layout:

var panel = Ext.create('Ext.Panel', {
    layout: 'hbox',

    items: [
        {
            xtype: 'panel',
            flex: 1,
            html: 'Left Panel, 1/3rd of total size',
             style: 'background-color: #5E99CC;'
        },
        {
            xtype: 'panel',
            flex: 2,
            html: 'Right Panel, 2/3rds of total size',
             style: 'background-color: #759E60;'
        }
    ]
});

Ext.Viewport.add(panel);

This time we created 3 Panels - the first one is created just as before but the inner two are declared inline using an xtype. Xtype is a convenient way of creating Components without having to go through the process of using Ext.create and specifying the full class name, instead you can just provide the xtype for the class inside an object and the framework will create the components for you.

We also specified a layout for the top level panel - in this case hbox, which splits the horizontal width of the parent panel based on the 'flex' of each child. For example, if the parent Panel above is 300px wide then the first child will be flexed to 100px wide and the second to 200px because the first one was given flex: 1 and the second flex: 2.

Using xtype

xtype is an easy way to create Components without using the full class name. This is especially useful when creating a Container that contains child Components. An xtype is simply a shorthand way of specifying a Component - for example you can use xtype: 'panel' instead of typing out Ext.panel.Panel.

Sample usage:

Ext.create('Ext.Container', {
    fullscreen: true,
    layout: 'fit',

    items: [
        {
            xtype: 'panel',
            html: 'This panel is created by xtype'
        },
        {
            xtype: 'toolbar',
            title: 'So is the toolbar',
            docked: 'top'
        }
    ]
});

Common xtypes

These are the xtypes that are most commonly used. For an exhaustive list please see the Components Guide.

 xtype                   Class
 -----------------       ---------------------
 actionsheet             Ext.ActionSheet
 audio                   Ext.Audio
 button                  Ext.Button
 image                   Ext.Img
 label                   Ext.Label
 loadmask                Ext.LoadMask
 map                     Ext.Map
 panel                   Ext.Panel
 segmentedbutton         Ext.SegmentedButton
 sheet                   Ext.Sheet
 spacer                  Ext.Spacer
 titlebar                Ext.TitleBar
 toolbar                 Ext.Toolbar
 video                   Ext.Video
 carousel                Ext.carousel.Carousel
 navigationview          Ext.navigation.View
 datepicker              Ext.picker.Date
 picker                  Ext.picker.Picker
 slider                  Ext.slider.Slider
 thumb                   Ext.slider.Thumb
 tabpanel                Ext.tab.Panel
 viewport                Ext.viewport.Default

 DataView Components
 ---------------------------------------------
 dataview                Ext.dataview.DataView
 list                    Ext.dataview.List
 nestedlist              Ext.dataview.NestedList

 Form Components
 ---------------------------------------------
 checkboxfield           Ext.field.Checkbox
 datepickerfield         Ext.field.DatePicker
 emailfield              Ext.field.Email
 hiddenfield             Ext.field.Hidden
 numberfield             Ext.field.Number
 passwordfield           Ext.field.Password
 radiofield              Ext.field.Radio
 searchfield             Ext.field.Search
 selectfield             Ext.field.Select
 sliderfield             Ext.field.Slider
 spinnerfield            Ext.field.Spinner
 textfield               Ext.field.Text
 textareafield           Ext.field.TextArea
 togglefield             Ext.field.Toggle
 urlfield                Ext.field.Url
 fieldset                Ext.form.FieldSet
 formpanel               Ext.form.Panel

Configuring Components

Whenever you create a new Component you can pass in configuration options. All of the configurations for a given Component are listed in the "Config options" section of its class docs page. You can pass in any number of configuration options when you instantiate the Component, and modify any of them at any point later. For example, we can easily modify the html content of a Panel after creating it:

// we can configure the HTML when we instantiate the Component
var panel = Ext.create('Ext.Panel', {
    fullscreen: true,
    html: 'This is a Panel'
});

// we can update the HTML later using the setHtml method:
panel.setHtml('Some new HTML');

// we can retrieve the current HTML using the getHtml method:
Ext.Msg.alert(panel.getHtml()); // displays "Some new HTML"

Every config has a getter method and a setter method - these are automatically generated and always follow the same pattern. For example, a config called html will receive getHtml and setHtml methods, a config called defaultType will receive getDefaultType and setDefaultType methods, and so on.

Further Reading

See the Component & Container Guide for more information, and check out the Ext.Container class docs also.

Available since: 1.1.0

Defined By

Config options

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 other elements within this component. To add specific styling for sub-classes, use the cls config.

Available since: 1.1.0

The border width to use on this Component. ...

The border width to use on this Component. Can be specified as a number (in which case all edges get the same border width) or a CSS string like '5 10 10 10'.

Please note that this will not add a border-color or border-style CSS property to the component; you must do that manually using either CSS or the style configuration.

Using style:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    border: 3,
    style: 'border-color: blue; border-style: solid;'
    // ...
});

Using CSS:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    border: 3,
    cls: 'my-component'
    // ...
});

And your CSS file:

.my-component {
    border-color: red;
    border-style: solid;
}

Available since: 1.1.0

The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. ...

The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'floating', which means its layout will no longer be affected by the Container that it resides in.

Available since: 2.0.0

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

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

Available since: 2.0.0

Whether or not this Component is absolutely centered inside its Container

Whether or not this Component is absolutely centered inside its Container

Available since: 1.1.0

Ext.Component
view source
: String/String[]

The CSS class to add to this component's element, in addition to the baseCls

The CSS class to add to this component's element, in addition to the baseCls

Available since: 1.1.0

Ext.Component
view source
: Stringdeprecated
CSS class to add to this Component. ...

CSS class to add to this Component. Deprecated, please use cls instead

Available since: 1.1.0

This cfg has been deprecated since 2.0.0

Ext.Component
view source
: Ext.Element/HTMLElement/String
The configured element will automatically be added as the content of this component. ...

The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.

Available since: 1.1.0

Ext.Component
view source
: Mixed

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

Whether or not this component is disabled

Whether or not this component is disabled

Available since: 1.1.0

The CSS class to add to the component when it is disabled ...

The CSS class to add to the component when it is disabled

Defaults to: "x-item-disabled"

Available since: 1.1.0

Ext.Component
view source
: Stringdeprecated
The dock position of this component in its container. ...

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

<!doctype html>

So your index.html file should look a little like this:

<!doctype html>
<html>
    <head>
        <title>MY application title</title>
        ...

Available since: 2.0.0

This cfg has been deprecated since 2.0.0

This has been deprecated. Please use docked instead.

Ext.Component
view source
: String
The dock position of this component in its container. ...

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

<!doctype html>

So your index.html file should look a little like this:

<!doctype html>
<html>
    <head>
        <title>MY application title</title>
        ...

Available since: 2.0.0

Configuration options to make this Component draggable

Configuration options to make this Component draggable

Available since: 1.1.0

Ext.Component
view source
: String/Mixeddeprecated
Animation effect to apply when the Component is being shown. ...

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'.

Available since: 2.0.0

This cfg has been deprecated since 2.0.0

Please use showAnimation instead.

Ext.Component
view source
: String/Mixeddeprecated
Animation effect to apply when the Component is being hidden. ...

Animation effect to apply when the Component is being hidden.

Available since: 2.0.0

This cfg has been deprecated since 2.0.0

Please use hideAnimation instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.

Ext.Component
view source
: Number
The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout. ...

The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.

You can also update the flex of a component dynamically using the Ext.layout.FlexBox.setItemFlex method.

Available since: 2.0.0

Ext.Component
view source
: Booleandeprecated
Deprecated, please use left, top, right or bottom instead. ...

Deprecated, please use left, top, right or bottom instead.

Ext.Viewport.add({
    top: 100,
    left: 100,
    width: 500,
    height: 200,
    html: 'Floating component!'
});

Available since: 1.1.0

This cfg has been deprecated since 2.0.0

The CSS class to add to this component when it is floatable. ...

The CSS class to add to this component when it is floatable.

Defaults to: "x-floating"

Available since: 1.1.0

Force the component to take up 100% width and height available, by adding it to Ext.Viewport.

Force the component to take up 100% width and height available, by adding it to Ext.Viewport.

Available since: 1.1.0

The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. ...

The height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size.

Available since: 1.1.0

Ext.Component
view source
: Boolean

Whether or not this Component is hidden (its CSS display property is set to none)

Whether or not this Component is hidden (its CSS display property is set to none)

Available since: 1.1.0

The CSS class to add to the component when it is hidden ...

The CSS class to add to the component when it is hidden

Defaults to: "x-item-hidden"

Available since: 2.0.0

Ext.Component
view source
: String/Mixed
Animation effect to apply when the Component is being hidden. ...

Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.

Available since: 2.0.0

Ext.Component
view source
: Booleanremoved
This configuration has moved to Ext.Container. ...

This configuration has moved to Ext.Container. You can no longer use it in a Ext.Component.

Available since: 1.1.0

This cfg has been removed since 2.0.0

This method has been moved from Ext.Component to Ext.Container

Ext.Component
view source
: String/Ext.Element/HTMLElement

Optional HTML content to render inside this Component, or a reference to an existing element on the page.

Optional HTML content to render inside this Component, or a reference to an existing element on the page.

Available since: 1.1.0

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

The unique id of this component instance.

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

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

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

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

Defaults to an auto-assigned id.

Available since: 2.0.0

Ext.Component
view source
: String
An itemId can be used as an alternative way to get a reference to a component when no object reference is available. ...

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

Also see id, Ext.Container.query, Ext.Container.down and Ext.Container.child.

Available since: 2.0.0

true to automatically re-layout this component on orientation change.

true to automatically re-layout this component on orientation change.

Available since: 1.1.0

This cfg has been removed since 2.0.0

The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. ...

The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'floating', which means its layout will no longer be affected by the Container that it resides in.

Available since: 2.0.0

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

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

See the Event guide for more

Note: It is bad practice to specify a listener's config when you are defining a class using Ext.define(). Instead, only specify listeners when you are instantiating your class with Ext.create().

Available since: 1.1.0

The margin to use on this Component. ...

The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'

Available since: 1.1.0

The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. ...

The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Note that this config will not apply if the Component is 'floating' (absolutely positioned or centered)

Available since: 1.1.0

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. ...

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Note that this config will not apply if the Component is 'floating' (absolutely positioned or centered)

Available since: 1.1.0

The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.

The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.

Available since: 1.1.0

The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.

The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc.

Available since: 1.1.0

Ext.Component
view source
: Booleanremoved
This configuration has moved to Ext.Container. ...

This configuration has moved to Ext.Container. You can no longer use it in a Ext.Component.

Available since: 1.1.0

This cfg has been removed since 2.0.0

This method has been moved from Ext.Component to Ext.Container

true to monitor Orientation change.

true to monitor Orientation change.

Available since: 1.1.0

This cfg has been removed since 2.0.0

The padding to use on this Component. ...

The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'

Available since: 1.1.0

An object or array of objects that will provide custom functionality for this component. ...

An object or array of objects that will provide custom functionality for this component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.

When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

For examples of plugins, see Ext.plugin.PullRefresh and Ext.plugin.ListPaging

Example code

A plugin by alias:

Ext.create('Ext.dataview.List', {
    config: {
        plugins: 'listpaging',
        itemTpl: '<div class="item">{title}</div>',
        store: 'Items'
    }
});

Multiple plugins by alias:

Ext.create('Ext.dataview.List', {
    config: {
        plugins: ['listpaging', 'pullrefresh'],
        itemTpl: '<div class="item">{title}</div>',
        store: 'Items'
    }
});

Single plugin by class name with config options:

Ext.create('Ext.dataview.List', {
    config: {
        plugins: {
            xclass: 'Ext.plugin.ListPaging', // Reference plugin by class
            autoPaging: true
        },

        itemTpl: '<div class="item">{title}</div>',
        store: 'Items'
    }
});

Multiple plugins by class name with config options:

Ext.create('Ext.dataview.List', {
    config: {
        plugins: [
            {
                xclass: 'Ext.plugin.PullRefresh',
                pullRefreshText: 'Pull to refresh...'
            },
            {
                xclass: 'Ext.plugin.ListPaging',
                autoPaging: true
            }
        ],

        itemTpl: '<div class="item">{title}</div>',
        store: 'Items'
    }
});

Available since: 1.1.0

A model instance which updates the Component's html based on it's tpl. ...

A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.

Available since: 2.0.0

Optional element to render this Component to. ...

Optional element to render this Component to. Usually this is not needed because a Component is normally full screen or automatically rendered inside another Container

Available since: 1.1.0

The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. ...

The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'floating', which means its layout will no longer be affected by the Container that it resides in.

Available since: 2.0.0

Ext.Component
view source
: Boolean/String/Objectremoved
This configuration has moved to Ext.Container. ...

This configuration has moved to Ext.Container. You can no longer use it in a Ext.Component.

Available since: 1.1.0

This cfg has been removed since 2.0.0

This method has been moved from Ext.Component to Ext.Container

Ext.Component
view source
: String/Mixed
Animation effect to apply when the Component is being shown. ...

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'.

Available since: 1.1.0

Ext.Component
view source
: Booleanremoved

true to stop the event that fires when you click outside the floating component.

true to stop the event that fires when you click outside the floating component.

Available since: 1.1.0

This cfg has been removed since 2.0.0

Optional CSS styles that will be rendered into an inline style attribute when the Component is rendered. ...

Optional CSS styles that will be rendered into an inline style attribute when the Component is rendered.

You can pass either a string syntax:

style: 'background:red'

Or by using an object:

style: {
    background: 'red'
}

When using the object syntax, you can define CSS Properties by using a string:

style: {
    'border-left': '1px solid red'
}

Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.

Available since: 1.1.0

The class that is added to the content target when you set styleHtmlContent to true. ...

The class that is added to the content target when you set styleHtmlContent to true.

Defaults to: "x-html"

Available since: 1.1.0

true to automatically style the HTML inside the content target of this component (body for panels). ...

true to automatically style the HTML inside the content target of this component (body for panels).

Defaults to: false

Available since: 1.1.0

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. ...

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'floating', which means its layout will no longer be affected by the Container that it resides in.

Available since: 2.0.0

A String, Ext.Template, Ext.XTemplate or an Array of strings to form an Ext.XTemplate. ...

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

Note The data configuration must be set for any content to be shown in the component when using this configuration.

Available since: 1.1.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. Valid modes are:

  • append
  • insertAfter
  • insertBefore
  • insertFirst
  • overwrite

Defaults to: 'overwrite'

Available since: 1.1.0

Ext.Component
view source
: Objectprivate

Available since: 2.0.0

Ext.Component
view source
: String

The ui to be used on this Component

The ui to be used on this Component

Available since: 1.1.0

The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. ...

The width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size.

Available since: 1.1.0

Ext.Component
view source
: String
The xtype configuration option can be used to optimize Component creation and rendering. ...

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full component name. For example, the component Ext.button.Button has an xtype of button.

You can define your own xtype on a custom component by specifying the alias config option with a prefix of widget. For example:

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

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

// Explicit creation of contained Components:
var panel = new Ext.Panel({
   // ...
   items: [
      Ext.create('Ext.button.Button', {
         text: 'OK'
      })
   ]
});

// Implicit creation using xtype:
var panel = new Ext.Panel({
   // ...
   items: [{
      xtype: 'button',
      text: 'OK'
   }]
});

In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.

Defaults to: 'component'

Available since: 2.0.0

Ext.Component
view source
: Number

The z-index to give this Component when it is rendered

The z-index to give this Component when it is rendered

Available since: 2.0.0

Properties

Defined By

Instance properties

Ext.Component
view source
: Numberprivate
...

Defaults to: 0x3

Available since: 2.1.0

Ext.Component
view source
: Numberprivate
...

Defaults to: 0x2

Available since: 2.1.0

Ext.Component
view source
: Numberprivate
...

Defaults to: 0x4

Available since: 2.1.0

Ext.Component
view source
: Numberprivate
...

Defaults to: 0x1

Available since: 2.1.0

Ext.Component
view source
: RegExpprivate
...

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

Available since: 2.0.0

...

Defaults to: 'ext-'

Available since: 2.0.0

...

Defaults to: '-'

Available since: 2.0.0

Ext.Component
view source
: Objectprivatereadonly
...

Defaults to: {top: true, right: true, bottom: true, left: true}

Available since: 2.0.0

Ext.Component
view source
: Objectprivate

Available since: 2.0.0

Ext.Component
view source
: Booleanprivate
...

Defaults to: false

Available since: 2.0.0

...

Defaults to: false

Available since: 2.1.0

...

Defaults to: /\.|[^\w\-]/g

Available since: 2.0.0

...

Defaults to: false

Available since: 2.0.0

Ext.Component
view source
: Objectprivate

Available since: 2.0.0

Ext.Component
view source
: Booleanprivate
...

Defaults to: true

Available since: 1.1.0

...

Defaults to: true

Available since: 2.0.0

Ext.Component
view source
: Booleanprivate
...

Defaults to: true

Available since: 2.1.0

...

Defaults to: true

Available since: 1.1.0

Ext.Component
view source
: Booleanprivate
...

Defaults to: false

Available since: 2.1.0

...

Defaults to: /^(?:delegate|single|delay|buffer|args|prepend|element)$/

Available since: 2.0.0

Overrides: Ext.mixin.Observable.listenerOptionsRegex

...

Defaults to: {id: 'traversable'}

Available since: 2.0.0

Overrides: Ext.mixin.Observable.mixinConfig

...

Defaults to: 'identifiable'

Available since: 2.0.0

...

Defaults to: '#'

Available since: 2.0.0

Ext.Component
view source
: Stringprivate
...

Defaults to: 'component'

Available since: 2.0.0

Overrides: Ext.mixin.Observable.observableType

...

Defaults to: 'reference'

Available since: 2.0.0

...

Defaults to: '[reference]'

Available since: 2.0.0

Ext.Component
view source
: Booleanprivate
...

Defaults to: false

Available since: 1.1.0

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

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

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

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

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


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

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

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

Available since: 2.0.0

Ext.Component
view source
: Numberprivate
...

Defaults to: 0x0

Available since: 2.1.0

Ext.Component
view source
: Booleanprivate
...

Defaults to: false

Available since: 2.1.0

Ext.Component
view source
: Arrayprivate
...

Defaults to: []

Available since: 2.0.0

...

Defaults to: /^([\w\-]+)$/

Available since: 2.0.0

Ext.Component
view source
: Booleanprivate
...

Defaults to: false

Available since: 2.1.0

Defined By

Static properties

...

Defaults to: []

Available since: 2.0.0

Methods

Defined By

Instance methods

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

Creates new Component.

Available since: 1.1.0

Parameters

  • config : Object

    The standard configuration object.

Returns

Fires

Overrides: Ext.Evented.constructor, Ext.Component.constructor

( eventName, fn, [scope], [options] )
Appends an after-event handler. ...

Appends an after-event handler.

Same as addListener with order set to 'after'.

Available since: 2.0.0

Parameters

  • eventName : String/String[]/Object

    The name of the event to listen for.

  • fn : Function/String

    The method the event invokes.

  • scope : Object (optional)

    The scope for fn.

  • options : Object (optional)

    An object containing handler configuration.

Fires

    ( eventName, fn, [scope], [options] )
    Appends a before-event handler. ...

    Appends a before-event handler. Returning false from the handler will stop the event.

    Same as addListener with order set to 'before'.

    Available since: 2.0.0

    Parameters

    • eventName : String/String[]/Object

      The name of the event to listen for.

    • fn : Function/String

      The method the event invokes.

    • scope : Object (optional)

      The scope for fn.

    • options : Object (optional)

      An object containing handler configuration.

    Fires

      Ext.Component
      view source
      ( cls, [prefix], [suffix] )
      Adds a CSS class (or classes) to this Component's rendered element. ...

      Adds a CSS class (or classes) to this Component's rendered element.

      Available since: 1.1.0

      Parameters

      • cls : String

        The CSS class to add.

      • prefix : String (optional)

        Optional prefix to add to each class.

        Defaults to: ""

      • suffix : String (optional)

        Optional suffix to add to each class.

        Defaults to: ""

      Fires

        ( selector, name, fn, scope, options, order )private
        ...

        Available since: 2.0.0

        Parameters

        Fires

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

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

          Available since: 1.1.0

          This method has been deprecated since 2.0

          It's no longer needed to add events before firing.

          Parameters

          • eventNames : Object/String...

            Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

          ( eventName, fn, [scope], [options], [order] )
          Appends an event handler to this object. ...

          Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.

          Combining Options

          Using the options argument, it is possible to combine different types of listeners:

          A delayed, one-time listener:

          container.on('tap', this.handleTap, this, {
              single: true,
              delay: 100
          });
          

          Attaching multiple handlers in 1 call

          The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

          container.on({
              tap  : this.onTap,
              swipe: this.onSwipe,
          
              scope: this // Important. Ensure "this" is correct during handler execution
          });
          

          One can also specify options for each event handler separately:

          container.on({
              tap  : { fn: this.onTap, scope: this, single: true },
              swipe: { fn: button.onSwipe, scope: button }
          });
          

          See the Events Guide for more.

          Available since: 1.1.0

          Parameters

          • eventName : String/String[]/Object

            The name of the event to listen for. May also be an object who's property names are event names.

          • fn : Function/String

            The method the event invokes. 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.

            This object may contain any of the following properties:

            • scope : Object (optional)

              The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

            • delay : Number (optional)

              The number of milliseconds to delay the invocation of the handler after the event fires.

            • single : Boolean (optional)

              true to add a handler to handle just the next firing of the event, and then remove itself.

            • order : String (optional)

              The order of when the listener should be added into the listener queue.

              If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

              Available options are before, current and after.

              Defaults to: current

            • buffer : Number (optional)

              Causes the handler to be 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.

            • element : String (optional)

              Allows you to add a listener onto a element of this component using the elements reference.

              Ext.create('Ext.Component', {
                  listeners: {
                      element: 'element',
                      tap: function() {
                          alert('element tap!');
                      }
                  }
              });
              

              All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

            • delegate : String (optional)

              Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

              // Create a container with a two children; a button and a toolbar
              var container = Ext.create('Ext.Container', {
                  items: [
                      {
                          xtype: 'toolbar',
                          docked: 'top',
                          title: 'My Toolbar'
                      },
                      {
                         xtype: 'button',
                         text: 'My Button'
                      }
                  ]
              });
              
              container.on({
                  // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                  delegate: 'button',
              
                  tap: function() {
                      alert('Button tapped!');
                  }
              });
              
          • order : String (optional)

            The order of when the listener should be added into the listener queue. Possible values are before, current and after.

            Defaults to: 'current'

          Fires

            ( object, eventName, [fn], [scope], [options] )deprecated
            Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed. ...

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

            Available since: 1.1.0

            This method has been deprecated since 2.0

            All listeners are now automatically managed where necessary. Simply use addListener.

            Parameters

            • object : Ext.mixin.Observable/HTMLElement

              The item to which to add a listener/listeners.

            • eventName : Object/String

              The event name, or an object containing event name properties.

            • fn : Function (optional)

              If the eventName parameter was an event name, this is the handler function.

            • scope : Object (optional)

              If the eventName parameter was an event name, this is the scope in which the handler function is executed.

            • options : Object (optional)

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

            Significantly improve instantiation time for Component with multiple references Ext.Element instance of the reference...

            Significantly improve instantiation time for Component with multiple references Ext.Element instance of the reference domNode is only created the very first time it's ever used.

            Available since: 2.0.0

            Parameters

            Ext.Component
            view source
            ( )private
            Used to handle joining of a record to a tpl ...

            Used to handle joining of a record to a tpl

            Available since: 2.0.0

            Fires

            Ext.Component
            view source
            ( )private
            Used to handle joining of a record to a tpl ...

            Used to handle joining of a record to a tpl

            Available since: 2.0.0

            Fires

              Ext.Component
              view source
              ( component, alignment )private
              ...

              Available since: 1.1.0

              Parameters

              Fires

                Ext.Component
                view source
                ( animation, component, newState, oldState, options, controller )private
                ...

                Available since: 2.0.0

                Parameters

                Fires

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

                  Available since: 2.0.0

                  Parameters

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

                  Available since: 2.0.0

                  Parameters

                  Fires

                    ...

                    Available since: 2.0.0

                    Parameters

                    Fires

                      Ext.Component
                      view source
                      ( centered ) : Booleanprivate
                      ...

                      Available since: 2.0.0

                      Parameters

                      Returns

                      Fires

                      • innerstatechange
                      Ext.Component
                      view source
                      ( cls ) : Array/nullprivate
                      Checks if the cls is a string. ...

                      Checks if the cls is a string. If it is, changed it into an array.

                      Available since: 2.0.0

                      Parameters

                      Returns

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

                      Available since: 2.0.0

                      Parameters

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

                      Available since: 2.0.0

                      Parameters

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

                      Available since: 2.0.0

                      Parameters

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

                      Available since: 2.0.0

                      Parameters

                      Fires

                      • innerstatechange
                      Ext.Component
                      view source
                      ( config )private
                      ...

                      Available since: 2.0.0

                      Parameters

                      Fires

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

                        Available since: 2.1.0

                        Parameters

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

                        Available since: 2.1.0

                        Parameters

                        Fires

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

                          Available since: 2.0.0

                          Parameters

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

                          Available since: 2.0.0

                          Parameters

                          Fires

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

                            Available since: 2.0.0

                            Parameters

                            Fires

                              ...

                              Available since: 2.0.0

                              Parameters

                              Fires

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

                                Available since: 2.1.0

                                Parameters

                                Fires

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

                                  Available since: 2.1.0

                                  Parameters

                                  Fires

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

                                    Available since: 2.1.0

                                    Parameters

                                    Fires

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

                                      Available since: 2.1.0

                                      Parameters

                                      Fires

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

                                        Available since: 2.0.0

                                        Parameters

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

                                        Available since: 2.0.0

                                        Parameters

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

                                        Available since: 2.0.0

                                        Parameters

                                        Fires

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

                                          Available since: 2.0.0

                                          Parameters

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

                                          Available since: 2.0.0

                                          Parameters

                                          Fires

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

                                            Available since: 2.0.0

                                            Parameters

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

                                            Available since: 2.0.0

                                            Parameters

                                            Fires

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

                                              Available since: 2.1.0

                                              Parameters

                                              Fires

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

                                                Available since: 2.0.0

                                                Parameters

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

                                                Available since: 2.0.0

                                                Parameters

                                                Ext.Component
                                                view source
                                                ( )private
                                                ...

                                                Available since: 2.0.0

                                                ( args ) : Objectdeprecatedprotected
                                                Call the original method that was previously overridden with override, This method is deprecated as callParent does ...

                                                Call the original method that was previously overridden with override,

                                                This method is deprecated as callParent does the same thing.

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

                                                Available since: 2.0.0

                                                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.

                                                Available since: 2.0.0

                                                Parameters

                                                • args : Array/Arguments

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

                                                Returns

                                                • Object

                                                  Returns the result of calling the parent method

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

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

                                                Consider:

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

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

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

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

                                                Available since: 2.1.0

                                                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

                                                ( operation, eventName, fn, scope, options, order ) : Objectchainableprivate
                                                ...

                                                Available since: 2.0.0

                                                Parameters

                                                Returns

                                                Removes all listeners for this object. ...

                                                Removes all listeners for this object.

                                                Available since: 1.1.0

                                                Fires

                                                  ...

                                                  Available since: 1.1.0

                                                  Parameters

                                                  Fires

                                                    ...

                                                    Available since: 2.0.0

                                                    Parameters

                                                    Fires

                                                      Creates an event handling function which re-fires the event from this object as the passed event name. ...

                                                      Creates an event handling function which re-fires the event from this object as the passed event name.

                                                      Available since: 2.0.0

                                                      Parameters

                                                      Returns

                                                      Fires

                                                        Ext.Component
                                                        view source
                                                        ( )
                                                        Destroys this Component. ...

                                                        Destroys this Component. If it is currently added to a Container it will first be removed from that Container. All Ext.Element references are also deleted and the Component is de-registered from Ext.ComponentManager

                                                        Available since: 1.1.0

                                                        Fires

                                                          Overrides: Ext.Base.destroy, Ext.Component.destroy, Ext.dataview.element.Container.destroy

                                                          Ext.Component
                                                          view source
                                                          ( )
                                                          Disables this Component ...

                                                          Disables this Component

                                                          Available since: 1.1.0

                                                          Fires

                                                            Ext.Component
                                                            view source
                                                            ( name, fn, scope, options ) : Booleanprivate
                                                            ...

                                                            Available since: 2.0.0

                                                            Parameters

                                                            Returns

                                                            Fires

                                                              Overrides: Ext.mixin.Observable.doAddListener

                                                              ( eventName, args, action, connectedController )private
                                                              ...

                                                              Available since: 2.0.0

                                                              Parameters

                                                              Fires

                                                                Ext.Component
                                                                view source
                                                                ( )private
                                                                ...

                                                                Available since: 2.1.0

                                                                Fires

                                                                Ext.Component
                                                                view source
                                                                ( )private
                                                                ...

                                                                Available since: 2.1.0

                                                                Fires

                                                                • sizeflagschange
                                                                • sizestatechange
                                                                Ext.Component
                                                                view source
                                                                ( name, fn, scope, options, order )private
                                                                ...

                                                                Available since: 2.0.0

                                                                Parameters

                                                                Fires

                                                                  Overrides: Ext.mixin.Observable.doRemoveListener

                                                                  ( me, value, oldValue, options )private
                                                                  ...

                                                                  Available since: 2.0.0

                                                                  Parameters

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

                                                                  Available since: 2.0.0

                                                                  Parameters

                                                                  Fires

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

                                                                    Available since: 2.0.0

                                                                    Parameters

                                                                    Fires

                                                                    • innerstatechange
                                                                    Ext.Component
                                                                    view source
                                                                    ( disabled )private
                                                                    ...

                                                                    Available since: 2.0.0

                                                                    Parameters

                                                                    Fires

                                                                      Ext.Component
                                                                      view source
                                                                      ( docked, oldDocked )private
                                                                      ...

                                                                      Available since: 2.0.0

                                                                      Parameters

                                                                      Fires

                                                                      • afterdockedchange
                                                                      • innerstatechange
                                                                      Ext.Component
                                                                      view source
                                                                      ( )private
                                                                      ...

                                                                      Available since: 2.1.0

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

                                                                      Available since: 2.0.0

                                                                      Parameters

                                                                      Fires

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

                                                                        Available since: 2.0.0

                                                                        Parameters

                                                                        Fires

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

                                                                          Available since: 2.0.0

                                                                          Parameters

                                                                          Fires

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

                                                                            Available since: 2.0.0

                                                                            Parameters

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

                                                                            Available since: 2.0.0

                                                                            Parameters

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

                                                                            Available since: 2.0.0

                                                                            Parameters

                                                                            Fires

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

                                                                              Available since: 2.0.0

                                                                              Parameters

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

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              Fires

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

                                                                                Available since: 2.0.0

                                                                                Parameters

                                                                                Fires

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

                                                                                  Available since: 2.0.0

                                                                                  Parameters

                                                                                  Fires

                                                                                    Ext.Component
                                                                                    view source
                                                                                    ( )
                                                                                    Enables this Component ...

                                                                                    Enables this Component

                                                                                    Available since: 1.1.0

                                                                                    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.

                                                                                      Available since: 1.1.0

                                                                                      Parameters

                                                                                      • events : String/String[]

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

                                                                                      Fires

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

                                                                                        Available since: 2.1.0

                                                                                        Parameters

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

                                                                                        Available since: 2.0.0

                                                                                        Parameters

                                                                                        ( eventName, args, fn, scope ) : Object
                                                                                        Fires the specified event with the passed parameters and execute a function (action) at the end if there are no liste...

                                                                                        Fires the specified event with the passed parameters and execute a function (action) at the end if there are no listeners that return false.

                                                                                        Available since: 2.0.0

                                                                                        Parameters

                                                                                        • eventName : String

                                                                                          The name of the event to fire.

                                                                                        • args : Array

                                                                                          Arguments to pass to handers.

                                                                                        • fn : Function

                                                                                          Action.

                                                                                        • scope : Object

                                                                                          Scope of fn.

                                                                                        Returns

                                                                                        Fires

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

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

                                                                                          The first argument is the name of the event. Every other argument passed will be available when you listen for the event.

                                                                                          Example

                                                                                          Firstly, we set up a listener for our new event.

                                                                                          this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
                                                                                              console.log(arg1); // true
                                                                                              console.log(arg2); // 2
                                                                                              console.log(arg3); // { test: 'foo' }
                                                                                              console.log(arg4); // 14
                                                                                              console.log(options); // the options added when adding the listener
                                                                                              console.log(e); // the event object with information about the event
                                                                                          });
                                                                                          

                                                                                          And then we can fire off the event.

                                                                                          this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);
                                                                                          

                                                                                          An event may be set to bubble up an Observable parent hierarchy by calling enableBubble.

                                                                                          Available since: 1.1.0

                                                                                          Parameters

                                                                                          • eventName : String

                                                                                            The name of the event to fire.

                                                                                          • args : Object...

                                                                                            Variable number of parameters are passed to handlers.

                                                                                          Returns

                                                                                          • Boolean

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

                                                                                          Fires

                                                                                            ...

                                                                                            Available since: 2.0.0

                                                                                            Fires

                                                                                              ...

                                                                                              Available since: 2.0.0

                                                                                              Fires

                                                                                                Ext.Component
                                                                                                view source
                                                                                                ( ) : String
                                                                                                Returns the value of baseCls. ...

                                                                                                Returns the value of baseCls.

                                                                                                Available since: 2.0.0

                                                                                                Returns

                                                                                                Returns the value of border. ...

                                                                                                Returns the value of border.

                                                                                                Available since: 2.0.0

                                                                                                Returns

                                                                                                Returns the value of bottom. ...

                                                                                                Returns the value of bottom.

                                                                                                Available since: 2.0.0

                                                                                                Returns

                                                                                                Returns the value of bubbleEvents. ...

                                                                                                Returns the value of bubbleEvents.

                                                                                                Available since: 2.0.0

                                                                                                Returns

                                                                                                Ext.Component
                                                                                                view source
                                                                                                ( )private
                                                                                                ...

                                                                                                Available since: 1.1.0

                                                                                                Fires

                                                                                                  Overrides: Ext.mixin.Observable.getBubbleTarget

                                                                                                  Returns the value of centered. ...

                                                                                                  Returns the value of centered.

                                                                                                  Available since: 2.0.0

                                                                                                  Returns

                                                                                                  Ext.Component
                                                                                                  view source
                                                                                                  ( ) : String/String[]
                                                                                                  Returns the value of cls. ...

                                                                                                  Returns the value of cls.

                                                                                                  Available since: 2.0.0

                                                                                                  Returns

                                                                                                  ...

                                                                                                  Available since: 2.0.0

                                                                                                  Parameters

                                                                                                  Ext.Component
                                                                                                  view source
                                                                                                  ( ) : Ext.Element/HTMLElement/String
                                                                                                  Returns the value of contentEl. ...

                                                                                                  Returns the value of contentEl.

                                                                                                  Available since: 2.0.0

                                                                                                  Returns

                                                                                                  ...

                                                                                                  Available since: 2.0.0

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

                                                                                                  Returns the value of data.

                                                                                                  Available since: 2.0.0

                                                                                                  Returns

                                                                                                  • Mixed
                                                                                                  Returns the value of disabled. ...

                                                                                                  Returns the value of disabled.

                                                                                                  Available since: 2.0.0

                                                                                                  Returns

                                                                                                  Returns the value of disabledCls. ...

                                                                                                  Returns the value of disabledCls.

                                                                                                  Available since: 2.0.0

                                                                                                  Returns

                                                                                                  Ext.Component
                                                                                                  view source
                                                                                                  ( ) : String
                                                                                                  Returns the value of docked. ...

                                                                                                  Returns the value of docked.

                                                                                                  Available since: 2.0.0

                                                                                                  Returns

                                                                                                  Ext.Component
                                                                                                  view source
                                                                                                  ( )private
                                                                                                  ...

                                                                                                  Available since: 2.0.0

                                                                                                  Fires

                                                                                                    Ext.Component
                                                                                                    view source
                                                                                                    ( )private
                                                                                                    ...

                                                                                                    Available since: 2.0.0

                                                                                                    Ext.Component
                                                                                                    view source
                                                                                                    ( ) : Ext.dom.Elementdeprecated
                                                                                                    Retrieves the top level element representing this component. ...

                                                                                                    Retrieves the top level element representing this component.

                                                                                                    Available since: 1.1.0

                                                                                                    This method has been deprecated since 2.0.0

                                                                                                    Please access the Component's element from the element property instead, i.e:

                                                                                                     var element = component.element;
                                                                                                    

                                                                                                    Returns

                                                                                                    Ext.Component
                                                                                                    view source
                                                                                                    ( ) : Objectprivate
                                                                                                    ...

                                                                                                    Available since: 2.0.0

                                                                                                    Returns

                                                                                                    Fires

                                                                                                      Overrides: Ext.AbstractComponent.getElementConfig

                                                                                                      Ext.Component
                                                                                                      view source
                                                                                                      ( ) : String/Mixeddeprecated
                                                                                                      Returns the value of enterAnimation. ...

                                                                                                      Returns the value of enterAnimation.

                                                                                                      Available since: 2.0.0

                                                                                                      This method has been deprecated since 2.0.0

                                                                                                      Please use showAnimation instead.

                                                                                                      Returns

                                                                                                      ...

                                                                                                      Available since: 2.0.0

                                                                                                      Fires

                                                                                                        Ext.Component
                                                                                                        view source
                                                                                                        ( ) : String/Mixeddeprecated
                                                                                                        Returns the value of exitAnimation. ...

                                                                                                        Returns the value of exitAnimation.

                                                                                                        Available since: 2.0.0

                                                                                                        This method has been deprecated since 2.0.0

                                                                                                        Please use hideAnimation instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.

                                                                                                        Returns

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

                                                                                                        Returns the value of flex.

                                                                                                        Available since: 2.0.0

                                                                                                        Returns

                                                                                                        Returns the value of floatingCls. ...

                                                                                                        Returns the value of floatingCls.

                                                                                                        Available since: 2.0.0

                                                                                                        Returns

                                                                                                        Returns the value of height. ...

                                                                                                        Returns the value of height.

                                                                                                        Available since: 1.1.0

                                                                                                        Returns

                                                                                                        Ext.Component
                                                                                                        view source
                                                                                                        ( ) : Boolean
                                                                                                        Returns the value of hidden. ...

                                                                                                        Returns the value of hidden.

                                                                                                        Available since: 2.0.0

                                                                                                        Returns

                                                                                                        Returns the value of hiddenCls. ...

                                                                                                        Returns the value of hiddenCls.

                                                                                                        Available since: 2.0.0

                                                                                                        Returns

                                                                                                        Ext.Component
                                                                                                        view source
                                                                                                        ( ) : String/Mixed
                                                                                                        Returns the value of hideAnimation. ...

                                                                                                        Returns the value of hideAnimation.

                                                                                                        Available since: 2.0.0

                                                                                                        Returns

                                                                                                        Ext.Component
                                                                                                        view source
                                                                                                        ( ) : String/Ext.Element/HTMLElement
                                                                                                        Returns the value of html. ...

                                                                                                        Returns the value of html.

                                                                                                        Available since: 2.0.0

                                                                                                        Returns

                                                                                                        Retrieves the id of this component. ...

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

                                                                                                        Available since: 2.0.0

                                                                                                        Returns

                                                                                                        Fires

                                                                                                          Returns the initial configuration passed to constructor. ...

                                                                                                          Returns the initial configuration passed to constructor.

                                                                                                          Available since: 2.0.0

                                                                                                          Parameters

                                                                                                          • name : String (optional)

                                                                                                            When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

                                                                                                          Returns

                                                                                                          Ext.Component
                                                                                                          view source
                                                                                                          ( )private
                                                                                                          ...

                                                                                                          Available since: 2.0.0

                                                                                                          Fires

                                                                                                            Ext.Component
                                                                                                            view source
                                                                                                            ( ) : String
                                                                                                            Returns the value of itemId. ...

                                                                                                            Returns the value of itemId.

                                                                                                            Available since: 1.1.0

                                                                                                            Returns

                                                                                                            Ext.Component
                                                                                                            view source
                                                                                                            ( ) : Number/String
                                                                                                            Returns the value of left. ...

                                                                                                            Returns the value of left.

                                                                                                            Available since: 2.0.0

                                                                                                            Returns

                                                                                                            Returns the value of listeners. ...

                                                                                                            Returns the value of listeners.

                                                                                                            Available since: 2.0.0

                                                                                                            Returns

                                                                                                            ...

                                                                                                            Available since: 2.0.0

                                                                                                            Parameters

                                                                                                            Returns the value of margin. ...

                                                                                                            Returns the value of margin.

                                                                                                            Available since: 2.0.0

                                                                                                            Returns

                                                                                                            Returns the value of maxHeight. ...

                                                                                                            Returns the value of maxHeight.

                                                                                                            Available since: 2.0.0

                                                                                                            Returns

                                                                                                            Returns the value of maxWidth. ...

                                                                                                            Returns the value of maxWidth.

                                                                                                            Available since: 2.0.0

                                                                                                            Returns

                                                                                                            Returns the value of minHeight. ...

                                                                                                            Returns the value of minHeight.

                                                                                                            Available since: 2.0.0

                                                                                                            Returns

                                                                                                            Returns the value of minWidth. ...

                                                                                                            Returns the value of minWidth.

                                                                                                            Available since: 2.0.0

                                                                                                            Returns

                                                                                                            ...

                                                                                                            Available since: 2.0.0

                                                                                                            Fires

                                                                                                              ...

                                                                                                              Available since: 2.0.0

                                                                                                              ...

                                                                                                              Available since: 2.0.0

                                                                                                              Returns the value of padding. ...

                                                                                                              Returns the value of padding.

                                                                                                              Available since: 2.0.0

                                                                                                              Returns

                                                                                                              Returns the parent of this component, if it has one. ...

                                                                                                              Returns the parent of this component, if it has one.

                                                                                                              Available since: 2.0.0

                                                                                                              Returns

                                                                                                              Returns the value of plugins. ...

                                                                                                              Returns the value of plugins.

                                                                                                              Available since: 2.0.0

                                                                                                              Returns

                                                                                                              Returns the value of record. ...

                                                                                                              Returns the value of record.

                                                                                                              Available since: 2.0.0

                                                                                                              Returns

                                                                                                              Returns the value of renderTo. ...

                                                                                                              Returns the value of renderTo.

                                                                                                              Available since: 2.0.0

                                                                                                              Returns

                                                                                                              Returns the value of right. ...

                                                                                                              Returns the value of right.

                                                                                                              Available since: 2.0.0

                                                                                                              Returns

                                                                                                              Ext.Component
                                                                                                              view source
                                                                                                              ( ) : String/Mixed
                                                                                                              Returns the value of showAnimation. ...

                                                                                                              Returns the value of showAnimation.

                                                                                                              Available since: 2.0.0

                                                                                                              Returns

                                                                                                              Ext.Component
                                                                                                              view source
                                                                                                              ( ) : Object
                                                                                                              Returns the height and width of the Component. ...

                                                                                                              Returns the height and width of the Component.

                                                                                                              Available since: 1.1.0

                                                                                                              Returns

                                                                                                              Fires

                                                                                                                Ext.Component
                                                                                                                view source
                                                                                                                ( )private
                                                                                                                ...

                                                                                                                Available since: 2.1.0

                                                                                                                Fires

                                                                                                                • sizeflagschange
                                                                                                                • sizestatechange
                                                                                                                Ext.Component
                                                                                                                view source
                                                                                                                ( )private
                                                                                                                ...

                                                                                                                Available since: 2.1.0

                                                                                                                Fires

                                                                                                                • sizeflagschange
                                                                                                                • sizestatechange
                                                                                                                Returns the value of style. ...

                                                                                                                Returns the value of style.

                                                                                                                Available since: 2.0.0

                                                                                                                Returns

                                                                                                                Returns the value of styleHtmlCls. ...

                                                                                                                Returns the value of styleHtmlCls.

                                                                                                                Available since: 2.0.0

                                                                                                                Returns

                                                                                                                Returns the value of styleHtmlContent. ...

                                                                                                                Returns the value of styleHtmlContent.

                                                                                                                Available since: 2.0.0

                                                                                                                Returns

                                                                                                                Ext.Component
                                                                                                                view source
                                                                                                                ( )private
                                                                                                                ...

                                                                                                                Available since: 2.0.0

                                                                                                                Ext.Component
                                                                                                                view source
                                                                                                                ( ) : Number/String
                                                                                                                Returns the value of top. ...

                                                                                                                Returns the value of top.

                                                                                                                Available since: 2.0.0

                                                                                                                Returns

                                                                                                                Returns the value of tpl. ...

                                                                                                                Returns the value of tpl.

                                                                                                                Available since: 2.0.0

                                                                                                                Returns

                                                                                                                Returns the value of tplWriteMode. ...

                                                                                                                Returns the value of tplWriteMode.

                                                                                                                Available since: 2.0.0

                                                                                                                Returns

                                                                                                                Ext.Component
                                                                                                                view source
                                                                                                                ( )private
                                                                                                                ...

                                                                                                                Available since: 2.0.0

                                                                                                                Fires

                                                                                                                  Ext.Component
                                                                                                                  view source
                                                                                                                  ( )private
                                                                                                                  ...

                                                                                                                  Available since: 2.0.0

                                                                                                                  Ext.Component
                                                                                                                  view source
                                                                                                                  ( ) : String
                                                                                                                  Returns the value of ui. ...

                                                                                                                  Returns the value of ui.

                                                                                                                  Available since: 2.0.0

                                                                                                                  Returns

                                                                                                                  ...

                                                                                                                  Available since: 2.0.0

                                                                                                                  ...

                                                                                                                  Available since: 2.0.0

                                                                                                                  Returns the value of width. ...

                                                                                                                  Returns the value of width.

                                                                                                                  Available since: 1.1.0

                                                                                                                  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.

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

                                                                                                                  Available since: 1.1.0

                                                                                                                  Returns

                                                                                                                  • String

                                                                                                                    The xtype hierarchy string.

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

                                                                                                                  Returns the value of zIndex.

                                                                                                                  Available since: 2.0.0

                                                                                                                  Returns

                                                                                                                  ...

                                                                                                                  Available since: 2.0.0

                                                                                                                  Parameters

                                                                                                                  Checks to see if this object has any listeners for a specified event ...

                                                                                                                  Checks to see if this object has any listeners for a specified event

                                                                                                                  Available since: 1.1.0

                                                                                                                  Parameters

                                                                                                                  • eventName : String

                                                                                                                    The name of the event to check for

                                                                                                                  Returns

                                                                                                                  • Boolean

                                                                                                                    True if the event is being listened for, else false

                                                                                                                  Fires

                                                                                                                    Ext.Component
                                                                                                                    view source
                                                                                                                    ( ) : Boolean
                                                                                                                    Returns true if this component has a parent. ...

                                                                                                                    Returns true if this component has a parent.

                                                                                                                    Available since: 2.0.0

                                                                                                                    Returns

                                                                                                                    • Boolean

                                                                                                                      true if this component has a parent.

                                                                                                                    Ext.Component
                                                                                                                    view source
                                                                                                                    ( [animation] ) : Ext.Componentchainable
                                                                                                                    Hides this Component ...

                                                                                                                    Hides this Component

                                                                                                                    Available since: 1.1.0

                                                                                                                    Parameters

                                                                                                                    Returns

                                                                                                                    Fires

                                                                                                                      ( instanceConfig ) : Objectchainableprotected
                                                                                                                      Initialize configuration for this class. ...

                                                                                                                      Initialize configuration for this class. a typical example:

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

                                                                                                                      Available since: 2.0.0

                                                                                                                      Parameters

                                                                                                                      Returns

                                                                                                                      • Object

                                                                                                                        mixins The mixin prototypes as key - value pairs

                                                                                                                      Fires

                                                                                                                        ...

                                                                                                                        Available since: 2.0.0

                                                                                                                        Returns

                                                                                                                        Fires

                                                                                                                          Ext.Component
                                                                                                                          view source
                                                                                                                          ( )protectedtemplate
                                                                                                                          Allows addition of behavior to the rendering phase. ...

                                                                                                                          Allows addition of behavior to the rendering phase.

                                                                                                                          Available since: 2.0.0

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

                                                                                                                          Overrides: Ext.Evented.initialize, Ext.Component.initialize, Ext.dataview.DataView.initialize

                                                                                                                          Ext.Component
                                                                                                                          view source
                                                                                                                          ( ) : Booleanprivate
                                                                                                                          ...

                                                                                                                          Available since: 2.0.0

                                                                                                                          Returns

                                                                                                                          Fires

                                                                                                                            Ext.Component
                                                                                                                            view source
                                                                                                                            ( ) : Boolean
                                                                                                                            Returns true if this Component is currently disabled. ...

                                                                                                                            Returns true if this Component is currently disabled.

                                                                                                                            Available since: 1.1.0

                                                                                                                            Returns

                                                                                                                            • Boolean

                                                                                                                              true if currently disabled.

                                                                                                                            Fires

                                                                                                                              Ext.Component
                                                                                                                              view source
                                                                                                                              ( )private
                                                                                                                              ...

                                                                                                                              Available since: 2.0.0

                                                                                                                              Fires

                                                                                                                                Ext.Component
                                                                                                                                view source
                                                                                                                                ( )private
                                                                                                                                ...

                                                                                                                                Available since: 1.1.0

                                                                                                                                Ext.Component
                                                                                                                                view source
                                                                                                                                ( ) : Boolean
                                                                                                                                Returns true if this Component is currently hidden. ...

                                                                                                                                Returns true if this Component is currently hidden.

                                                                                                                                Available since: 1.1.0

                                                                                                                                Returns

                                                                                                                                Fires

                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( )private
                                                                                                                                  ...

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( )private
                                                                                                                                  ...

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( )private
                                                                                                                                  ...

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  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.field.Text();
                                                                                                                                  var isText = t.isXType('textfield'); // true
                                                                                                                                  var isBoxSubclass = t.isXType('field'); // true, descended from Ext.field.Field
                                                                                                                                  var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.field.Field instance
                                                                                                                                  

                                                                                                                                  Available since: 1.1.0

                                                                                                                                  Parameters

                                                                                                                                  • xtype : String

                                                                                                                                    The xtype to check for this Component.

                                                                                                                                  • shallow : Boolean (optional)

                                                                                                                                    false to check whether this Component is descended from the xtype (this is the default), or true to check whether this Component is directly of the specified xtype.

                                                                                                                                  Returns

                                                                                                                                  • Boolean

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

                                                                                                                                  ( object, eventName, [fn], [scope], [options] )deprecated
                                                                                                                                  Alias for addManagedListener. ...

                                                                                                                                  Alias for addManagedListener.

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  This method has been deprecated since 2.0.0

                                                                                                                                  This is now done automatically

                                                                                                                                  Parameters

                                                                                                                                  • object : Ext.mixin.Observable/HTMLElement

                                                                                                                                    The item to which to add a listener/listeners.

                                                                                                                                  • eventName : Object/String

                                                                                                                                    The event name, or an object containing event name properties.

                                                                                                                                  • fn : Function (optional)

                                                                                                                                    If the eventName parameter was an event name, this is the handler function.

                                                                                                                                  • scope : Object (optional)

                                                                                                                                    If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                                                                                                                  • options : Object (optional)

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

                                                                                                                                  ( object, eventName, [fn], [scope] )deprecated
                                                                                                                                  Alias for removeManagedListener. ...

                                                                                                                                  Alias for removeManagedListener.

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  This method has been deprecated since 2.0.0

                                                                                                                                  This is now done automatically

                                                                                                                                  Parameters

                                                                                                                                  • object : Ext.mixin.Observable/HTMLElement

                                                                                                                                    The item to which to add a listener/listeners.

                                                                                                                                  • eventName : Object/String

                                                                                                                                    The event name, or an object containing event name properties.

                                                                                                                                  • fn : Function (optional)

                                                                                                                                    If the eventName parameter was an event name, this is the handler function.

                                                                                                                                  • scope : Object (optional)

                                                                                                                                    If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                                                                                                                  ( eventName, fn, [scope], [options], [order] )
                                                                                                                                  Alias for addListener. ...

                                                                                                                                  Alias for addListener.

                                                                                                                                  Available since: 1.1.0

                                                                                                                                  Parameters

                                                                                                                                  • eventName : String/String[]/Object

                                                                                                                                    The name of the event to listen for. May also be an object who's property names are event names.

                                                                                                                                  • fn : Function/String

                                                                                                                                    The method the event invokes. 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.

                                                                                                                                    This object may contain any of the following properties:

                                                                                                                                    • scope : Object (optional)

                                                                                                                                      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

                                                                                                                                    • delay : Number (optional)

                                                                                                                                      The number of milliseconds to delay the invocation of the handler after the event fires.

                                                                                                                                    • single : Boolean (optional)

                                                                                                                                      true to add a handler to handle just the next firing of the event, and then remove itself.

                                                                                                                                    • order : String (optional)

                                                                                                                                      The order of when the listener should be added into the listener queue.

                                                                                                                                      If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

                                                                                                                                      Available options are before, current and after.

                                                                                                                                      Defaults to: current

                                                                                                                                    • buffer : Number (optional)

                                                                                                                                      Causes the handler to be 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.

                                                                                                                                    • element : String (optional)

                                                                                                                                      Allows you to add a listener onto a element of this component using the elements reference.

                                                                                                                                      Ext.create('Ext.Component', {
                                                                                                                                          listeners: {
                                                                                                                                              element: 'element',
                                                                                                                                              tap: function() {
                                                                                                                                                  alert('element tap!');
                                                                                                                                              }
                                                                                                                                          }
                                                                                                                                      });
                                                                                                                                      

                                                                                                                                      All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

                                                                                                                                    • delegate : String (optional)

                                                                                                                                      Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

                                                                                                                                      // Create a container with a two children; a button and a toolbar
                                                                                                                                      var container = Ext.create('Ext.Container', {
                                                                                                                                          items: [
                                                                                                                                              {
                                                                                                                                                  xtype: 'toolbar',
                                                                                                                                                  docked: 'top',
                                                                                                                                                  title: 'My Toolbar'
                                                                                                                                              },
                                                                                                                                              {
                                                                                                                                                 xtype: 'button',
                                                                                                                                                 text: 'My Button'
                                                                                                                                              }
                                                                                                                                          ]
                                                                                                                                      });
                                                                                                                                      
                                                                                                                                      container.on({
                                                                                                                                          // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                                                                                                                                          delegate: 'button',
                                                                                                                                      
                                                                                                                                          tap: function() {
                                                                                                                                              alert('Button tapped!');
                                                                                                                                          }
                                                                                                                                      });
                                                                                                                                      
                                                                                                                                  • order : String (optional)

                                                                                                                                    The order of when the listener should be added into the listener queue. Possible values are before, current and after.

                                                                                                                                    Defaults to: 'current'

                                                                                                                                  ( eventName, fn, [scope], [options] )
                                                                                                                                  Alias for addAfterListener. ...

                                                                                                                                  Alias for addAfterListener.

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  Parameters

                                                                                                                                  • eventName : String/String[]/Object

                                                                                                                                    The name of the event to listen for.

                                                                                                                                  • fn : Function/String

                                                                                                                                    The method the event invokes.

                                                                                                                                  • scope : Object (optional)

                                                                                                                                    The scope for fn.

                                                                                                                                  • options : Object (optional)

                                                                                                                                    An object containing handler configuration.

                                                                                                                                  ( eventName, fn, [scope], [options] )
                                                                                                                                  Alias for addBeforeListener. ...

                                                                                                                                  Alias for addBeforeListener.

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  Parameters

                                                                                                                                  • eventName : String/String[]/Object

                                                                                                                                    The name of the event to listen for.

                                                                                                                                  • fn : Function/String

                                                                                                                                    The method the event invokes.

                                                                                                                                  • scope : Object (optional)

                                                                                                                                    The scope for fn.

                                                                                                                                  • options : Object (optional)

                                                                                                                                    An object containing handler configuration.

                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( cls, data )private
                                                                                                                                  Convert old properties in data into a config object ...

                                                                                                                                  Convert old properties in data into a config object

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  Parameters

                                                                                                                                  Overrides: Ext.mixin.Mixin.onClassExtended

                                                                                                                                  ( names, callback, scope )private
                                                                                                                                  ...

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  Parameters

                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( fn, scope )private
                                                                                                                                  ...

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  Parameters

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

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  Parameters

                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( )private
                                                                                                                                  ...

                                                                                                                                  Available since: 2.1.0

                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( )private
                                                                                                                                  ...

                                                                                                                                  Available since: 2.1.0

                                                                                                                                  Fires

                                                                                                                                  • innerstatechange
                                                                                                                                  Ext.Component
                                                                                                                                  view source
                                                                                                                                  ( )private
                                                                                                                                  ...

                                                                                                                                  Available since: 2.1.0

                                                                                                                                  ...

                                                                                                                                  Available since: 2.0.0

                                                                                                                                  Parameters

                                                                                                                                  Fires

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

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

                                                                                                                                    Available since: 1.1.0

                                                                                                                                    Parameters

                                                                                                                                    • object : Object

                                                                                                                                      The Observable whose events this object is to relay.

                                                                                                                                    • events : String/Array/Object

                                                                                                                                      Array of event names to relay.

                                                                                                                                    Returns

                                                                                                                                    Fires

                                                                                                                                      ( eventName, fn, [scope], [options] )
                                                                                                                                      Removes a before-event handler. ...

                                                                                                                                      Removes a before-event handler.

                                                                                                                                      Same as removeListener with order set to 'after'.

                                                                                                                                      Available since: 2.0.0

                                                                                                                                      Parameters

                                                                                                                                      • eventName : String/String[]/Object

                                                                                                                                        The name of the event the handler was associated with.

                                                                                                                                      • fn : Function/String

                                                                                                                                        The handler to remove.

                                                                                                                                      • scope : Object (optional)

                                                                                                                                        The scope originally specified for fn.

                                                                                                                                      • options : Object (optional)

                                                                                                                                        Extra options object.

                                                                                                                                      Fires

                                                                                                                                        ( eventName, fn, [scope], [options] )
                                                                                                                                        Removes a before-event handler. ...

                                                                                                                                        Removes a before-event handler.

                                                                                                                                        Same as removeListener with order set to 'before'.

                                                                                                                                        Available since: 2.0.0

                                                                                                                                        Parameters

                                                                                                                                        • eventName : String/String[]/Object

                                                                                                                                          The name of the event the handler was associated with.

                                                                                                                                        • fn : Function/String

                                                                                                                                          The handler to remove.

                                                                                                                                        • scope : Object (optional)

                                                                                                                                          The scope originally specified for fn.

                                                                                                                                        • options : Object (optional)

                                                                                                                                          Extra options object.

                                                                                                                                        Fires

                                                                                                                                          Ext.Component
                                                                                                                                          view source
                                                                                                                                          ( cls, [prefix], [suffix] )
                                                                                                                                          Removes the given CSS class(es) from this Component's rendered element. ...

                                                                                                                                          Removes the given CSS class(es) from this Component's rendered element.

                                                                                                                                          Available since: 1.1.0

                                                                                                                                          Parameters

                                                                                                                                          • cls : String

                                                                                                                                            The class(es) to remove.

                                                                                                                                          • prefix : String (optional)

                                                                                                                                            Optional prefix to prepend before each class.

                                                                                                                                            Defaults to: ""

                                                                                                                                          • suffix : String (optional)

                                                                                                                                            Optional suffix to append to each class.

                                                                                                                                            Defaults to: ""

                                                                                                                                          Fires

                                                                                                                                            ( selector, name, fn, scope, order )private
                                                                                                                                            ...

                                                                                                                                            Available since: 2.0.0

                                                                                                                                            Parameters

                                                                                                                                            Fires

                                                                                                                                              ( eventName, fn, [scope], [options], [order] )
                                                                                                                                              Removes an event handler. ...

                                                                                                                                              Removes an event handler.

                                                                                                                                              Available since: 1.1.0

                                                                                                                                              Parameters

                                                                                                                                              • eventName : String/String[]/Object

                                                                                                                                                The type of event the handler was associated with.

                                                                                                                                              • fn : Function/String

                                                                                                                                                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.

                                                                                                                                              • options : Object (optional)

                                                                                                                                                Extra options object. See addListener for details.

                                                                                                                                              • order : String (optional)

                                                                                                                                                The order of the listener to remove. Possible values are before, current and after.

                                                                                                                                                Defaults to: 'current'

                                                                                                                                              Fires

                                                                                                                                                ( object, eventName, [fn], [scope] )deprecated
                                                                                                                                                Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed. ...

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

                                                                                                                                                Available since: 1.1.0

                                                                                                                                                This method has been deprecated since 2.0

                                                                                                                                                All listeners are now automatically managed where necessary. Simply use removeListener.

                                                                                                                                                Parameters

                                                                                                                                                • object : Ext.mixin.Observable/HTMLElement

                                                                                                                                                  The item to which to add a listener/listeners.

                                                                                                                                                • eventName : Object/String

                                                                                                                                                  The event name, or an object containing event name properties.

                                                                                                                                                • fn : Function (optional)

                                                                                                                                                  If the eventName parameter was an event name, this is the handler function.

                                                                                                                                                • scope : Object (optional)

                                                                                                                                                  If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                                                                                                                                Ext.Component
                                                                                                                                                view source
                                                                                                                                                ( container, insertBeforeElement )private
                                                                                                                                                ...

                                                                                                                                                Available since: 2.0.0

                                                                                                                                                Parameters

                                                                                                                                                Fires

                                                                                                                                                  Ext.Component
                                                                                                                                                  view source
                                                                                                                                                  ( oldCls, newCls, [prefix], [suffix] )
                                                                                                                                                  Replaces specified classes with the newly specified classes. ...

                                                                                                                                                  Replaces specified classes with the newly specified classes. It uses the addCls and removeCls methods, so if the class(es) you are removing don't exist, it will still add the new classes.

                                                                                                                                                  Available since: 2.0.0

                                                                                                                                                  Parameters

                                                                                                                                                  • oldCls : String

                                                                                                                                                    The class(es) to remove.

                                                                                                                                                  • newCls : String

                                                                                                                                                    The class(es) to add.

                                                                                                                                                  • prefix : String (optional)

                                                                                                                                                    Optional prefix to prepend before each class.

                                                                                                                                                    Defaults to: ""

                                                                                                                                                  • suffix : String (optional)

                                                                                                                                                    Optional suffix to append to each class.

                                                                                                                                                    Defaults to: ""

                                                                                                                                                  Fires

                                                                                                                                                    Ext.Component
                                                                                                                                                    view source
                                                                                                                                                    ( )
                                                                                                                                                    Resets top, right, bottom and left configurations to null, which will un-float this component. ...

                                                                                                                                                    Resets top, right, bottom and left configurations to null, which will un-float this component.

                                                                                                                                                    Available since: 2.0.0

                                                                                                                                                    Fires

                                                                                                                                                      Resumes firing events (see suspendEvents). ...

                                                                                                                                                      Resumes firing events (see suspendEvents).

                                                                                                                                                      Available since: 1.1.0

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

                                                                                                                                                      Sets the value of baseCls.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

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

                                                                                                                                                      Sets the value of border.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

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

                                                                                                                                                      Sets the value of bottom.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

                                                                                                                                                      Sets the value of bubbleEvents. ...

                                                                                                                                                      Sets the value of bubbleEvents.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

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

                                                                                                                                                      Sets the value of centered.

                                                                                                                                                      Available since: 1.1.0

                                                                                                                                                      Parameters

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

                                                                                                                                                      Sets the value of cls.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

                                                                                                                                                      ( config, applyIfNotSet ) : Ext.Basechainableprivate
                                                                                                                                                      ...

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

                                                                                                                                                      Returns

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

                                                                                                                                                      Sets the value of contentEl.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

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

                                                                                                                                                      Sets the value of data.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

                                                                                                                                                      • data : Mixed
                                                                                                                                                      Ext.Component
                                                                                                                                                      view source
                                                                                                                                                      ( disabled )
                                                                                                                                                      Sets the value of disabled. ...

                                                                                                                                                      Sets the value of disabled.

                                                                                                                                                      Available since: 1.1.0

                                                                                                                                                      Parameters

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

                                                                                                                                                      Sets the value of disabledCls.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

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

                                                                                                                                                      Sets the value of docked.

                                                                                                                                                      Available since: 1.1.0

                                                                                                                                                      Parameters

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

                                                                                                                                                      Sets the value of draggable.

                                                                                                                                                      Available since: 1.1.0

                                                                                                                                                      Parameters

                                                                                                                                                      Ext.Component
                                                                                                                                                      view source
                                                                                                                                                      ( enterAnimation )deprecated
                                                                                                                                                      Sets the value of enterAnimation. ...

                                                                                                                                                      Sets the value of enterAnimation.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      This method has been deprecated since 2.0.0

                                                                                                                                                      Please use showAnimation instead.

                                                                                                                                                      Parameters

                                                                                                                                                      • enterAnimation : String/Mixed
                                                                                                                                                      Ext.Component
                                                                                                                                                      view source
                                                                                                                                                      ( exitAnimation )deprecated
                                                                                                                                                      Sets the value of exitAnimation. ...

                                                                                                                                                      Sets the value of exitAnimation.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      This method has been deprecated since 2.0.0

                                                                                                                                                      Please use hideAnimation instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.

                                                                                                                                                      Parameters

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

                                                                                                                                                      Sets the value of flex.

                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                      Parameters

                                                                                                                                                      Ext.Component
                                                                                                                                                      view source
                                                                                                                                                      ( floating )deprecated
                                                                                                                                                      Used to update the floating state of this component. ...

                                                                                                                                                      Used to update the floating state of this component.

                                                                                                                                                      Available since: 1.1.0

                                                                                                                                                      This method has been deprecated since 2.0.0

                                                                                                                                                      This has been deprecated. Please use setTop, setRight, setBottom and setLeft instead.

                                                                                                                                                      Parameters

                                                                                                                                                      • floating : Boolean

                                                                                                                                                        true if you want to float this component.

                                                                                                                                                      Fires

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

                                                                                                                                                        Sets the value of floatingCls.

                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                        Parameters

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

                                                                                                                                                        Sets the value of height.

                                                                                                                                                        Available since: 1.1.0

                                                                                                                                                        Parameters

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

                                                                                                                                                        Sets the value of hidden.

                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                        Parameters

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

                                                                                                                                                        Sets the value of hiddenCls.

                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                        Parameters

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

                                                                                                                                                        Sets the value of hideAnimation.

                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                        Parameters

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

                                                                                                                                                        Sets the value of html.

                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                        Parameters

                                                                                                                                                        ...

                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                        Parameters

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

                                                                                                                                                        Available since: 2.1.0

                                                                                                                                                        Parameters

                                                                                                                                                        Fires

                                                                                                                                                        • innerstatechange
                                                                                                                                                        Ext.Component
                                                                                                                                                        view source
                                                                                                                                                        ( itemId )
                                                                                                                                                        Sets the value of itemId. ...

                                                                                                                                                        Sets the value of itemId.

                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                        Parameters

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

                                                                                                                                                        Available since: 2.1.0

                                                                                                                                                        Parameters

                                                                                                                                                        Fires

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

                                                                                                                                                          Sets the value of left.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

                                                                                                                                                          Sets the value of listeners. ...

                                                                                                                                                          Sets the value of listeners.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Sets the value of margin.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Sets the value of maxHeight.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Sets the value of maxWidth.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Sets the value of minHeight.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Sets the value of minWidth.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Sets the value of padding.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

                                                                                                                                                          Ext.Component
                                                                                                                                                          view source
                                                                                                                                                          ( parent ) : Ext.Componentchainableprivate
                                                                                                                                                          ...

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

                                                                                                                                                          Returns

                                                                                                                                                          Overrides: Ext.mixin.Traversable.setParent

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

                                                                                                                                                          Sets the value of plugins.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Sets the value of record.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Sets the value of renderTo.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

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

                                                                                                                                                          Sets the value of right.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

                                                                                                                                                          Ext.Component
                                                                                                                                                          view source
                                                                                                                                                          ( )removed
                                                                                                                                                          This method has moved to Ext.Container. ...

                                                                                                                                                          This method has moved to Ext.Container. You can no longer use it in a Ext.Component.

                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                          This method has been removed since 2.0.0

                                                                                                                                                          This method has been moved from Ext.Component to Ext.Container

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

                                                                                                                                                          Sets the value of showAnimation.

                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                          Parameters

                                                                                                                                                          Ext.Component
                                                                                                                                                          view source
                                                                                                                                                          ( width, height )
                                                                                                                                                          Sets the size of the Component. ...

                                                                                                                                                          Sets the size of the Component.

                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                          Parameters

                                                                                                                                                          • width : Number

                                                                                                                                                            The new width for the Component.

                                                                                                                                                          • height : Number

                                                                                                                                                            The new height for the Component.

                                                                                                                                                          Fires

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

                                                                                                                                                            Available since: 2.1.0

                                                                                                                                                            Parameters

                                                                                                                                                            Fires

                                                                                                                                                            • sizeflagschange
                                                                                                                                                            Ext.Component
                                                                                                                                                            view source
                                                                                                                                                            ( state )private
                                                                                                                                                            ...

                                                                                                                                                            Available since: 2.1.0

                                                                                                                                                            Parameters

                                                                                                                                                            Fires

                                                                                                                                                            • sizestatechange
                                                                                                                                                            Ext.Component
                                                                                                                                                            view source
                                                                                                                                                            ( style )
                                                                                                                                                            Sets the value of style. ...

                                                                                                                                                            Sets the value of style.

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

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

                                                                                                                                                            Sets the value of styleHtmlCls.

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

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

                                                                                                                                                            Sets the value of styleHtmlContent.

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

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

                                                                                                                                                            Sets the value of top.

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

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

                                                                                                                                                            Sets the value of tpl.

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

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

                                                                                                                                                            Sets the value of tplWriteMode.

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

                                                                                                                                                            Ext.Component
                                                                                                                                                            view source
                                                                                                                                                            ( translatable )private
                                                                                                                                                            Sets the value of translatable. ...

                                                                                                                                                            Sets the value of translatable.

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

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

                                                                                                                                                            Sets the value of ui.

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

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

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

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

                                                                                                                                                            Sets the value of width.

                                                                                                                                                            Available since: 1.1.0

                                                                                                                                                            Parameters

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

                                                                                                                                                            Sets the value of zIndex.

                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                            Parameters

                                                                                                                                                            Ext.Component
                                                                                                                                                            view source
                                                                                                                                                            ( [animation] ) : Ext.Componentchainable
                                                                                                                                                            Shows this component. ...

                                                                                                                                                            Shows this component.

                                                                                                                                                            Available since: 1.1.0

                                                                                                                                                            Parameters

                                                                                                                                                            Returns

                                                                                                                                                            Fires

                                                                                                                                                              Ext.Component
                                                                                                                                                              view source
                                                                                                                                                              ( component, [alignment] )
                                                                                                                                                              Shows this component by another component. ...

                                                                                                                                                              Shows this component by another component. If you specify no alignment, it will automatically position this component relative to the reference component.

                                                                                                                                                              For example, say we are aligning a Panel next to a Button, the alignment string would look like this:

                                                                                                                                                              [panel-vertical (t/b/c)][panel-horizontal (l/r/c)]-[button-vertical (t/b/c)][button-horizontal (l/r/c)]
                                                                                                                                                              

                                                                                                                                                              where t = top, b = bottom, c = center, l = left, r = right.

                                                                                                                                                              Examples

                                                                                                                                                              • tl-tr means top-left corner of the Panel to the top-right corner of the Button
                                                                                                                                                              • tc-bc means top-center of the Panel to the bottom-center of the Button

                                                                                                                                                              You can put a '?' at the end of the alignment string to constrain the floating element to the Viewport

                                                                                                                                                              // show `panel` by `button` using the default positioning (auto fit)
                                                                                                                                                              panel.showBy(button);
                                                                                                                                                              
                                                                                                                                                              // align the top left corner of `panel` with the top right corner of `button` (constrained to viewport)
                                                                                                                                                              panel.showBy(button, "tl-tr?");
                                                                                                                                                              
                                                                                                                                                              // align the bottom right corner of `panel` with the center left edge of `button` (not constrained by viewport)
                                                                                                                                                              panel.showBy(button, "br-cl");
                                                                                                                                                              

                                                                                                                                                              Available since: 1.1.0

                                                                                                                                                              Parameters

                                                                                                                                                              • component : Ext.Component

                                                                                                                                                                The target component to show this component by.

                                                                                                                                                              • alignment : String (optional)

                                                                                                                                                                The specific alignment.

                                                                                                                                                              Fires

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

                                                                                                                                                                Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

                                                                                                                                                                Ext.define('My.Cat', {
                                                                                                                                                                    statics: {
                                                                                                                                                                        totalCreated: 0,
                                                                                                                                                                        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                                                                                                                                                                    },
                                                                                                                                                                
                                                                                                                                                                    constructor: function() {
                                                                                                                                                                        var statics = this.statics();
                                                                                                                                                                
                                                                                                                                                                        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                                                                                                                                                                        // equivalent to: My.Cat.speciesName
                                                                                                                                                                
                                                                                                                                                                        alert(this.self.speciesName);   // dependent on 'this'
                                                                                                                                                                
                                                                                                                                                                        statics.totalCreated++;
                                                                                                                                                                    },
                                                                                                                                                                
                                                                                                                                                                    clone: function() {
                                                                                                                                                                        var cloned = new this.self();                    // dependent on 'this'
                                                                                                                                                                
                                                                                                                                                                        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
                                                                                                                                                                
                                                                                                                                                                        return cloned;
                                                                                                                                                                    }
                                                                                                                                                                });
                                                                                                                                                                
                                                                                                                                                                
                                                                                                                                                                Ext.define('My.SnowLeopard', {
                                                                                                                                                                    extend: 'My.Cat',
                                                                                                                                                                
                                                                                                                                                                    statics: {
                                                                                                                                                                        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                                                                                                                                                                    },
                                                                                                                                                                
                                                                                                                                                                    constructor: function() {
                                                                                                                                                                        this.callParent();
                                                                                                                                                                    }
                                                                                                                                                                });
                                                                                                                                                                
                                                                                                                                                                var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
                                                                                                                                                                
                                                                                                                                                                var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
                                                                                                                                                                
                                                                                                                                                                var clone = snowLeopard.clone();
                                                                                                                                                                alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
                                                                                                                                                                alert(clone.groupName);                 // alerts 'Cat'
                                                                                                                                                                
                                                                                                                                                                alert(My.Cat.totalCreated);             // alerts 3
                                                                                                                                                                

                                                                                                                                                                Available since: 2.0.0

                                                                                                                                                                Returns

                                                                                                                                                                Suspends the firing of all events. ...

                                                                                                                                                                Suspends the firing of all events. (see resumeEvents)

                                                                                                                                                                Available since: 1.1.0

                                                                                                                                                                Ext.Component
                                                                                                                                                                view source
                                                                                                                                                                ( className, force ) : Ext.Componentchainableprivate
                                                                                                                                                                ...

                                                                                                                                                                Available since: 2.1.0

                                                                                                                                                                Parameters

                                                                                                                                                                Returns

                                                                                                                                                                ( toggle, eventName, fn, scope, options, order )private
                                                                                                                                                                ...

                                                                                                                                                                Available since: 2.1.0

                                                                                                                                                                Parameters

                                                                                                                                                                Fires

                                                                                                                                                                  Ext.Component
                                                                                                                                                                  view source
                                                                                                                                                                  ( )private
                                                                                                                                                                  ...

                                                                                                                                                                  Available since: 2.0.0

                                                                                                                                                                  Fires

                                                                                                                                                                    Ext.Component
                                                                                                                                                                    view source
                                                                                                                                                                    ( axis, value, animation )private
                                                                                                                                                                    ...

                                                                                                                                                                    Available since: 2.0.0

                                                                                                                                                                    Parameters

                                                                                                                                                                    Fires

                                                                                                                                                                      Ext.Component
                                                                                                                                                                      view source
                                                                                                                                                                      ( )private
                                                                                                                                                                      ...

                                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                                      ( eventName, fn, [scope], [options], [order] )
                                                                                                                                                                      Alias for removeListener. ...

                                                                                                                                                                      Alias for removeListener.

                                                                                                                                                                      Available since: 1.1.0

                                                                                                                                                                      Parameters

                                                                                                                                                                      • eventName : String/String[]/Object

                                                                                                                                                                        The type of event the handler was associated with.

                                                                                                                                                                      • fn : Function/String

                                                                                                                                                                        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.

                                                                                                                                                                      • options : Object (optional)

                                                                                                                                                                        Extra options object. See addListener for details.

                                                                                                                                                                      • order : String (optional)

                                                                                                                                                                        The order of the listener to remove. Possible values are before, current and after.

                                                                                                                                                                        Defaults to: 'current'

                                                                                                                                                                      ( eventName, fn, [scope], [options] )
                                                                                                                                                                      Alias for removeAfterListener. ...

                                                                                                                                                                      Alias for removeAfterListener.

                                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                                      Parameters

                                                                                                                                                                      • eventName : String/String[]/Object

                                                                                                                                                                        The name of the event the handler was associated with.

                                                                                                                                                                      • fn : Function/String

                                                                                                                                                                        The handler to remove.

                                                                                                                                                                      • scope : Object (optional)

                                                                                                                                                                        The scope originally specified for fn.

                                                                                                                                                                      • options : Object (optional)

                                                                                                                                                                        Extra options object.

                                                                                                                                                                      ( eventName, fn, [scope], [options] )
                                                                                                                                                                      Alias for removeBeforeListener. ...

                                                                                                                                                                      Alias for removeBeforeListener.

                                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                                      Parameters

                                                                                                                                                                      • eventName : String/String[]/Object

                                                                                                                                                                        The name of the event the handler was associated with.

                                                                                                                                                                      • fn : Function/String

                                                                                                                                                                        The handler to remove.

                                                                                                                                                                      • scope : Object (optional)

                                                                                                                                                                        The scope originally specified for fn.

                                                                                                                                                                      • options : Object (optional)

                                                                                                                                                                        Extra options object.

                                                                                                                                                                      Ext.Component
                                                                                                                                                                      view source
                                                                                                                                                                      ( [selector] ) : Ext.Container
                                                                                                                                                                      Walks up the ownerCt axis looking for an ancestor Container which matches the passed simple selector. ...

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

                                                                                                                                                                      Example:

                                                                                                                                                                      var owningTabPanel = grid.up('tabpanel');
                                                                                                                                                                      

                                                                                                                                                                      Available since: 1.1.0

                                                                                                                                                                      Parameters

                                                                                                                                                                      • selector : String (optional)

                                                                                                                                                                        The simple selector to test.

                                                                                                                                                                      Returns

                                                                                                                                                                      • Ext.Container

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

                                                                                                                                                                      Ext.Component
                                                                                                                                                                      view source
                                                                                                                                                                      ( )deprecated
                                                                                                                                                                      Updates the HTML content of the Component. ...

                                                                                                                                                                      Updates the HTML content of the Component.

                                                                                                                                                                      Available since: 1.1.0

                                                                                                                                                                      This method has been deprecated since 2.0.0

                                                                                                                                                                      Please use setHtml, setTpl or setData instead.

                                                                                                                                                                      Ext.Component
                                                                                                                                                                      view source
                                                                                                                                                                      ( newBaseCls, oldBaseCls )private
                                                                                                                                                                      ...

                                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                                      Parameters

                                                                                                                                                                      Fires

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

                                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                                        Parameters

                                                                                                                                                                        Ext.Component
                                                                                                                                                                        view source
                                                                                                                                                                        ( newCls, oldCls )private
                                                                                                                                                                        All cls methods directly report to the cls configuration, so anytime it changes, updateCls will be called ...

                                                                                                                                                                        All cls methods directly report to the cls configuration, so anytime it changes, updateCls will be called

                                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                                        Parameters

                                                                                                                                                                        Ext.Component
                                                                                                                                                                        view source
                                                                                                                                                                        ( newContentEl, oldContentEl )private
                                                                                                                                                                        ...

                                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                                        Parameters

                                                                                                                                                                        Fires

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

                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                          Parameters

                                                                                                                                                                          Fires

                                                                                                                                                                          Ext.Component
                                                                                                                                                                          view source
                                                                                                                                                                          ( newDisabledCls, oldDisabledCls )private
                                                                                                                                                                          ...

                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                          Parameters

                                                                                                                                                                          Fires

                                                                                                                                                                            Ext.Component
                                                                                                                                                                            view source
                                                                                                                                                                            ( newFloatingCls, oldFloatingCls )private
                                                                                                                                                                            Updates the floatingCls if the component is currently floating ...

                                                                                                                                                                            Updates the floatingCls if the component is currently floating

                                                                                                                                                                            Available since: 2.0.0

                                                                                                                                                                            Parameters

                                                                                                                                                                            Fires

                                                                                                                                                                              Ext.Component
                                                                                                                                                                              view source
                                                                                                                                                                              ( newHiddenCls, oldHiddenCls )private
                                                                                                                                                                              ...

                                                                                                                                                                              Available since: 2.0.0

                                                                                                                                                                              Parameters

                                                                                                                                                                              Fires

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

                                                                                                                                                                                Available since: 2.0.0

                                                                                                                                                                                Parameters

                                                                                                                                                                                Fires

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

                                                                                                                                                                                  Available since: 2.0.0

                                                                                                                                                                                  Parameters

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

                                                                                                                                                                                  Available since: 2.0.0

                                                                                                                                                                                  Parameters

                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                  view source
                                                                                                                                                                                  ( newPlugins, oldPlugins )private
                                                                                                                                                                                  ...

                                                                                                                                                                                  Available since: 2.0.0

                                                                                                                                                                                  Parameters

                                                                                                                                                                                  Ext.Component
                                                                                                                                                                                  view source
                                                                                                                                                                                  ( newRecord, oldRecord )private
                                                                                                                                                                                  ...

                                                                                                                                                                                  Available since: 2.0.0

                                                                                                                                                                                  Parameters

                                                                                                                                                                                  Fires

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

                                                                                                                                                                                  Available since: 2.0.0

                                                                                                                                                                                  Parameters

                                                                                                                                                                                  Fires

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

                                                                                                                                                                                    Available since: 2.0.0

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    Ext.Component
                                                                                                                                                                                    view source
                                                                                                                                                                                    ( newHtmlCls, oldHtmlCls )
                                                                                                                                                                                    Updates the styleHtmlCls configuration ...

                                                                                                                                                                                    Updates the styleHtmlCls configuration

                                                                                                                                                                                    Available since: 2.0.0

                                                                                                                                                                                    Parameters

                                                                                                                                                                                    Fires

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

                                                                                                                                                                                      Available since: 2.0.0

                                                                                                                                                                                      Parameters

                                                                                                                                                                                      Fires

                                                                                                                                                                                        Ext.Component
                                                                                                                                                                                        view source
                                                                                                                                                                                        ( newUi, oldUi )private
                                                                                                                                                                                        ...

                                                                                                                                                                                        Available since: 2.0.0

                                                                                                                                                                                        Parameters

                                                                                                                                                                                        Fires

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

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Defined By

                                                                                                                                                                                          Static methods

                                                                                                                                                                                          ( config, fullMerge )privatestatic
                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          ( members )chainableprivatestatic
                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          ( name, member )chainableprivatestatic
                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          ( members )chainablestatic
                                                                                                                                                                                          Add methods / properties to the prototype of this class. ...

                                                                                                                                                                                          Add methods / properties to the prototype of this class.

                                                                                                                                                                                          Ext.define('My.awesome.Cat', {
                                                                                                                                                                                              constructor: function() {
                                                                                                                                                                                                  // ...
                                                                                                                                                                                              }
                                                                                                                                                                                          });
                                                                                                                                                                                          
                                                                                                                                                                                           My.awesome.Cat.addMembers({
                                                                                                                                                                                               meow: function() {
                                                                                                                                                                                                  alert('Meowww...');
                                                                                                                                                                                               }
                                                                                                                                                                                           });
                                                                                                                                                                                          
                                                                                                                                                                                           var kitty = new My.awesome.Cat();
                                                                                                                                                                                           kitty.meow();
                                                                                                                                                                                          

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          ( members ) : Ext.Basechainablestatic
                                                                                                                                                                                          Add / override static properties of this class. ...

                                                                                                                                                                                          Add / override static properties of this class.

                                                                                                                                                                                          Ext.define('My.cool.Class', {
                                                                                                                                                                                              // this.se
                                                                                                                                                                                          });
                                                                                                                                                                                          
                                                                                                                                                                                          My.cool.Class.addStatics({
                                                                                                                                                                                              someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
                                                                                                                                                                                              method1: function() {  },    // My.cool.Class.method1 = function() { ... };
                                                                                                                                                                                              method2: function() {  }     // My.cool.Class.method2 = function() { ... };
                                                                                                                                                                                          });
                                                                                                                                                                                          

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Returns

                                                                                                                                                                                          ( xtype )chainableprivatestatic
                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          ( fromClass, members ) : Ext.Basechainableprivatestatic
                                                                                                                                                                                          Borrow another class' members to the prototype of this class. ...

                                                                                                                                                                                          Borrow another class' members to the prototype of this class.

                                                                                                                                                                                          Ext.define('Bank', {
                                                                                                                                                                                              money: '$$$',
                                                                                                                                                                                              printMoney: function() {
                                                                                                                                                                                                  alert('$$$$$$$');
                                                                                                                                                                                              }
                                                                                                                                                                                          });
                                                                                                                                                                                          
                                                                                                                                                                                          Ext.define('Thief', {
                                                                                                                                                                                              // ...
                                                                                                                                                                                          });
                                                                                                                                                                                          
                                                                                                                                                                                          Thief.borrow(Bank, ['money', 'printMoney']);
                                                                                                                                                                                          
                                                                                                                                                                                          var steve = new Thief();
                                                                                                                                                                                          
                                                                                                                                                                                          alert(steve.money); // alerts '$$$'
                                                                                                                                                                                          steve.printMoney(); // alerts '$$$$$$$'
                                                                                                                                                                                          

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          • fromClass : Ext.Base

                                                                                                                                                                                            The class to borrow members from

                                                                                                                                                                                          • members : Array/String

                                                                                                                                                                                            The names of the members to borrow

                                                                                                                                                                                          Returns

                                                                                                                                                                                          ( args )protectedstatic
                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          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.

                                                                                                                                                                                          Available since: 2.0.0

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

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          ( parent )privatestatic
                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Get the current class' name in string format. ...

                                                                                                                                                                                          Get the current class' name in string format.

                                                                                                                                                                                          Ext.define('My.cool.Class', {
                                                                                                                                                                                              constructor: function() {
                                                                                                                                                                                                  alert(this.self.getName()); // alerts 'My.cool.Class'
                                                                                                                                                                                              }
                                                                                                                                                                                          });
                                                                                                                                                                                          
                                                                                                                                                                                          My.cool.Class.getName(); // 'My.cool.Class'
                                                                                                                                                                                          

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Returns

                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 2.0.0

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

                                                                                                                                                                                          Used internally by the mixins pre-processor

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          ( fn, scope )chainableprivatestatic
                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          ( members ) : Ext.Basechainabledeprecatedstatic
                                                                                                                                                                                          Override members of this class. ...

                                                                                                                                                                                          Override members of this class. Overridden methods can be invoked via callParent.

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

                                                                                                                                                                                          As of 2.1, direct use of this method is deprecated. Use Ext.define instead:

                                                                                                                                                                                          Ext.define('My.CatOverride', {
                                                                                                                                                                                              override: 'My.Cat',
                                                                                                                                                                                          
                                                                                                                                                                                              constructor: function() {
                                                                                                                                                                                                  alert("I'm going to be a cat!");
                                                                                                                                                                                          
                                                                                                                                                                                                  var instance = this.callParent(arguments);
                                                                                                                                                                                          
                                                                                                                                                                                                  alert("Meeeeoooowwww");
                                                                                                                                                                                          
                                                                                                                                                                                                  return instance;
                                                                                                                                                                                              }
                                                                                                                                                                                          });
                                                                                                                                                                                          

                                                                                                                                                                                          The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          This method has been deprecated since 2.1.0

                                                                                                                                                                                          Please use Ext.define instead

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          • members : Object

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

                                                                                                                                                                                          Returns

                                                                                                                                                                                          ...

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Defined By

                                                                                                                                                                                          Events

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( eOpts )removed
                                                                                                                                                                                          Fires before orientation changes. ...

                                                                                                                                                                                          Fires before orientation changes.

                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                          This event has been removed since 2.0.0

                                                                                                                                                                                          This event is now only available onBefore the Viewport's Ext.Viewport.orientationchange

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the bottom configuration is changed by setBottom. ...

                                                                                                                                                                                          Fires when the bottom configuration is changed by setBottom.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the centered configuration is changed by setCentered. ...

                                                                                                                                                                                          Fires when the centered configuration is changed by setCentered.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the disabled configuration is changed by setDisabled. ...

                                                                                                                                                                                          Fires when the disabled configuration is changed by setDisabled.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the docked configuration is changed by setDocked. ...

                                                                                                                                                                                          Fires when the docked configuration is changed by setDocked.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, eOpts )
                                                                                                                                                                                          Fires when the component is no longer displayed in the DOM. ...

                                                                                                                                                                                          Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the flex configuration is changed by setFlex. ...

                                                                                                                                                                                          Fires when the flex configuration is changed by setFlex.

                                                                                                                                                                                          Available since: 2.1.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, floating, eOpts )
                                                                                                                                                                                          Fires whenever there is a change in the floating status of a component ...

                                                                                                                                                                                          Fires whenever there is a change in the floating status of a component

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, eOpts )
                                                                                                                                                                                          Fires whenever a Component with the fullscreen config is instantiated ...

                                                                                                                                                                                          Fires whenever a Component with the fullscreen config is instantiated

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the height configuration is changed by setHeight. ...

                                                                                                                                                                                          Fires when the height configuration is changed by setHeight.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the hidden configuration is changed by setHidden. ...

                                                                                                                                                                                          Fires when the hidden configuration is changed by setHidden.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, eOpts )
                                                                                                                                                                                          Fires whenever the Component is hidden ...

                                                                                                                                                                                          Fires whenever the Component is hidden

                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, eOpts )
                                                                                                                                                                                          Fires when the component has been initialized ...

                                                                                                                                                                                          Fires when the component has been initialized

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the left configuration is changed by setLeft. ...

                                                                                                                                                                                          Fires when the left configuration is changed by setLeft.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the maxHeight configuration is changed by setMaxHeight. ...

                                                                                                                                                                                          Fires when the maxHeight configuration is changed by setMaxHeight.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the maxWidth configuration is changed by setMaxWidth. ...

                                                                                                                                                                                          Fires when the maxWidth configuration is changed by setMaxWidth.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the minHeight configuration is changed by setMinHeight. ...

                                                                                                                                                                                          Fires when the minHeight configuration is changed by setMinHeight.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the minWidth configuration is changed by setMinWidth. ...

                                                                                                                                                                                          Fires when the minWidth configuration is changed by setMinWidth.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( eOpts )removed
                                                                                                                                                                                          Fires when orientation changes. ...

                                                                                                                                                                                          Fires when orientation changes.

                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                          This event has been removed since 2.0.0

                                                                                                                                                                                          This event is now only available on the Viewport's Ext.Viewport.orientationchange

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, eOpts )
                                                                                                                                                                                          Fires whenever this Element actually becomes visible (painted) on the screen. ...

                                                                                                                                                                                          Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.

                                                                                                                                                                                          Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly add at least one listener to it, for performance reasons.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, eOpts )
                                                                                                                                                                                          Important note: For the best performance on mobile devices, use this only when you absolutely need to monitor a Eleme...

                                                                                                                                                                                          Important note: For the best performance on mobile devices, use this only when you absolutely need to monitor a Element's size.

                                                                                                                                                                                          Note: This event is not available to be used with event delegation. Instead resize only fires if you explicitly add at least one listener to it, for performance reasons.

                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the right configuration is changed by setRight. ...

                                                                                                                                                                                          Fires when the right configuration is changed by setRight.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, eOpts )
                                                                                                                                                                                          Fires whenever the Component is shown ...

                                                                                                                                                                                          Fires whenever the Component is shown

                                                                                                                                                                                          Available since: 1.1.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the top configuration is changed by setTop. ...

                                                                                                                                                                                          Fires when the top configuration is changed by setTop.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, newData, eOpts )
                                                                                                                                                                                          Fires whenever the data of the component is updated ...

                                                                                                                                                                                          Fires whenever the data of the component is updated

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          Ext.Component
                                                                                                                                                                                          view source
                                                                                                                                                                                          ( this, value, oldValue, eOpts )
                                                                                                                                                                                          Fires when the width configuration is changed by setWidth. ...

                                                                                                                                                                                          Fires when the width configuration is changed by setWidth.

                                                                                                                                                                                          Available since: 2.0.0

                                                                                                                                                                                          Parameters