Touch Sencha Docs

Ext.Button

Hierarchy

Inherited mixins

Subclasses

Files

A simple class to display a button in Sencha Touch.

There are various different styles of Button you can create by using the icon, iconCls, iconAlign, ui, and text configurations.

Simple Button

Here is a Button in it's simplest form:

var button = Ext.create('Ext.Button', {
    text: 'Button'
});
Ext.Viewport.add({ xtype: 'container', padding: 10, items: [button] });

Icons

You can also create a Button with just an icon using the iconCls configuration:

var button = Ext.create('Ext.Button', {
    iconCls: 'refresh'
});
Ext.Viewport.add({ xtype: 'container', padding: 10, items: [button] });

Sencha provides the "Font" and "PNG" icons packs from http://wwww.pictos.cc. Use icons with the icon mixin in your Sass.

Badges

Buttons can also have a badge on them, by using the badgeText configuration:

Ext.create('Ext.Container', {
    fullscreen: true,
    padding: 10,
    items: {
        xtype: 'button',
        text: 'My Button',
        badgeText: '2'
    }
});

UI

Buttons also come with a range of different default UIs. Here are the included UIs available (if $include-button-uis is set to true):

  • normal - a basic gray button
  • back - a back button
  • forward - a forward button
  • round - a round button
  • action - shaded using the $active-color (dark blue by default)
  • decline - shaded using the $alert-color (red by default)
  • confirm - shaded using the $confirm-color (green by default)

You can also append -round to each of the last three UI's to give it a round shape:

  • action-round
  • decline-round
  • confirm-round

And setting them is very simple:

var uiButton = Ext.create('Ext.Button', {
    text: 'My Button',
    ui: 'action'
});

And how they look:

Ext.create('Ext.Container', {
    fullscreen: true,
    padding: 4,
    defaults: {
        xtype: 'button',
        margin: 5
    },
    layout: {
        type: 'vbox',
        align: 'center'
    },
    items: [
        { ui: 'normal', text: 'normal' },
        { ui: 'round', text: 'round' },
        { ui: 'action', text: 'action' },
        { ui: 'decline', text: 'decline' },
        { ui: 'confirm', text: 'confirm' }
    ]
});

Note that the default ui is normal.

You can also use the sencha-button-ui CSS Mixin to create your own UIs.

Example

This example shows a bunch of icons on the screen in two toolbars. When you click on the center button, it switches the iconCls on every button on the page.

Ext.createWidget('container', {
    fullscreen: true,
    layout: {
        type: 'vbox',
        pack:'center',
        align: 'center'
    },
    items: [
        {
            xtype: 'button',
            text: 'Change iconCls',
            handler: function() {
                // classes for all the icons to loop through.
                var availableIconCls = [
                    'action', 'add', 'arrow_down', 'arrow_left',
                    'arrow_right', 'arrow_up', 'compose', 'delete',
                    'organize', 'refresh', 'reply', 'search',
                    'settings', 'star', 'trash', 'maps', 'locate',
                    'home'
                ];
                // get the text of this button,
                // so we know which button we don't want to change
                var text = this.getText();

                // use ComponentQuery to find all buttons on the page
                // and loop through all of them
                Ext.Array.forEach(Ext.ComponentQuery.query('button'), function(button) {
                    // if the button is the change iconCls button, continue
                    if (button.getText() === text) {
                        return;
                    }

                    // get the index of the new available iconCls
                    var index = availableIconCls.indexOf(button.getIconCls()) + 1;

                    // update the iconCls of the button with the next iconCls, if one exists.
                    // if not, use the first one
                    button.setIconCls(availableIconCls[(index === availableIconCls.length) ? 0 : index]);
                });
            }
        },
        {
            xtype: 'toolbar',
            docked: 'top',
            items: [
                { xtype: 'spacer' },
                { iconCls: 'action' },
                { iconCls: 'add' },
                { iconCls: 'arrow_down' },
                { iconCls: 'arrow_left' },
                { iconCls: 'arrow_up' },
                { iconCls: 'compose' },
                { iconCls: 'delete' },
                { iconCls: 'organize' },
                { iconCls: 'refresh' },
                { xtype: 'spacer' }
            ]
        },
        {
            xtype: 'toolbar',
            docked: 'bottom',
            ui: 'light',
            items: [
                { xtype: 'spacer' },
                { iconCls: 'reply' },
                { iconCls: 'search' },
                { iconCls: 'settings' },
                { iconCls: 'star' },
                { iconCls: 'trash' },
                { iconCls: 'maps' },
                { iconCls: 'locate' },
                { iconCls: 'home' },
                { xtype: 'spacer' }
            ]
        }
    ]
});

Available since: 1.1.0

Defined By

Config options

Optional event name that will be fired instead of tap when the Button is tapped on.

Optional event name that will be fired instead of tap when the Button is tapped on.

Available since: 1.1.0

Ext.Button
view source
: Stringdeprecated
Optional badge text. ...

Optional badge text.

Available since: 2.0.0

This cfg has been deprected since 2.0.0

Please use badgeText instead

The CSS class to add to the Button's badge, if it has one. ...

The CSS class to add to the Button's badge, if it has one. Badges appear as small numbers, letters, or icons that sit on top of your button. For instance, a small red number indicating how many updates are available.

Defaults to: Ext.baseCSSPrefix + 'badge'

Available since: 1.1.0

Optional badge text. ...

Optional badge text. Badges appear as small numbers, letters, or icons that sit on top of your button. For instance, a small red number indicating how many updates are available.

Available since: 1.1.0

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

The base CSS class to apply to this component's element. This will also be prepended to other elements within this component. To add specific styling for sub-classes, use the cls config.

Defaults to: Ext.baseCSSPrefix + 'button'

Available since: 1.1.0

Overrides: Ext.Component.baseCls

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

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

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 deprected since 2.0.0

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

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

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 deprected since 2.0.0

This has been deprecated. Please use docked instead.

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

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 deprected since 2.0.0

Please use showAnimation instead.

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 deprected since 2.0.0

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

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

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 deprected 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 handler function to run when the Button is tapped on.

The handler function to run when the Button is tapped on.

Available since: 1.1.0

Ext.Button
view source
: Stringprivate
The CSS class to add to the Button if it has a badge (note that this goes on the Button element itself, not on the ba...

The CSS class to add to the Button if it has a badge (note that this goes on the Button element itself, not on the badge element).

Defaults to: Ext.baseCSSPrefix + 'hasbadge'

Available since: 2.0.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. If set to auto, it will set the width to null meaning it will have its own natural size.

Available since: 1.1.0

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

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'. For more animations, check the Ext.fx.Animation.type config.

Available since: 2.0.0

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

The HTML to put in this button. ...

The HTML to put in this button.

If you want to just add text, please use the text configuration.

Available since: 1.1.0

Overrides: Ext.Component.html

Url to the icon image to use if you want an icon to appear on your button. ...

Url to the icon image to use if you want an icon to appear on your button.

Defaults to: false

Available since: 1.1.0

The position within the Button to render the icon Options are: top, right, bottom, left and center (when you have no ...

The position within the Button to render the icon Options are: top, right, bottom, left and center (when you have no text set).

Defaults to: 'left'

Available since: 1.1.0

Optional CSS class to add to the icon element. ...

Optional CSS class to add to the icon element. This is useful if you want to use a CSS background image to create your Button icon.

Available since: 1.1.0

The unique id of this component instance. ...

The unique id of this component instance.

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

Instead of using assigned ids, use the itemId config, and ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The 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

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

The CSS class to add to the field's label element. ...

The CSS class to add to the field's label element.

Defaults to: Ext.baseCSSPrefix + 'button-label'

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. If set to auto, it will set the width to null meaning it will have its own natural size. 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. If set to auto, it will set the width to null meaning it will have its own natural size. 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. If set to auto, it will set the width to null meaning it will have its own natural size.

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. If set to auto, it will set the width to null meaning it will have its own natural size.

Available since: 1.1.0

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

The CSS class to add to the Button when it is pressed. ...

The CSS class to add to the Button when it is pressed.

Defaults to: Ext.baseCSSPrefix + 'button-pressing'

Available since: 1.1.0

The amount of delay between the tapstart and the moment we add the pressedCls (in milliseconds). ...

The amount of delay between the tapstart and the moment we add the pressedCls (in milliseconds). Settings this to true defaults to 100ms.

Defaults to: 0

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

The scope to fire the configured handler in.

The scope to fire the configured handler in.

Available since: 1.1.0

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

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'. For more animations, check the Ext.fx.Animation.type config.

Available since: 1.1.0

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

The Button text.

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

Available since: 2.0.0

Ext.Button
view source
: String
The ui style to render this button with. ...

The ui style to render this button with. The valid default options are:

  • 'normal' - a basic gray button (default).
  • 'back' - a back button.
  • 'forward' - a forward button.
  • 'round' - a round button.
  • 'plain'
  • 'action' - shaded using the $active-color (dark blue by default).
  • 'decline' - shaded using the $alert-color (red by default).
  • 'confirm' - shaded using the $confirm-color (green by default).

You can also append -round to each of the last three UI's to give it a round shape:

  • action-round
  • decline-round
  • confirm-round

Defaults to: 'normal'

Available since: 1.1.0

Overrides: Ext.Component.ui

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. If set to auto, it will set the width to null meaning it will have its own natural size.

Available since: 1.1.0

List of xtypes for Ext.Component. ...

List of xtypes for Ext.Component. XTypes must not contain periods.

Ext.define('MyApp.CoolPanel', {
    extend: 'Ext.panel.Panel',
    xtype: 'coolpanel',

    config: {
        html : 'Yeah!'
    }
});

// Using Ext.create
Ext.create('widget.coolpanel');

// Using the shorthand for widgets and in xtypes
Ext.widget('panel', {
    items: [
        {xtype: 'coolpanel', html: 'Foo'},
        {xtype: 'coolpanel', html: 'Bar'}
    ]
});

Available since: 2.0.0

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

...

Defaults to: 3

Available since: 2.1.0

...

Defaults to: 2

Available since: 2.1.0

...

Defaults to: 4

Available since: 2.1.0

...

Defaults to: 1

Available since: 2.1.0

Available since: 2.3.0

...

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

...

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

Available since: 2.0.0

Available since: 2.0.0

...

Defaults to: false

Available since: 2.2.0

...

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

Available since: 2.0.0

...

Defaults to: true

Available since: 1.1.0

...

Defaults to: true

Available since: 2.0.0

...

Defaults to: true

Available since: 2.1.0

...

Defaults to: true

Available since: 1.1.0

...

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

...

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

...

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

...

Defaults to: 0

Available since: 2.1.0

...

Defaults to: false

Available since: 2.1.0

Ext.Button
view source
: Arrayprivate
...

Defaults to: [{tag: 'span', reference: 'badgeElement', hidden: true}, {tag: 'span', className: Ext.baseCSSPrefix + 'button-icon', reference: 'iconElement'}, {tag: 'span', reference: 'textElement', hidden: true}]

Available since: 2.0.0

Overrides: Ext.Component.template

...

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

Available since: 2.0.0

...

Defaults to: false

Available since: 2.1.0

Defined By

Static properties

...

Defaults to: []

Available since: 2.0.0

Methods

Defined By

Instance methods

Creates new Component. ...

Creates new Component.

Available since: 1.1.0

Parameters

  • config : Object

    The standard configuration object.

Returns

Fires

Overrides: Ext.Evented.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.

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

( 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: ""

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

Available since: 2.0.0

Parameters

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 deprected 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.addListener('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.addListener({
    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.addListener({
    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.addListener({
          // 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'

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

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

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

( component, alignment )private
...

Available since: 1.1.0

Parameters

( animation, component, newState, oldState, options, controller )private
...

Available since: 2.0.0

Parameters

Ext.Button
view source
( autoEvent )private
...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Returns

Fires

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

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Fires

  • innerstatechange
...

Available since: 2.0.0

Parameters

...

Available since: 2.1.0

Parameters

...

Available since: 2.1.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.1.0

Parameters

...

Available since: 2.1.0

Parameters

...

Available since: 2.1.0

Parameters

...

Available since: 2.1.0

Parameters

...

Available since: 2.0.0

Parameters

Ext.Button
view source
( delay )private
...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Ext.Button
view source
( config )private
We override this to check for '{ui}-back'. ...

We override this to check for '{ui}-back'. This is because if you have a UI of back, you need to actually add two class names. The ui class, and the back class:

ui: 'action-back' would turn into:

class="x-button-action x-button-back"

But ui: 'action' would turn into:

class="x-button-action"

So we just split it up into an array and add both of them as a UI, when it has back.

Available since: 2.0.0

Parameters

...

Available since: 2.1.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

...

Available since: 2.3.0

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

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

( actionFn, eventName, fn, scope, options, order ) : Ext.mixin.Observablechainableprivate
...

Available since: 2.0.0

Parameters

Returns

Removes all listeners for this object. ...

Removes all listeners for this object.

Available since: 1.1.0

...

Available since: 1.1.0

Parameters

...

Available since: 2.0.0

Parameters

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

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

Overrides: Ext.Base.destroy

Disables this Component ...

Disables this Component

Available since: 1.1.0

( name, fn, scope, options, order ) : Booleanprivate
...

Available since: 2.0.0

Parameters

Returns

Overrides: Ext.mixin.Observable.doAddListener

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

Available since: 2.0.0

Parameters

...

Available since: 2.1.0

Fires

...

Available since: 2.1.0

Fires

  • sizeflagschange
  • sizestatechange
Ext.Button
view source
( me, e )private
...

Available since: 2.0.0

Parameters

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

Available since: 2.0.0

Parameters

Overrides: Ext.mixin.Observable.doRemoveListener

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

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Fires

  • innerstatechange
...

Available since: 2.0.0

Parameters

( docked, oldDocked )private
...

Available since: 2.0.0

Parameters

Fires

  • afterdockedchange
  • innerstatechange
...

Available since: 2.1.0

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Ext.Button
view source
( me, e )private
...

Available since: 2.0.0

Parameters

Enables this Component ...

Enables this Component

Available since: 1.1.0

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.

...

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

( component, alignment )protected
Prepares information on aligning this to component using alignment. ...

Prepares information on aligning this to component using alignment. Also checks to see if this is already aligned to component according to alignment.

Available since: 2.3.0

Parameters

...

Available since: 2.0.0

...

Available since: 2.0.0

Returns the value of autoEvent. ...

Returns the value of autoEvent.

Available since: 2.0.0

Returns

Returns the value of badgeCls. ...

Returns the value of badgeCls.

Available since: 2.0.0

Returns

Returns the value of badgeText. ...

Returns the value of badgeText.

Available since: 1.1.0

Returns

Returns the value of baseCls. ...

Returns the value of baseCls.

Available since: 2.0.0

Returns

Overrides: Ext.Component.getBaseCls

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

Returns the value of centered. ...

Returns the value of centered.

Available since: 2.0.0

Returns

Returns the value of cls. ...

Returns the value of cls.

Available since: 2.0.0

Returns

...

Available since: 2.0.0

Parameters

Returns the value of contentEl. ...

Returns the value of contentEl.

Available since: 2.0.0

Returns

Current Alignment information from the last alignTo call ...

Current Alignment information from the last alignTo call

Available since: 2.3.0

...

Available since: 2.0.0

Returns the value of data. ...

Returns the value of data.

Available since: 2.0.0

Returns

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

Returns the value of docked. ...

Returns the value of docked.

Available since: 2.0.0

Returns

...

Available since: 2.0.0

...

Available since: 2.0.0

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 deprected since 2.0.0

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

 var element = component.element;

Returns

...

Available since: 2.0.0

Returns

Overrides: Ext.AbstractComponent.getElementConfig

Returns the value of enterAnimation. ...

Returns the value of enterAnimation.

Available since: 2.0.0

This method has been deprected since 2.0.0

Please use showAnimation instead.

Returns

...

Available since: 2.0.0

Returns the value of exitAnimation. ...

Returns the value of exitAnimation.

Available since: 2.0.0

This method has been deprected since 2.0.0

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

Returns

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

Returns the value of handler.

Available since: 2.0.0

Returns

Ext.Button
view source
( ) : Stringprivate
Returns the value of hasBadgeCls. ...

Returns the value of hasBadgeCls.

Available since: 2.0.0

Returns

Returns the value of height. ...

Returns the value of height.

Available since: 1.1.0

Returns

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

Returns the value of hideAnimation. ...

Returns the value of hideAnimation.

Available since: 2.0.0

Returns

Returns the value of html. ...

Returns the value of html.

Available since: 2.0.0

Returns

Ext.Button
view source
( ) : String
Returns the value of icon. ...

Returns the value of icon.

Available since: 2.0.0

Returns

Returns the value of iconAlign. ...

Returns the value of iconAlign.

Available since: 2.0.0

Returns

Returns the value of iconCls. ...

Returns the value of iconCls.

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

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

...

Available since: 2.0.0

Returns the value of itemId. ...

Returns the value of itemId.

Available since: 1.1.0

Returns

Returns the value of labelCls. ...

Returns the value of labelCls.

Available since: 2.0.0

Returns

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

...

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

Returns the value of pressedCls.

Available since: 2.0.0

Returns

Returns the value of pressedDelay. ...

Returns the value of pressedDelay.

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

Returns the value of scope. ...

Returns the value of scope.

Available since: 2.0.0

Returns

Returns the value of showAnimation. ...

Returns the value of showAnimation.

Available since: 2.0.0

Returns

Returns the height and width of the Component. ...

Returns the height and width of the Component.

Available since: 1.1.0

Returns

...

Available since: 2.1.0

Fires

  • sizeflagschange
  • sizestatechange
...

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

...

Available since: 2.0.0

Ext.Button
view source
( ) : String
Returns the value of text. ...

Returns the value of text.

Available since: 1.1.0

Returns

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

...

Available since: 2.0.0

...

Available since: 2.0.0

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

Returns the value of ui.

Available since: 2.0.0

Returns

Overrides: Ext.Component.getUi

...

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

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.

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

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.

Hides this Component optionally using an animation. ...

Hides this Component optionally using an animation.

Available since: 1.1.0

Parameters

Returns

Ext.Button
view source
( )private
Used by icon and iconCls configurations to hide the icon element. ...

Used by icon and iconCls configurations to hide the icon element.

Available since: 2.0.0

( 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

...

Available since: 2.0.0

Returns

Ext.Button
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.Component.initialize

...

Available since: 2.0.0

Returns

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.

...

Available since: 2.0.0

...

Available since: 1.1.0

Returns true if this Component is currently hidden. ...

Returns true if this Component is currently hidden.

Available since: 1.1.0

Returns

...

Available since: 2.0.0

...

Available since: 2.0.0

...

Available since: 2.0.0

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 deprected 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 deprected 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.addListener({
          // 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.

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

( fn, scope, args )private
...

Available since: 2.0.0

Parameters

Ext.Button
view source
( )private
...

Available since: 1.1.0

Ext.Button
view source
( e )private
...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Ext.Button
view source
( e )private
...

Available since: 2.0.0

Parameters

...

Available since: 2.1.0

Ext.Button
view source
( )private
...

Available since: 2.0.0

...

Available since: 2.1.0

Fires

  • innerstatechange
...

Available since: 2.1.0

( args, fn, scope, options, order )private
...

Available since: 2.0.0

Parameters

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

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

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

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

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

( 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: ""

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

Available since: 2.0.0

Parameters

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

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

( container, insertBeforeElement )private
...

Available since: 2.0.0

Parameters

( 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: ""

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

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

Available since: 1.1.0

Parameters

  • discardQueuedEvents : Boolean

    Pass as true to discard any queued events.

Ext.Button
view source
( autoEvent )
Sets the value of autoEvent. ...

Sets the value of autoEvent.

Available since: 2.0.0

Parameters

  • autoEvent : String

    The new value.

Ext.Button
view source
( text )deprecated
Updates the badge text. ...

Updates the badge text.

Available since: 1.1.0

This method has been deprected since 2.0.0

Please use setBadgeText instead.

Parameters

Ext.Button
view source
( badgeCls )
Sets the value of badgeCls. ...

Sets the value of badgeCls.

Available since: 2.0.0

Parameters

  • badgeCls : String

    The new value.

Ext.Button
view source
( badgeText )
Sets the value of badgeText. ...

Sets the value of badgeText.

Available since: 2.0.0

Parameters

  • badgeText : String

    The new value.

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

Sets the value of baseCls.

Available since: 2.0.0

Parameters

  • baseCls : String

    The new value.

Overrides: Ext.Component.setBaseCls

Sets the value of border. ...

Sets the value of border.

Available since: 2.0.0

Parameters

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

Sets the value of centered. ...

Sets the value of centered.

Available since: 1.1.0

Parameters

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

Sets the value of contentEl. ...

Sets the value of contentEl.

Available since: 2.0.0

Parameters

Sets the current Alignment information, called by alignTo ...

Sets the current Alignment information, called by alignTo

Available since: 2.3.0

Parameters

Sets the value of data. ...

Sets the value of data.

Available since: 2.0.0

Parameters

Sets the value of disabled. ...

Sets the value of disabled.

Available since: 1.1.0

Parameters

Sets the value of disabledCls. ...

Sets the value of disabledCls.

Available since: 2.0.0

Parameters

  • disabledCls : String

    The new value.

Sets the value of docked. ...

Sets the value of docked.

Available since: 1.1.0

Parameters

  • docked : String

    The new value.

Sets the value of draggable. ...

Sets the value of draggable.

Available since: 1.1.0

Parameters

  • draggable : Object

    The new value.

( enterAnimation )deprecated
Sets the value of enterAnimation. ...

Sets the value of enterAnimation.

Available since: 2.0.0

This method has been deprected since 2.0.0

Please use showAnimation instead.

Parameters

  • enterAnimation : String/Mixed

    The new value.

( exitAnimation )deprecated
Sets the value of exitAnimation. ...

Sets the value of exitAnimation.

Available since: 2.0.0

This method has been deprected since 2.0.0

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

Parameters

  • exitAnimation : String/Mixed

    The new value.

Sets the value of flex. ...

Sets the value of flex.

Available since: 2.0.0

Parameters

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

Sets the value of floatingCls. ...

Sets the value of floatingCls.

Available since: 2.0.0

Parameters

  • floatingCls : String

    The new value.

Ext.Button
view source
( handler )
Sets the value of handler. ...

Sets the value of handler.

Available since: 1.1.0

Parameters

Ext.Button
view source
( hasBadgeCls )private
Sets the value of hasBadgeCls. ...

Sets the value of hasBadgeCls.

Available since: 2.0.0

Parameters

  • hasBadgeCls : String

    The new value.

Sets the value of height. ...

Sets the value of height.

Available since: 1.1.0

Parameters

Sets the value of hidden. ...

Sets the value of hidden.

Available since: 2.0.0

Parameters

Sets the value of hiddenCls. ...

Sets the value of hiddenCls.

Available since: 2.0.0

Parameters

  • hiddenCls : String

    The new value.

Sets the value of hideAnimation. ...

Sets the value of hideAnimation.

Available since: 2.0.0

Parameters

  • hideAnimation : String/Mixed

    The new value.

Sets the value of html. ...

Sets the value of html.

Available since: 2.0.0

Parameters

Ext.Button
view source
( icon )
Sets the value of icon. ...

Sets the value of icon.

Available since: 1.1.0

Parameters

Ext.Button
view source
( iconAlign )
Sets the value of iconAlign. ...

Sets the value of iconAlign.

Available since: 1.1.0

Parameters

  • iconAlign : String

    The new value.

Ext.Button
view source
( iconClass )deprecated
Updates the icon class ...

Updates the icon class

Available since: 1.1.0

This method has been deprected since 2.0.0

Please use setIconCls instead.

Parameters

Ext.Button
view source
( iconCls )
Sets the value of iconCls. ...

Sets the value of iconCls.

Available since: 2.0.0

Parameters

  • iconCls : String

    The new value.

...

Available since: 2.0.0

Parameters

...

Available since: 2.1.0

Parameters

Fires

  • innerstatechange
Sets the value of itemId. ...

Sets the value of itemId.

Available since: 2.0.0

Parameters

  • itemId : String

    The new value.

Ext.Button
view source
( labelCls )
Sets the value of labelCls. ...

Sets the value of labelCls.

Available since: 2.0.0

Parameters

  • labelCls : String

    The new value.

...

Available since: 2.1.0

Parameters

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

  • listeners : Object

    The new value.

Sets the value of margin. ...

Sets the value of margin.

Available since: 2.0.0

Parameters

Sets the value of maxHeight. ...

Sets the value of maxHeight.

Available since: 2.0.0

Parameters

Sets the value of maxWidth. ...

Sets the value of maxWidth.

Available since: 2.0.0

Parameters

Sets the value of minHeight. ...

Sets the value of minHeight.

Available since: 2.0.0

Parameters

Sets the value of minWidth. ...

Sets the value of minWidth.

Available since: 2.0.0

Parameters

Sets the value of padding. ...

Sets the value of padding.

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Returns

Overrides: Ext.mixin.Traversable.setParent

Sets the value of plugins. ...

Sets the value of plugins.

Available since: 2.0.0

Parameters

Ext.Button
view source
( pressedCls )
Sets the value of pressedCls. ...

Sets the value of pressedCls.

Available since: 2.0.0

Parameters

  • pressedCls : String

    The new value.

Ext.Button
view source
( pressedDelay )
Sets the value of pressedDelay. ...

Sets the value of pressedDelay.

Available since: 2.0.0

Parameters

Sets the value of record. ...

Sets the value of record.

Available since: 2.0.0

Parameters

Sets the value of renderTo. ...

Sets the value of renderTo.

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Sets the value of right. ...

Sets the value of right.

Available since: 2.0.0

Parameters

Ext.Button
view source
( scope )
Sets the value of scope. ...

Sets the value of scope.

Available since: 2.0.0

Parameters

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

Sets the value of showAnimation. ...

Sets the value of showAnimation.

Available since: 2.0.0

Parameters

  • showAnimation : String/Mixed

    The new value.

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.

...

Available since: 2.1.0

Parameters

Fires

  • sizeflagschange
...

Available since: 2.1.0

Parameters

Fires

  • sizestatechange
Sets the value of style. ...

Sets the value of style.

Available since: 2.0.0

Parameters

Sets the value of styleHtmlCls. ...

Sets the value of styleHtmlCls.

Available since: 2.0.0

Parameters

  • styleHtmlCls : String

    The new value.

Sets the value of styleHtmlContent. ...

Sets the value of styleHtmlContent.

Available since: 2.0.0

Parameters

  • styleHtmlContent : Boolean

    The new value.

Ext.Button
view source
( text )
Sets the value of text. ...

Sets the value of text.

Available since: 1.1.0

Parameters

Sets the value of top. ...

Sets the value of top.

Available since: 2.0.0

Parameters

Sets the value of tpl. ...

Sets the value of tpl.

Available since: 2.0.0

Parameters

Sets the value of tplWriteMode. ...

Sets the value of tplWriteMode.

Available since: 2.0.0

Parameters

  • tplWriteMode : String

    The new value.

Sets the value of translatable. ...

Sets the value of translatable.

Available since: 2.0.0

Parameters

  • translatable : Object

    The new value.

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

Sets the value of ui.

Available since: 2.0.0

Parameters

Overrides: Ext.Component.setUi

...

Available since: 2.0.0

Parameters

Sets the value of width. ...

Sets the value of width.

Available since: 1.1.0

Parameters

Sets the value of zIndex. ...

Sets the value of zIndex.

Available since: 2.0.0

Parameters

  • zIndex : Number

    The new value.

Shows this component optionally using an animation. ...

Shows this component optionally using an animation.

Available since: 1.1.0

Parameters

Returns

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

Ext.Button
view source
( )private
Used by icon and iconCls configurations to show the icon element. ...

Used by icon and iconCls configurations to show the icon element.

Available since: 2.0.0

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.

All events will be queued but you can discard the queued events by passing false in the resumeEvents call

Available since: 1.1.0

( className, force ) : Ext.Componentchainableprivate
...

Available since: 2.1.0

Parameters

Returns

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

Available since: 2.1.0

Parameters

...

Available since: 2.0.0

( axis, value, animation )private
...

Available since: 2.0.0

Parameters

...

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.

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

Updates the HTML content of the Component. ...

Updates the HTML content of the Component.

Available since: 1.1.0

This method has been deprected since 2.0.0

Please use setHtml, setTpl or setData instead.

Ext.Button
view source
( autoEvent )private
...

Available since: 2.0.0

Parameters

Ext.Button
view source
( badgeCls, oldBadgeCls )private
...

Available since: 2.0.0

Parameters

Ext.Button
view source
( badgeText )private
...

Available since: 2.0.0

Parameters

( newBaseCls, oldBaseCls )private
...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

( 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

( newContentEl, oldContentEl )private
...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Fires

( newDisabledCls, oldDisabledCls )private
...

Available since: 2.0.0

Parameters

( 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

Ext.Button
view source
( hasBadgeCls, oldHasBadgeCls )private
...

Available since: 2.0.0

Parameters

( newHiddenCls, oldHiddenCls )private
...

Available since: 2.0.0

Parameters

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

Available since: 2.0.0

Parameters

Overrides: Ext.Component.updateHtml

Ext.Button
view source
( icon )private
...

Available since: 2.0.0

Parameters

Ext.Button
view source
( alignment, oldAlignment )private
...

Available since: 2.0.0

Parameters

Ext.Button
view source
( iconCls, oldIconCls )private
...

Available since: 2.0.0

Parameters

Ext.Button
view source
( labelCls, oldLabelCls )private
...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

( newPlugins, oldPlugins )private
...

Available since: 2.0.0

Parameters

Ext.Button
view source
( pressedCls, oldPressedCls )private
...

Available since: 2.0.0

Parameters

( newRecord, oldRecord )private
...

Available since: 2.0.0

Parameters

Fires

...

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Updates the styleHtmlCls configuration ...

Updates the styleHtmlCls configuration

Available since: 2.0.0

Parameters

...

Available since: 2.0.0

Parameters

Ext.Button
view source
( text )private
...

Available since: 2.0.0

Parameters

( newUi, oldUi )private
...

Available since: 2.0.0

Parameters

...

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

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

( 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

( 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

Fires when the component is destroyed ...

Fires when the component is destroyed

Available since: 1.1.0

Parameters

( 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

( 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

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

( 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

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

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

( 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

( 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

Fires whenever the Component is hidden ...

Fires whenever the Component is hidden

Available since: 1.1.0

Parameters

Fires when the component has been initialized ...

Fires when the component has been initialized

Available since: 2.0.0

Parameters

( 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

( 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

( 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

( 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

( 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

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

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.Button
view source
( this, e, eOpts )preventable
Fires whenever the button is released. ...

Fires whenever the button is released.

Available since: 2.0.0

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

Parameters

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

( 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

Fires whenever the Component is shown ...

Fires whenever the Component is shown

Available since: 1.1.0

Parameters

Ext.Button
view source
( this, e, eOpts )preventable
Fires whenever a button is tapped. ...

Fires whenever a button is tapped.

Available since: 1.1.0

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

Parameters

( 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

( 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

( 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

Defined By

CSS Variables

Ext.Button
view source
: string
Default gradient for buttons. ...

Default gradient for buttons.

Defaults to: $base-gradient

Available since: 1.1.1

Ext.Button
view source
: measurement
Default height for buttons. ...

Default height for buttons.

Defaults to: 1.8em

Available since: 1.1.1

Ext.Button
view source
: measurement
Default border-radius for buttons. ...

Default border-radius for buttons. Please note, you can only use em as a value here.

Defaults to: .4em

Available since: 1.1.1

Ext.Button
view source
: measurement
Default border width for buttons. ...

Default border width for buttons.

Defaults to: 1px

Available since: 1.1.1

Optionally disable special CSS3 effects on buttons including gradients, text-shadows, and box-shadows. ...

Optionally disable special CSS3 effects on buttons including gradients, text-shadows, and box-shadows.

Defaults to: $include-highlights

Available since: 1.1.1

Ext.Button
view source
: boolean
Optionally disable separate button UIs, including action, confirm, and decline. ...

Optionally disable separate button UIs, including action, confirm, and decline.

Defaults to: $include-default-uis

Available since: 1.1.1

Default size (width and height) for toolbar icons. ...

Default size (width and height) for toolbar icons.

Defaults to: 1.4em

Available since: 1.1.1

Defined By

CSS Mixins

Ext.Button
view source
( $ui-label, $color, $gradient )
Creates a theme UI for buttons. ...

Creates a theme UI for buttons. Also automatically generates UIs for {ui-label}-round and {ui-label}-small.

// SCSS
@include sencha-button-ui('secondary', #99A4AE, 'glossy');

// JS
var cancelBtn = new Ext.Button({text: 'Cancel', ui: 'secondary'});

Available since: 1.1.1

Parameters

  • $ui-label : string

    The name of the UI being created. Can not included spaces or special punctuation (used in class names)

  • $color : color

    Base color for the UI.

  • $gradient : string

    Default gradient for the UI.