Ext.viewport.Default

If true, child items will be destroyed as soon as they are removed from this container

Defaults to: true

Available since: 1.1.0

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

Available since: 1.1.0

The border width to use on this Component. 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. 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.

Available since: 2.0.0

Animation to be used during transitions of cards.

Available since: 1.1.0

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

Available since: 1.1.0

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

Available since: 1.1.0

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

Enables you to easily control Components inside this Container by listening to their events and taking some action. For example, if we had a container with a nested Disable button, and we wanted to hide the Container when the Disable button is tapped, we could do this:

Ext.create('Ext.Container', {
    control: {
       'button[text=Disable]': {
           tap: 'hideMe'
       }
    },

    hideMe: function() {
        this.hide()
    }
});

We used a Ext.ComponentQuery selector to listen to the tap event on any button anywhere inside the Container that has the text 'Disable'. Whenever a Component matching that selector fires the 'tap' event our hideMe function is called. hideMe is called with scope: this (e.g. 'this' is the Container instance).

Defaults to: {}

Available since: 2.0.0

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

Available since: 1.1.0

The default xtype of child Components to create in this Container when a child item is specified as a raw configuration object, rather than as an instantiated Component.

Available since: 1.1.0

A set of default configurations to apply to all child Components in this Container. It's often useful to specify defaults when creating more than one items with similar configurations. For example here we can specify that each child is a panel and avoid repeating the xtype declaration for each one:

Ext.create('Ext.Container', {

   defaults: {
       xtype: 'panel'
   },
   items: [
       {
           html: 'Panel 1'
       },
       {
           html: 'Panel 2'
       }
   ]

});

Available since: 1.1.0

Whether or not this component is disabled

Available since: 1.1.0

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

Available since: 1.1.0

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

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

Available since: 1.1.0

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

Animation effect to apply when the Component is being hidden.

Available since: 2.0.0

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.AbstractBox.setItemFlex method.

Available since: 2.0.0

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

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

Available since: 1.1.0

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

Available since: 1.1.0

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

Available since: 2.0.0

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

Available since: 2.0.0

When using a modal Component, setting this to true will hide the modal mask and the Container when the mask is tapped on

Available since: 1.1.0

Overrides: Ext.Component.hideOnMaskTap

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

Available since: 1.1.0

An itemId can be used as an alternative way to get a reference to a component when no object reference is available. 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 child items to add to this Container. This is usually an array of Component configurations or instances, for example:

Ext.create('Ext.Container', {

   items: [
       {
           xtype: 'panel',
           html: 'This is an item'
       }
   ]

});

Available since: 1.1.0

True to automatically relayout this component on orientation change.

Available since: 1.1.0

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

A configuration to allow you to mask this container. You can optionally pass an object block with and xtype of loadmask, and an optional message value to display a loading mask. Please refer to the Ext.LoadMask component to see other configurations.

masked: {
    xtype: 'loadmask',
    message: 'My message'
}

Alternatively, you can just call the setter at any time with true/false to show/hide the mask"

setMasked(true); //show the mask
setMasked(false); //hides the mask

There are also two convience methods, mask and unmask, to allow you to mask and unmask this container at any time.

Remember, the Ext.Viewport is always a container, so if you want to mask your whole application at anytime, can call:

Ext.Viewport.setMasked({
    xtype: 'loadmask',
    message: 'Hello'
});

Available since: 2.0.0

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

Available since: 1.1.0

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. 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.

Available since: 1.1.0

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

Available since: 1.1.0

True to make this Container modal. This will create a mask underneath the Container that covers its parent and does not allow the user to interact with any other Components until this Container is dismissed

Available since: 1.1.0

Overrides: Ext.Component.modal

True to monitor Orientation change.

Available since: 1.1.0

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. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component.

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

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

Example code

A plugin by alias:

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

Multiple plugins by alias:

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

Single plugin by class name with config options:

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

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

Multiple plugins by class name with config options:

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

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

Available since: 1.1.0

A model instance which updates the Component's html based on it's tpl. 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. 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. 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

Configuration options to make this Container scrollable. Acceptable values are:

• 'horizontal', 'vertical', 'both' to enabling scrolling for that direction.
• true/false to explicitly enable/disable scrolling.

Alternatively, you can give it an object which is then passed to the scroller instance:

scrollable: {
    direction: 'vertical',
    directionLock: true
}

Please look at the Ext.scroll.Scroller documentation for more example on how to use this.

Available since: 1.1.0

Overrides: Ext.Component.scroll

Configuration options to make this Container scrollable. Acceptable values are:

• 'horizontal', 'vertical', 'both' to enabling scrolling for that direction.
• true/false to explicitly enable/disable scrolling.

Alternatively, you can give it an object which is then passed to the scroller instance:

scrollable: {
    direction: 'vertical',
    directionLock: true
}

Please look at the Ext.scroll.Scroller documentation for more example on how to use this.

Available since: 2.0.0

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

Available since: 1.1.0

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

Available since: 1.1.0

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.

Available since: 1.1.0

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

Defaults to: false

Available since: 1.1.0

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. 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. 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. Defaults to 'overwrite' (see Ext.XTemplate.overwrite).

Defaults to: 'overwrite'

Available since: 1.1.0

Available since: 2.0.0

The ui to be used on this Component

Available since: 1.1.0

Available since: 2.0.0

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

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

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

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

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

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

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

Defaults to: 'component'

Available since: 2.0.0

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

Available since: 2.0.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: {delegate: '> component', centeredchange: 'onItemCenteredChange', dockedchange: 'onItemDockedChange', floatingchange: 'onItemFloatingChange'}

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

Defaults to: true

Available since: 2.0.0

Defaults to: true

Available since: 1.1.0

The set of all items in this Container.

Available since: 1.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. 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); / dependentOL 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: []

Available since: 2.0.0

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

Available since: 2.0.0

Adds one or more Components to this Container. Example:

var myPanel = Ext.create('Ext.Panel', {
    html: 'This will be added to a Container'
});

myContainer.add([myPanel]);

Available since: 1.1.0

Parameters

• newItems : Array

  The new items to add to the Container

Appends an after-event handler.

Same as addListener with order set to 'after'.

Available since: 2.0.0

Parameters

• eventName : String

  The name of the event to listen for.

• fn : Function

  The method the event invokes.

• scope : Object (optional)

  The scope for fn.

• options : Object (optional)

  An object containing handler configuration.

Adds an array of Components to this Container.

Available since: 2.0.0

Parameters

• items : Array

  The array of items to add to this container

Returns

• Array

  The array of items after they have been added

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

  The name of the event to listen for.

• fn : Function

  The method the event invokes.

• scope : Object (optional)

  The scope for fn.

• options : Object (optional)

  An object containing handler configuration.

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 prefix to add to each class

• suffix : String

  Optional suffix to add to each class

Available since: 2.0.0

Parameters

• selector : Object
• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

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

Available since: 1.1.0

Parameters

• eventNames : Object/String...

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

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

Combining Options

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

A delayed, one-time listener:

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

Attaching multiple handlers in 1 call

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

container.on({
    tap  : this.onTap,
    swipe: this.onSwipe,

    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

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

See the Events Guide for more.

Available since: 1.1.0

Parameters

• eventName : String

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

• fn : Function

  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

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

  • delay : Number

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

  • single : Boolean

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

  • order : String

    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

    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

    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() {
                console.log('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

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

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

• order : String (optional)

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

  Defaults to: 'current'

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

Available since: 1.1.0

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 domNode is only created the very first time it's ever used

Available since: 2.0.0

Parameters

• name : Object
• domNode : Object

Used to handle joining of a record to a tpl

Available since: 2.0.0

Used to handle joining of a record to a tpl

Available since: 2.0.0

Available since: 1.1.0

Parameters

• component : Object
• alignment : Object

Animates to the supplied activeItem with a specified animation. Currently this only works with a Card layout. This passed animation will override any default animations on the container, for a single card switch. The animation will be destroyed when complete.

Available since: 2.0.0

Parameters

• activeItem : Object/Number

  The item or item index to make active

• animation : Object/Ext.fx.layout.Card

  Card animation configuration or instance

Available since: 2.0.0

Parameters

• animation : Object
• component : Object
• newState : Object
• oldState : Object
• options : Object
• controller : Object

Available since: 2.0.0

Parameters

• activeItem : Object
• currentActiveItem : Object

Available since: 2.0.0

Parameters

• baseCls : Object

Available since: 2.0.0

Parameters

• bottom : Object

Available since: 2.0.0

Parameters

• bubbleEvents : Object

Available since: 2.0.0

Parameters

• centered : Object

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

Available since: 2.0.0

Parameters

• cls : Object

Available since: 2.0.0

Parameters

• contentEl : Object

Available since: 2.0.0

Parameters

• selectors : Object

Available since: 2.0.0

Parameters

• data : Object

Available since: 1.1.0

Parameters

• defaults : Object

Available since: 2.0.0

Parameters

• disabled : Object

Available since: 2.0.0

Parameters

• docked : Object

Available since: 2.0.0

Parameters

• config : Object

Available since: 2.0.0

Parameters

• hidden : Object

Available since: 2.0.0

Parameters

• itemId : Object

Available since: 2.0.0

Parameters

• items : Object
• collection : Object

Available since: 2.0.0

Parameters

• left : Object

Available since: 2.0.0

Parameters

• listeners : Object

Changes the masked configuration when its setter is called, which will convert the value into a proper object/instance of Ext.Mask/Ext.LoadMask. If a mask already exists, it will use that instead.

Available since: 2.0.0

Parameters

• masked : Object
• currentMask : Object

Available since: 2.0.0

Parameters

• modal : Object
• currentMask : Object

Available since: 2.0.0

Parameters

• config : Object

Available since: 2.0.0

Parameters

• config : Object

Available since: 2.0.0

Parameters

• right : Object

Available since: 2.0.0

Parameters

• config : Object

Available since: 2.0.0

Parameters

• config : Object

Available since: 2.0.0

Parameters

• top : Object

Available since: 2.0.0

Parameters

• config : Object

Available since: 2.0.0

Parameters

• config : Object

Available since: 2.0.0

Parameters

• zIndex : Object

Available since: 2.0.0

Parameters

• config : Object

Available since: 2.0.0

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

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

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

Available since: 2.0.0

Parameters

• operation : Object
• eventName : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Retrieves the first direct child of this container which matches the passed selector. The passed in selector must comply with an Ext.ComponentQuery selector.

Available since: 1.1.0

Parameters

• selector : String

  An Ext.ComponentQuery selector

Returns

• Object

  Ext.Component

Removes all listeners for this object.

Available since: 1.1.0

Available since: 1.1.0

Parameters

• object : Object

Available since: 2.0.0

Parameters

• name : Object

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

Available since: 2.0.0

Parameters

• newName : Object

Returns

• Function

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

Available since: 2.0.0

Disables this Component

Available since: 1.1.0

Available since: 2.0.0

Parameters

• item : Object

Available since: 2.0.0

Parameters

• eventName : Object
• args : Object
• action : Object
• connectedController : Object

Available since: 2.0.0

Parameters

• index : Object
• item : Object

Available since: 2.0.0

Parameters

• item : Object
• index : Object

Available since: 2.0.0

Parameters

• item : Object
• toIndex : Object
• fromIndex : Object

Available since: 2.0.0

Parameters

• item : Object
• index : Object

Available since: 1.1.0

Parameters

• item : Object
• index : Object
• destroy : Object

Available since: 2.0.0

Parameters

• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Overrides: Ext.mixin.Observable.doRemoveListener

Available since: 2.0.0

Parameters

• innerIndex : Object

Available since: 2.0.0

Parameters

• me : Object
• value : Object
• oldValue : Object
• options : Object

Available since: 2.0.0

Parameters

• newActiveItem : Object
• oldActiveItem : Object

Available since: 2.0.0

Parameters

• bottom : Object

Available since: 2.0.0

Available since: 2.0.0

Parameters

• disabled : Object

Available since: 2.0.0

Available since: 2.0.0

Parameters

• hidden : Object

Available since: 2.0.0

Parameters

• left : Object

Available since: 2.0.0

Parameters

• height : Object

Available since: 2.0.0

Parameters

• width : Object

Available since: 2.0.0

Parameters

• height : Object

Available since: 2.0.0

Parameters

• width : Object

Available since: 2.0.0

Parameters

• right : Object

Available since: Touch 2.0.2

Available since: 2.0.0

Parameters

• top : Object

Retrieves the first descendant of this container which matches the passed selector. The passed in selector must comply with an Ext.ComponentQuery selector.

Available since: 1.1.0

Parameters

• selector : String

  An Ext.ComponentQuery selector

Returns

• Object

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

Parameters

• item : Object

Available since: 2.0.0

Parameters

• item : Object

Available since: 2.0.0

Parameters

• value : Object

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

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

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

Example

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

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

And then we can fire off the event.

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

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

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to fire.

• args : Object...

  Variable number of parameters are passed to handlers.

Returns

• Boolean

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

Returns the value of activeItem.

Available since: 1.1.0

Returns

• Object/Number

Available since: 2.0.0

Available since: 2.0.0

Returns the Component for a given index in the Container's items

Available since: 2.0.0

Parameters

• index : Number

  The index of the Component to return

Returns

• Ext.Component

  The item at the specified index, if found

Returns the value of autoDestroy.

Available since: 2.0.0

Returns

• Boolean

Returns the value of baseCls.

Available since: 2.0.0

Returns

• String

Returns the value of border.

Available since: 2.0.0

Returns

• Number/String

Returns the value of bottom.

Available since: 2.0.0

Returns

• Number/String

Returns the value of bubbleEvents.

Available since: 2.0.0

Returns

• String/String[]

Available since: 1.1.0

Overrides: Ext.mixin.Observable.getBubbleTarget

Returns the value of centered.

Available since: 2.0.0

Returns

• Boolean

Returns the value of cls.

Available since: 2.0.0

Returns

• String/String[]

Examines this container's items property and gets a direct child component of this container.

Available since: 1.1.0

Parameters

• component : String/Number

  This parameter may be any of the following:

  • a String : representing the itemId or id of the child component
  • a Number : representing the position of the child component within the items property

  For additional information see Ext.util.MixedCollection.get.

Returns

• Object

  Ext.Component The component (if found).

Available since: 2.0.0

Parameters

• name : Object

Returns the value of contentEl.

Available since: 2.0.0

Returns

• Ext.Element/HTMLElement/String

Returns the value of control.

Available since: 2.0.0

Returns

• Object

Available since: 2.0.0

Returns the value of data.

Available since: 2.0.0

Returns

• Mixed

Returns the value of defaultType.

Available since: 2.0.0

Returns

• String

Returns the value of defaults.

Available since: 2.0.0

Returns

• Object

Returns the value of disabled.

Available since: 2.0.0

Returns

• Boolean

Returns the value of disabledCls.

Available since: 2.0.0

Returns

• String

Returns the value of docked.

Available since: 2.0.0

Returns

• String

Finds a docked item of this container using a reference, id or an index of its location in getDockedItems.

Available since: 2.0.0

Parameters

• component : String/Number

  The id or index of the component to find

Returns

• Ext.Component/Boolean

  The docked component, if found

Returns all the Ext.Component.docked items in this container.

Available since: 2.0.0

Returns

• Array

  The docked items of this container

Available since: 2.0.0

Available since: 2.0.0

Retrieves the top level element representing this component.

 var element = component.element;

Available since: 1.1.0

Returns

• Ext.dom.Element

Available since: 2.0.0

Overrides: Ext.Component.getElementConfig

Returns the value of enterAnimation.

Available since: 2.0.0

Returns

• String/Mixed

Available since: 2.0.0

Returns the value of exitAnimation.

Available since: 2.0.0

Returns

• String/Mixed

Returns the value of floatingCls.

Available since: 2.0.0

Returns

• String

Returns the value of hidden.

Available since: 2.0.0

Returns

• Boolean

Returns the value of hiddenCls.

Available since: 2.0.0

Returns

• String

Returns the value of hideAnimation.

Available since: 2.0.0

Returns

• String/Mixed

Returns the value of hideOnMaskTap.

Available since: 2.0.0

Returns

• Boolean

Returns the value of html.

Available since: 2.0.0

Returns

• String/Ext.Element/HTMLElement

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

Available since: 2.0.0

Returns

• String

  id

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

• Object/Mixed

Available since: 2.0.0

Returns all inner items of this container. inner means that the item is not docked or floating.

Available since: 2.0.0

Returns

• Array

  The inner items of this container.

Returns the value of itemId.

Available since: 1.1.0

Returns

• String

Returns the value of items.

Available since: 2.0.0

Returns

• Array/Object

Returns the value of left.

Available since: 2.0.0

Returns

• Number/String

Returns the value of listeners.

Available since: 2.0.0

Returns

• Object

Available since: 2.0.0

Parameters

• object : Object
• eventName : Object

Returns the value of margin.

Available since: 2.0.0

Returns

• Number/String

Returns the value of masked.

Available since: 2.0.0

Returns

• Boolean/Object/Ext.Mask/Ext.LoadMask

Returns the value of maxHeight.

Available since: 2.0.0

Returns

• Number/String

Returns the value of maxWidth.

Available since: 2.0.0

Returns

• Number/String

Returns the value of minHeight.

Available since: 2.0.0

Returns

• Number/String

Returns the value of minWidth.

Available since: 2.0.0

Returns

• Number/String

Returns the value of modal.

Available since: 2.0.0

Returns

• Boolean

Available since: 2.0.0

Available since: 2.0.0

Available since: 2.0.0

Available since: 2.0.0

Returns the value of padding.

Available since: 2.0.0

Returns

• Number/String

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

Available since: 2.0.0

Returns

• Ext.Component

  The parent of this component.

Returns the value of plugins.

Available since: 2.0.0

Returns

• Object/Array

Returns the value of record.

Available since: 2.0.0

Returns

• Ext.data.Model

Used by ComponentQuery to retrieve all of the items which can potentially be considered a child of this Container. This should be overriden by components which have child items that are not contained in items. For example dockedItems, menu, etc

Available since: 1.1.0

Parameters

• deep : Object

Returns the value of renderTo.

Available since: 2.0.0

Returns

• Ext.Element

Returns the value of right.

Available since: 2.0.0

Returns

• Number/String

Returns an the scrollable instance for this container, which is a Ext.scroll.View class.

Please checkout the documentation for Ext.scroll.View, Ext.scroll.View.getScroller and Ext.scroll.Scroller for more information.

Available since: 2.0.0

Returns

• Ext.scroll.View

  The scroll view

Available since: 2.0.0

Returns the value of showAnimation.

Available since: 2.0.0

Returns

• String/Mixed

Returns the value of style.

Available since: 2.0.0

Returns

• String/Object

Returns the value of styleHtmlCls.

Available since: 2.0.0

Returns

• String

Returns the value of styleHtmlContent.

Available since: 2.0.0

Returns

• Boolean

Available since: 2.0.0

Returns the value of top.

Available since: 2.0.0

Returns

• Number/String

Returns the value of tpl.

Available since: 2.0.0

Returns

• String/String[]/Ext.Template[]/Ext.XTemplate[]

Returns the value of tplWriteMode.

Available since: 2.0.0

Returns

• String

Available since: 2.0.0

Available since: 2.0.0

Returns the value of ui.

Available since: 2.0.0

Returns

• String

Available since: 2.0.0

Returns the value of useBodyElement.

Available since: 2.0.0

Returns

• Object

Available since: 2.0.0

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

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

Example usage:

var t = new Ext.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.

Available since: 2.0.0

Returns

• Number

Available since: 2.0.0

Parameters

• item : Object

Available since: 2.0.0

Parameters

• name : Object

Available since: 2.0.0

Parameters

• item : Object

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.

Available since: 2.0.0

Returns

• Boolean

  true if this component has a parent.

Hides this Component

Available since: 1.1.0

Parameters

• animation : Object/Boolean (optional)

Returns

• Ext.Component

  this

Available since: 2.0.0

Parameters

• item : Object

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

• instanceConfig : Object

Returns

• Object

  mixins The mixin prototypes as key - value pairs

Available since: 2.0.0

Returns

• Ext.AbstractComponent

  this

Allows addition of behavior to the rendering phase.

Available since: 2.0.0

Overrides: Ext.Evented.initialize

Adds a child Component at the given index. For example, here's how we can add a new item, making it the first child Component of this Container:

myContainer.insert(0, {xtype: 'panel', html: 'new item'});

Available since: 1.1.0

Parameters

• index : Number

  The index to insert the Component at

• item : Object

  The Component to insert

Available since: 2.0.0

Parameters

• item : Object
• relativeToItem : Object

Returns

• Ext.Container

  this

Available since: 2.0.0

Parameters

• item : Object
• relativeToItem : Object

Returns

• Ext.Container

  this

Available since: 2.0.0

Parameters

• item : Object

Available since: 2.0.0

Parameters

• item : Object
• index : Object

Returns

• Ext.Container

  this

Available since: 2.0.0

Parameters

• item : Object

Available since: 2.0.0

Returns true if this Component is currently disabled

Available since: 1.1.0

Returns

• Boolean

  True if currently disabled