Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

Ext JS 5.0.1


top

Ext.panel.Header xtype: header

No members found using the current filters

configs

Optional Configs

activeCounter : Number
bindable bind private pri

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

Defaults to:

0

getActiveCounter : Number

Returns the value of activeCounter

Returns

Number

setActiveCounter (activeCounter)

Sets the value of activeCounter

Parameters

activeCounter :  Number

activeItem : String / Number
bindable bind

A string component id or the numeric index of the component that should be initially activated within the container's layout on render. For example, activeItem: 'item-1' or activeItem: 0 (index 0 = the first item in the container's collection). activeItem only applies to layout styles that can display items one at a time (like Ext.layout.container.Card and Ext.layout.container.Fit).

Available since: 2.3.0

setActiveItem ( item ) : Ext.Component

Sets a component as the active layout item. This only applies when using a Ext.layout.container.Card layout.

var card1 = Ext.create('Ext.panel.Panel', {itemId: 'card-1'});
var card2 = Ext.create('Ext.panel.Panel', {itemId: 'card-2'});
var panel = Ext.create('Ext.panel.Panel', {
    layout: 'card',
    items: [card1, card2]
});
// These are all equivalent
panel.getLayout().setActiveItem(card2);
panel.getLayout().setActiveItem('card-2');
panel.getLayout().setActiveItem(1);

Parameters

item :  Ext.Component/Number/String

The component, component id, itemId, or index of component.

Returns

:Ext.Component

the activated component or false when nothing activated. False is returned also when trying to activate an already active item.

alignTarget : String

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

Only applicable if this component is floating

Used upon first show.

Defaults to:

null

alwaysOnTop : Boolean / Number
bindable bind

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

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

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

Defaults to:

false

getAlwaysOnTop : Boolean / Number

Returns the value of alwaysOnTop

Returns

Boolean / Number

setAlwaysOnTop (alwaysOnTop)

Sets the value of alwaysOnTop

Parameters

alwaysOnTop :  Boolean / Number

anchorSize : Number / Object

Defines the anchoring size of container. Either a number to define the width of the container or an object with width and height fields.

autoDestroy : Boolean

If true the container will automatically destroy any contained component that is removed from it, else destruction must be handled manually.

Defaults to:

true

Available since: 2.3.0

autoEl : String / Object

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

You do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container, this defaults to 'div'. The more complex Sencha classes use a more complex DOM structure specified by their own renderTpls.

This is intended to allow the developer to create application-specific utility Components encapsulated by different DOM elements. Example usage:

{
    xtype: 'component',
    autoEl: {
        tag: 'img',
        src: 'http://www.example.com/example.jpg'
    }
}, {
    xtype: 'component',
    autoEl: {
        tag: 'blockquote',
        html: 'autoEl is cool!'
    }
}, {
    xtype: 'container',
    autoEl: 'ul',
    cls: 'ux-unordered-list',
    items: {
        xtype: 'component',
        autoEl: 'li',
        html: 'First list item'
    }
}

Available since: 2.3.0

autoRender : Boolean / String / HTMLElement / Ext.dom.Element

This config is intended mainly for non-cfg-floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a Component to render itself upon first show. If cfg-floating is true, the value of this config is omitted as if it is true.

Specify as true to have this Component render to the document body upon first show.

Specify as an element, or the ID of an element to have this Component render to a specific element upon first show.

Defaults to:

false

autoScroll : Boolean
bindable bind

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false to clip any overflowing content. This should not be combined with overflowX or overflowY.

Defaults to:

false

setAutoScroll ( scroll ) : Ext.Component
chainable ch

Sets the overflow on the content element of the component.

Parameters

scroll :  Boolean

True to allow the Component to auto scroll.

Returns

:Ext.Component

this

autoShow : Boolean

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

Defaults to:

false

Available since: 2.3.0

baseCls : String

The base CSS class to apply to this component's element. This will also be prepended to elements within this component like Panel's body will get a class x-panel-body. This means that if you create a subclass of Panel, and you want it to get all the Panels styling for the element and the body, you leave the baseCls x-panel and use componentCls to add specific styling for this component.

Defaults to:

'x-component'

bind : Object / String
bindable bind

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

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

To dynamically add bindings:

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

To remove bindings:

 panel.setBind({
     title: null
 });

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

Note: If bind is passed as a string, it will use the Ext.Component#property-defaultBindProperty for the binding

Defaults to:

null

getBind : Object / String

Returns the value of bind

Returns

Object / String

setBind (bind)

Sets the value of bind

Parameters

bind :  Object / String

border : Number / String / Boolean
bindable bind

Specifies the border size for this component. The border can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

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

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

To turn off the border, use border: false.

setBorder ( border )

Parameters

border :  String/Number

The border, see border. If a falsey value is passed the border will be removed.

bubbleEvents : String[]

An array of events that, when fired, should be bubbled to any parent container. See Ext.util.Observable#enableBubble.

Available since: 3.4.0

childEls : Object / String[] / Object[]
bindable bind

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

  • itemId - The id to combine with the Component's id that is the id of the child element.
  • id - The id of the child element.
  • leaf - Set to true to ignore content when scanning for childEls. This should be set on things like the generated content for an Ext.view.View.
  • select: A selector that will be passed to Ext.dom.Element#select.
  • selectNode: A selector that will be passed to Ext.dom.Element#method-selectNode.

For example:

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

The above is translated into the following complete form:

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

The above can be provided as an array like so:

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

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

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

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

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

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

Defaults to:

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

getChildEls : Object / String[] / Object[]

Returns the value of childEls

Returns

Object / String[] / Object[]

setChildEls (childEls)

Sets the value of childEls

Parameters

childEls :  Object / String[] / Object[]

cls : String

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

Defaults to:

''

Available since: 1.1.0

columnWidth : Number / String

Defines the column width inside Ext.layout.container.Column.

Can be specified as a number or as a percentage.

Defaults to:

undefined

componentCls : String

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

componentLayout : String / Object

The sizing and positioning of a Component's internal Elements is the responsibility of the Component's layout manager which sizes a Component's internal structure in response to the Component being sized.

Generally, developers will not use this configuration as all provided Components which need their internal elements sizing (Such as Ext.form.field.Base) come with their own componentLayout managers.

The Ext.layout.container.Auto will be used on instances of the base Ext.Component class which simply sizes the Component's encapsulating element to the height and width specified in the setSize method.

Defaults to:

'autocomponent'

constrain : Boolean

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

Defaults to:

false

constraintInsets : Object / String

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

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

constrainTo : Ext.util.Region / Ext.dom.Element

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

contentEl : String

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

This config option is used to take an existing HTML element and place it in the layout element of a new component (it simply moves the specified DOM element after the Component is rendered to use as the content.

Notes:

The specified HTML element is appended to the layout element of the component after any configured HTML has been inserted, and so the document will not contain this element at the time the event-render event is fired.

The specified HTML element used will not participate in any layout scheme that the Component may use. It is just HTML. Layouts operate on child items.

Add either the x-hidden or the x-hidden-display CSS class to prevent a brief flicker of the content before it is rendered to the panel.

Available since: 3.4.0

controller : String / Object / Ext.app.ViewController
bindable bind

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

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

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

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

Defaults to:

null

getController : String / Object / Ext.app.ViewController

Returns the value of controller

Returns

String / Object / Ext.app.ViewController

setController (controller)

Sets the value of controller

Parameters

controller :  String / Object / Ext.app.ViewController

data : Object
bindable bind

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

Defaults to:

null

Available since: 3.4.0

getData : Object

Returns the value of data

Returns

Object

setData (data)

Sets the value of data

Parameters

data :  Object

defaultAlign : String

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

Only applicable if this component is floating

Used upon first show.

Defaults to:

"c-c"

defaultListenerScope : Boolean
bindable bind

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

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

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

Defaults to:

false

getDefaultListenerScope : Boolean

Returns the value of defaultListenerScope

Returns

Boolean

setDefaultListenerScope (defaultListenerScope)

Sets the value of defaultListenerScope

Parameters

defaultListenerScope :  Boolean

defaults : Object / Function

This option is a means of applying default settings to all added items whether added through the cfg-items config or via the method-add or insert methods.

Defaults are applied to both config objects and instantiated components conditionally so as not to override existing properties in the item (see Ext#applyIf).

If the defaults option is specified as a function, then the function will be called using this Container as the scope (this reference) and passing the added item as the first parameter. Any resulting object from that call is then applied to the item as default properties.

For example, to automatically apply padding to the body of each of a set of contained Ext.panel.Panel items, you could pass: defaults: {bodyStyle:'padding:15px'}.

Usage:

defaults: { // defaults are applied to items, not the container
    autoScroll: true
},
items: [
    // default will not be applied here, panel1 will be autoScroll: false
    {
        xtype: 'panel',
        id: 'panel1',
        autoScroll: false
    },
    // this component will have autoScroll: true
    new Ext.panel.Panel({
        id: 'panel2'
    })
]

Available since: 2.3.0

defaultType : String

The default Ext.Component 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.

Defaults to:

"panel"

Available since: 2.3.0

detachOnRemove : Boolean

True to move any component to the detachedBody when the component is removed from this container. This option is only applicable when the component is not destroyed while being removed, see autoDestroy and method-remove. If this option is set to false, the DOM of the component will remain in the current place until it is explicitly moved.

Defaults to:

true

disabled : Boolean
bindable bind

true to disable the component.

Defaults to:

false

Available since: 2.3.0

setDisabled ( disabled )
chainable ch

Enable or disable the component.

Parameters

disabled :  Boolean

true to disable.

disabledCls : String

CSS class to add when the Component is disabled.

Defaults to:

'x-item-disabled'

draggable : Boolean / Object

Specify as true to make a floating Component draggable using the Component's encapsulating element as the drag handle.

This may also be specified as a config object for the Ext.util.ComponentDragger which is instantiated to perform dragging.

For example to create a Component which may only be dragged around using a certain internal element as the drag handle, use the delegate option:

new Ext.Component({
    constrain: true,
    floating: true,
    style: {
        backgroundColor: '#fff',
        border: '1px solid black'
    },
    html: '<h1 style="cursor:move">The title</h1><p>The content</p>',
    draggable: {
        delegate: 'h1'
    }
}).show();

Defaults to:

false

fixed : Boolean

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

Defaults to:

false

floating : Boolean

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

Components such as Ext.window.Windows and Ext.menu.Menus are floating by default.

Floating Components that are programatically rendered will register themselves with the global Ext.WindowManager

Floating Components as child items of a Container

A floating Component may be used as a child item of a Container. This just allows the floating Component to seek a ZIndexManager by examining the ownerCt chain.

When configured as floating, Components acquire, at render time, a Ext.ZIndexManager which manages a stack of related floating Components. The ZIndexManager sorts its stack according to an incrementing access counter and the alwaysOnTop config when the Component's toFront method is called.

The ZIndexManager is found by traversing up the ownerCt chain to find an ancestor which itself is floating. This is so that descendant floating Components of floating Containers (Such as a ComboBox dropdown within a Window) can have its zIndex managed relative to any siblings, but always above that floating ancestor Container.

If no floating ancestor is found, a floating Component registers itself with the default Ext.WindowManager.

Floating components do not participate in the Container's layout. Because of this, they are not rendered until you explicitly method-show them.

After rendering, the ownerCt reference is deleted, and the floatParent property is set to the found floating ancestor Container. If no floating ancestor Container was found the floatParent property will not be set.

Defaults to:

false

focusCls : String

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

Defaults to:

'x-focus'

focusOnToFront : Boolean

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

Defaults to:

true

formBind : Boolean

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

Defaults to:

false

frame : Boolean

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

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

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

glyph : Number / String
bindable bind

A numeric unicode character code to use as the icon for the panel header. The default font-family for glyphs can be set globally using Ext.setGlyphFontFamily(). Alternatively, this config option accepts a string with the charCode and font-family separated by the @ symbol. For example '65@My Font Family'.

Defaults to:

null

getGlyph : Number / String

Returns the value of glyph

Returns

Number / String

setGlyph (glyph)

Sets the value of glyph

Parameters

glyph :  Number / String

height : Number / String
bindable bind

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

getHeight Number

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

Returns

:Number

setHeight ( height ) : Ext.Component

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

Parameters

height :  Number

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

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

Returns

:Ext.Component

this

hidden : Boolean
bindable bind

true to hide the component.

Defaults to:

false

Available since: 2.3.0

setHidden ( hidden ) : Ext.Component

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

Parameters

hidden :  Boolean

Returns

:Ext.Component

hideMode : String

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

  • 'display' : The Component will be hidden using the display: none style.
  • 'visibility' : The Component will be hidden using the visibility: hidden style.
  • 'offsets' : The Component will be hidden by absolutely positioning it out of the visible area of the document. This is useful when a hidden Component must maintain measurable dimensions. Hiding using display results in a Component having zero dimensions.

Defaults to:

'display'

Available since: 1.1.0

html : String / Object

An HTML fragment, or a Ext.dom.Helper specification to use as the layout element content. The HTML content is added after the component is rendered, so the document will not contain this HTML at the time the event-render event is fired. This content is inserted into the body before any configured contentEl is appended.

Defaults to:

''

Available since: 3.4.0

icon : String
bindable bind

Path to image for an icon.

There are no default icons that come with Ext JS.

Defaults to:

null

getIcon : String

Returns the value of icon

Returns

String

setIcon (icon)

Sets the value of icon

Parameters

icon :  String

iconAlign : 'top' / 'right' / 'bottom' / 'left'
bindable bind

The side of the title to render the icon.

Defaults to:

'left'

getIconAlign : 'top' / 'right' / 'bottom' / 'left'

Returns the value of iconAlign

Returns

'top' / 'right' / 'bottom' / 'left'

setIconAlign (iconAlign)

Sets the value of iconAlign

Parameters

iconAlign :  'top' / 'right' / 'bottom' / 'left'

iconCls : String
bindable bind

CSS class for an icon.

There are no default icon classes that come with Ext JS.

Defaults to:

null

getIconCls : String

Returns the value of iconCls

Returns

String

setIconCls (iconCls)

Sets the value of iconCls

Parameters

iconCls :  String

id : String

The unique id of this component instance.

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

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

Alternatively, itemId and Ext.ComponentQuery can be used to perform selector-based searching for Components analogous to DOM querying. The Ext.container.Container class contains several helpful shortcut methods to query its descendant Components by selector.

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

Defaults to an auto-assigned id.

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

Available since: 1.1.0

getId String

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

Returns

:String

itemId : String

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

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

var c = new Ext.panel.Panel({ //
    height: 300,
    renderTo: document.body,
    layout: 'auto',
    items: [
        {
            itemId: 'p1',
            title: 'Panel 1',
            height: 150
        },
        {
            itemId: 'p2',
            title: 'Panel 2',
            height: 150
        }
    ]
})
p1 = c.getComponent('p1'); // not the same as Ext.getCmp()
p2 = p1.ownerCt.getComponent('p2'); // reference via a sibling

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

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

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

Available since: 3.4.0

getItemId String

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

Returns

:String

items : Object / Object[]

A single item, or an array of child Components to be added to this container

Unless configured with a layout, a Container simply renders child Components serially into its encapsulating element and performs no sizing or positioning upon them.

Example:

// specifying a single item
items: {...},
layout: 'fit',    // The single items is sized to fit

// specifying multiple items
items: [{...}, {...}],
layout: 'hbox', // The items are arranged horizontally

Each item may be:

If a configuration object is specified, the actual type of Component to be instantiated my be indicated by using the xtype option.

Every Component class has its own xtype.

If an xtype is not explicitly specified, the defaultType for the Container is used, which by default is usually panel.

Notes:

Ext uses lazy rendering. Child Components will only be rendered should it become necessary. Items are automatically laid out when they are first shown (no sizing is done while hidden), or in response to a doLayout call.

Do not specify contentEl or html with items.

Defaults to:

undefined

Available since: 2.3.0

layout : Ext.enums.Layout / Object
bindable bind

Important: In order for child items to be correctly sized and positioned, typically a layout manager must be specified through the layout configuration option.

The sizing and positioning of child cfg-items is the responsibility of the Container's layout manager which creates and manages the type of layout you have in mind. For example:

If the layout configuration is not explicitly specified for a general purpose container (e.g. Container or Panel) the Ext.layout.container.Auto will be used which does nothing but render child components sequentially into the Container (no sizing or positioning will be performed in this situation).

layout may be specified as either as an Object or as a String:

Specify as an Object

Example usage:

layout: {
    type: 'vbox',
    align: 'left'
}
  • type

    The layout type to be used for this container. If not specified, a default Ext.layout.container.Auto will be created and used.

    Valid layout type values are listed in Ext.enums.Layout.

  • Layout specific configuration properties

    Additional layout specific configuration properties may also be specified. For complete details regarding the valid config options for each layout type, see the layout class corresponding to the type specified.

Specify as a String

Example usage:

layout: 'vbox'
  • layout

    The layout type to be used for this container (see Ext.enums.Layout for list of valid values).

    Additional layout specific configuration properties. For complete details regarding the valid config options for each layout type, see the layout class corresponding to the layout specified.

Configuring the default layout type

If a certain Container class has a default layout (For example a Ext.toolbar.Toolbar with a default Box layout), then to simply configure the default layout, use an object, but without the type property:

xtype: 'toolbar',
layout: {
    pack: 'center'
}

Defaults to:

'auto'

Available since: 2.3.0

getLayout Ext.layout.container.Container

Returns the Ext.layout.container.Container instance currently associated with this Container. If a layout has not been instantiated yet, that is done first

Returns

:Ext.layout.container.Container

The layout

setLayout ( configuration )

Reconfigures the initially configured layout.

NOTE: this method cannot be used to change the "type" of layout after the component has been rendered to the DOM. After rendering, this method can only modify the existing layout's configuration properties. The reason for this restriction is that many container layouts insert special wrapping elements into the dom, and the framework does not currently support dynamically changing these elements once rendered.

Parameters

configuration :  Object

object for the layout

listeners : Object

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

DOM events from Ext JS Ext.Component

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the Ext.view.View's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

loader : Ext.ComponentLoader / Object

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

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

getLoader Ext.ComponentLoader

Gets the Ext.ComponentLoader for this Component.

Returns

:Ext.ComponentLoader

The loader instance, null if it doesn't exist.

margin : Number / String
bindable bind

Specifies the margin for this component. The margin can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

setMargin ( margin )

Sets the margin on the target element.

Parameters

margin :  Number/String

The margin to set. See the margin config.

maskElement : String

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

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

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

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

Defaults to:

null

maxHeight : Number
bindable bind

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

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

Defaults to:

null

getMaxHeight : Number

Returns the value of maxHeight

Returns

Number

setMaxHeight (maxHeight)

Sets the value of maxHeight

Parameters

maxHeight :  Number

maxWidth : Number
bindable bind

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

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

Defaults to:

null

getMaxWidth : Number

Returns the value of maxWidth

Returns

Number

setMaxWidth (maxWidth)

Sets the value of maxWidth

Parameters

maxWidth :  Number

minHeight : Number
bindable bind

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

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

Defaults to:

null

getMinHeight : Number

Returns the value of minHeight

Returns

Number

setMinHeight (minHeight)

Sets the value of minHeight

Parameters

minHeight :  Number

minWidth : Number
bindable bind

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

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

Defaults to:

null

getMinWidth : Number

Returns the value of minWidth

Returns

Number

setMinWidth (minWidth)

Sets the value of minWidth

Parameters

minWidth :  Number

modelValidation : Boolean

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

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

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

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

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

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

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

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

overCls : String

An optional extra CSS class that will be added to this component's Element when the mouse moves over the Element, and removed when the mouse moves out. This can be useful for adding customized 'active' or 'hover' styles to the component or any of its children using standard CSS rules.

Defaults to:

''

Available since: 2.3.0

overflowX : String

Possible values are:

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

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

overflowY : String

Possible values are:

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

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

padding : Number / String

Specifies the padding for this component. The padding can be a single numeric value to apply to all sides or it can be a CSS style specification for each style, for example: '10 5 3 10' (top, right, bottom, left).

plugins : Ext.plugin.Abstract[] / Ext.plugin.Abstract / Object[] / Object / Ext.enums.Plugin[] / Ext.enums.Plugin

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

Plugins provide custom functionality for a component. The only requirement for a valid plugin is that it contain an init method that accepts a reference of type Ext.Component. When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

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

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

By using config object with ptype:

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

Or with just a ptype:

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

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

Available since: 2.3.0

getPlugins
private pri

Returns an array of current fully constructed plugin instances.

publishes : String / String[] / Object
bindable bind

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

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

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

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

Classes must provide this config as an Object:

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

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

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

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

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

Defaults to:

null

Available since: 5.0.0

getPublishes : String / String[] / Object

Returns the value of publishes

Returns

String / String[] / Object

setPublishes (publishes)

Sets the value of publishes

Parameters

publishes :  String / String[] / Object

reference : String
bindable bind

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

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

Defaults to:

null

getReference : String

Returns the value of reference

Returns

String

setReference (reference)

Sets the value of reference

Parameters

reference :  String

referenceHolder : Boolean

If true, this container will be marked as being a point in the hierarchy where references to items with a specified reference config will be held. The container will automatically become a referenceHolder if a controller is specified.

See the introductory docs for Ext.container.Container for more information about references & reference holders.

region : "north" / "south" / "east" / "west" / "center"

Defines the region inside Ext.layout.container.Border.

Possible values:

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

Defaults to:

undefined

getRegion Ext.util.Region

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

Returns

:Ext.util.Region

A Region containing "top, left, bottom, right" properties.

renderData : Object

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

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

See renderSelectors and cfg-childEls for usage examples.

renderSelectors : Object
deprecated dep

An object containing properties specifying CSS selectors which identify child elements created by the render process.

After the Component's internal structure is rendered according to the renderTpl, this object is iterated through, and the found Elements are added as properties to the Component using the renderSelector property name.

For example, a Component which renders a title and description into its element:

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

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

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

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

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

Deprecated since version 5.0
Use cfg-childEls instead.

renderTo : String / HTMLElement / Ext.dom.Element

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

Notes:

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

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

See also: method-render.

Available since: 2.3.0

renderTpl : Ext.XTemplate / String / String[]
protected pro

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

You do not normally need to specify this. For the base classes Ext.Component and Ext.container.Container, this defaults to null which means that they will be initially rendered with no internal structure; they render their Element empty. The more specialized Ext JS and Sencha Touch classes which use a more complex DOM structure, provide their own template definitions.

This is intended to allow the developer to create application-specific utility Components with customized internal structure.

Upon rendering, any created child elements may be automatically imported into object properties using the renderSelectors and cfg-childEls options.

Defaults to:

[
    '<tpl if="renderScroller">',
    '<div class="{scrollerCls}" style="{%this.renderPadding(out, values)%}">',
    '</tpl>',
    '{%this.renderContent(out,values)%}',
    '<tpl if="renderScroller"></div></tpl>'
]

resizable : Boolean / Object

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

May also be specified as a config object to be passed to the constructor of Ext.resizer.Resizer to override any defaults. By default the Component passes its minimum and maximum size, and uses Ext.resizer.Resizer#dynamic: false

resizeHandles : String

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

Defaults to:

'all'

saveDelay : Number

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

Defaults to:

100

session : Boolean / Object / Ext.data.Session
bindable bind

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

To create a new session you can specify true:

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

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

Alternatively, a config object can be provided:

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

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

Defaults to:

null

getSession : Boolean / Object / Ext.data.Session

Returns the value of session

Returns

Boolean / Object / Ext.data.Session

setSession (session)

Sets the value of session

Parameters

session :  Boolean / Object / Ext.data.Session

shadow : String / Boolean

Specifies whether the floating component should be given a shadow. Set to true to automatically create an Ext.Shadow, or a string indicating the shadow's display Ext.Shadow#mode. Set to false to disable the shadow.

Defaults to:

'sides'

shadowOffset : Number

Number of pixels to offset the shadow.

shrinkWrap : Boolean / Number

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

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

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

Defaults to:

2

stateEvents : String[]

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

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

stateful : Boolean

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

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

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

To set the state provider for the current page:

Ext.state.Manager.setProvider(new Ext.state.CookieProvider({ expires: new Date(new Date().getTime()+(10006060247)), //7 days from now }));

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

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

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

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

The Grid class saves its column state and store state (sorters and filters and grouper) in addition to its superclass state.

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

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

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

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

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

Defaults to:

false

stateId : String

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

See stateful for an explanation of saving and restoring state.

getStateId String
private pri

Gets the state id for this object.

Returns

:String

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

style : String / Object
bindable bind

A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.dom.Element#applyStyles.

new Ext.panel.Panel({
    title: 'Some Title',
    renderTo: Ext.getBody(),
    width: 400, height: 300,
    layout: 'form',
    items: [{
        xtype: 'textarea',
        style: {
            width: '95%',
            marginBottom: '10px'
        }
    },
    new Ext.button.Button({
        text: 'Send',
        minWidth: '100',
        style: {
            marginBottom: '10px'
        }
    })
    ]
});

Available since: 1.1.0

setStyle ( property, [value] ) : Ext.Component
chainable ch

Sets the style for this Component's primary element.

Parameters

property :  String/Object

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

value :  String (optional)

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

Returns

:Ext.Component

this

suspendLayout : Boolean

If true, suspend calls to doLayout. Useful when batching multiple adds to a container and not passing them as multiple arguments or an array.

Defaults to:

false

tabIndex : Number
bindable bind

DOM tabIndex attribute for this Focusable

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

setTabIndex ( newTabIndex )

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

Parameters

newTabIndex :  Number

new tabIndex to set

title : String / Ext.panel.Title
bindable bind

The title text or config object for the Ext.panel.Title component.

Defaults to:

{
    $value: {
        ariaRole: 'presentation',
        xtype: 'title',
        flex: 1
    },
    merge: function(newValue, oldValue) {
        if (typeof newValue == 'string') {
            newValue = {
                text: newValue
            };
        }
        return Ext.merge(oldValue ? Ext.Object.chain(oldValue) : {}, newValue);
    }
}

getTitle : String / Ext.panel.Title

Returns the value of title

Returns

String / Ext.panel.Title

setTitle (title)

Sets the value of title

Parameters

title :  String / Ext.panel.Title

titleAlign : String
bindable bind

The alignment of the title text.

Defaults to:

'left'

getTitleAlign : String

Returns the value of titleAlign

Returns

String

setTitleAlign (titleAlign)

Sets the value of titleAlign

Parameters

titleAlign :  String

titlePosition : Number
bindable bind

The ordinal position among the header items (tools and other components specified using the cfg-items config) at which the title component is inserted. See Panel's header config.

If not specified, the title is inserted after any cfg-items, but before any Ext.panel.Panel#tools.

Note that if an icon or iconCls has been configured, then the icon component will be the first item before all specified tools or cfg-items. This configuration does not include the icon.

Defaults to:

0

getTitlePosition : Number

Returns the value of titlePosition

Returns

Number

setTitlePosition (titlePosition)

Sets the value of titlePosition

Parameters

titlePosition :  Number

titleRotation : 'default' / 0 / 1 / 2
bindable bind

The rotation of the header's title text. Can be one of the following values:

  • 'default' - use the default rotation, depending on the dock position of the header
  • 0 - no rotation
  • 1 - rotate 90deg clockwise
  • 2 - rotate 90deg counter-clockwise

The default behavior of this config depends on the dock position of the header:

  • 'top' or 'bottom' - 0
  • 'right' - 1
  • 'left' - 1

Defaults to:

'default'

getTitleRotation : 'default' / 0 / 1 / 2

Returns the value of titleRotation

Returns

'default' / 0 / 1 / 2

setTitleRotation (titleRotation)

Sets the value of titleRotation

Parameters

titleRotation :  'default' / 0 / 1 / 2

toFrontOnShow : Boolean

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

Defaults to:

true

tpl : Ext.XTemplate / Ext.Template / String / String[]

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

Available since: 3.4.0

getTpl ( name )
private pri

Parameters

name :  Object

tplWriteMode : String

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

Defaults to:

'overwrite'

Available since: 3.4.0

twoWayBindable : String / String[] / Object
bindable bind private pri

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

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

Defaults to:

null

getTwoWayBindable : String / String[] / Object

Returns the value of twoWayBindable

Returns

String / String[] / Object

setTwoWayBindable (twoWayBindable)

Sets the value of twoWayBindable

Parameters

twoWayBindable :  String / String[] / Object

ui : String
bindable bind

A UI style for a component.

Defaults to:

'default'

setUI ( ui )

Sets the UI for the component. This will remove any existing UIs on the component. It will also loop through any uiCls set on the component and rename them so they include the new UI.

Parameters

ui :  String

The new UI for the component.

uiCls : String[]
private pri

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

Defaults to:

[]

viewModel : String / Object / Ext.app.ViewModel
bindable bind

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

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

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

Defaults to:

null

getViewModel : String / Object / Ext.app.ViewModel

Returns the value of viewModel

Returns

String / Object / Ext.app.ViewModel

setViewModel (viewModel)

Sets the value of viewModel

Parameters

viewModel :  String / Object / Ext.app.ViewModel

weight : Number

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

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

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

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

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

Defaults to:

null

width : Number / String
bindable bind

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

getWidth Number

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

Returns

:Number

setWidth ( width ) : Ext.Component

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

Parameters

width :  Number

The new width to setThis may be one of:

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

Returns

:Ext.Component

this

xtype : Ext.enums.Widget

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

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

But by using xtype, the above becomes:

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

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

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

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

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

 // or alternatively:

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

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

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

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

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

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

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

Available since: 2.3.0

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

The value true causes config values to be stored on instances using a property name prefixed with an underscore ("_") character. A value of false stores config values as properties using their exact name (no prefix).

Defaults to:

false

Available since: 5.0.0

$configStrict : Boolean
private pri

The value true instructs the initConfig method to only honor values for properties declared in the config block of a class. When false, properties that are not declared in a config block will be placed on the instance.

Defaults to:

true

Available since: 5.0.0

_isLayoutRoot : Boolean
protected pro

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

Defaults to:

false

_renderState : Number
readonly ro private pri

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

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

Defaults to:

0

Available since: 5.0.0

autoGenId : Boolean
private pri

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

Defaults to:

false

beforeBlur
protected pro

Template method to do any pre-blur processing.

Defaults to:

Ext.emptyFn

Parameters

e :  Ext.event.Event

The event object

beforeFocus
protected pro

Template method to do any pre-focus processing.

Defaults to:

Ext.emptyFn

Parameters

e :  Ext.event.Event

The event object

componentLayoutCounter : Number
private pri

The number of component layout calls made on this object.

Defaults to:

0

contentPaddingProperty : String

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

Defaults to:

'padding'

convertPositionSpec
private pri

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

Defaults to:

Ext.identityFn

defaultBindProperty : String
protected pro

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

 bind: '{name}'

Is equivalent to this object form:

 bind: {
     value: '{name}'
 }

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

Defaults to:

null

eventsSuspended
private pri

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

Defaults to:

0

floatParent : Ext.container.Container
readonly ro

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

There are other similar relationships such as the Ext.button.Button which activates a menu, or the Ext.menu.Item which activated a submenu, or the Ext.grid.column.Column which activated the column menu.

These differences are abstracted away by the up method.

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

See floating and zIndexManager

focusable : Boolean

true for interactive Components, false for static Components

frameSize : Object
readonly ro

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

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

Defaults to:

null

Properties

top : Number

The width of the top framing element in pixels.

Defaults to: 0

right : Number

The width of the right framing element in pixels.

Defaults to: 0

bottom : Number

The width of the bottom framing element in pixels.

Defaults to: 0

left : Number

The width of the left framing element in pixels.

Defaults to: 0

width : Number

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

Defaults to: 0

height : Number

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

Defaults to: 0

hasListeners : Object
readonly ro

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

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

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

initFocusable
protected pro

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

Defaults to:

Ext.emptyFn

isComponent : Boolean

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

Defaults to:

true

isConfiguring : Boolean
readonly ro protected pro

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

Defaults to:

false

Available since: 5.0.0

isFirstInstance : Boolean
readonly ro protected pro

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

Defaults to:

false

Available since: 5.0.0

isHeader : Boolean

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

Defaults to:

true

isInstance : Boolean
readonly ro protected pro

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

Defaults to:

true

isObservable : Boolean

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

Defaults to:

true

items : Ext.util.AbstractMixedCollection

The MixedCollection containing all the child items of this container.

Defaults to:

new Ext.util.AbstractMixedCollection(false, me.getComponentId)

Available since: 2.3.0

layoutCounter : Number
private pri

The number of container layout calls made on this object.

Defaults to:

0

liquidLayout
private pri

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

Defaults to:

false

maskOnDisable : Boolean

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

Defaults to:

true

ownerCt : Ext.container.Container
readonly ro

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

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

These differences are abstracted away by the up method.

Note: to access items within the Container see itemId.

Available since: 2.3.0

postBlur
protected pro

Template method to do any post-blur processing.

Defaults to:

Ext.emptyFn

Parameters

e :  Ext.event.Event

The event object

postFocus
protected pro

Template method to do any post-focus processing.

Defaults to:

Ext.emptyFn

Parameters

e :  Ext.event.Event

The event object

rendered : Boolean
readonly ro

Indicates whether or not the component has been rendered.

Defaults to:

false

Available since: 1.1.0

scrollFlags : Object
readonly ro private pri

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

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

This object has the following properties:

Defaults to:

{
    overflowX: ox,
    overflowY: oy,
    x: ox = (ox === 'auto' || ox === 'scroll'),
    y: oy = (oy === 'auto' || oy === 'scroll'),
    both: ox && oy
}

Properties

x : Boolean

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

y : Boolean

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

both : Boolean

true if this Component is scrollable both horizontally and vertically.

overflowX : String

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

overflowY : String

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

self : Ext.Class
protected pro

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#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'

Defaults to:

Base

synthetic : Boolean
private pri

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

Defaults to:

false

validRefRe : RegExp
private pri

Regular expression used for validating reference values.

Defaults to:

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

zIndexManager : Ext.ZIndexManager
readonly ro

Only present for floating Components after they have been rendered.

A reference to the ZIndexManager which is managing this Component's z-index.

The Ext.ZIndexManager maintains a stack of floating Component z-indices, and also provides a single modal mask which is insert just beneath the topmost visible modal floating Component.

Floating Components may be brought to the front or sent to the back of the z-index stack.

This defaults to the global Ext.WindowManager for floating Components that are programatically rendered.

For floating Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found which is floating. If no floating ancestor is found, the global Ext.WindowManager is used.

See Ext.Component#floating and zIndexParent

zIndexParent : Ext.container.Container
readonly ro

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

For Ext.Component#floating Components which are child items of a Container, the zIndexParent will be a floating ancestor Container which is responsible for the base z-index value of all its floating descendants. It provides a Ext.ZIndexManager which provides z-indexing services for all its descendant floating Components.

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

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

See Ext.Component#floating and zIndexManager

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

_addDeclaredListeners ( listeners ) : Boolean
private pri

Adds declarative listeners as nested arrays of listener objects.

Parameters

listeners :  Array

Returns

:Boolean

true if any listeners were added

add ( component ) : Ext.Component[]/Ext.Component

Adds Ext.Component(s) to this Container.

Description:

Notes:

If the Container is already rendered when add is called, it will render the newly added Component into its content area.

If the Container was configured with a size-managing layout manager, the Container will recalculate its internal layout at this time too.

Note that the default layout manager simply renders child Components sequentially into the content area and thereafter performs no sizing.

If adding multiple new child Components, pass them as an array to the add method, so that only one layout recalculation is performed.

tb = new Ext.toolbar.Toolbar({
    renderTo: document.body
});  // toolbar is rendered
// add multiple items.
// (defaultType for Ext.toolbar.Toolbar is 'button')
tb.add([{text:'Button 1'}, {text:'Button 2'}]);

To inject components between existing ones, use the insert method.

Warning:

Components directly managed by the BorderLayout layout manager may not be removed or added. See the Notes for Ext.layout.container.Border for more details.

Available since: 2.3.0

Parameters

component :  Ext.Component[]/Object[]/Ext.Component.../Object...

Either one or more Components to add or an Array of Components to add. See cfg-items for additional information.

Returns

:Ext.Component[]/Ext.Component

The Components that were added.

addBindableUpdater ( property )
private pri

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

Available since: 5.0.0

Parameters

property :  String

The name of the config property.

addClass ( cls ) : Ext.Component
deprecated dep

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

Available since: 2.3.0

Parameters

cls :  String/String[]

The CSS class name to add.

Returns

:Ext.Component

Returns the Component to allow method chaining.

Deprecated since version 4.1
Use addCls instead.

addCls ( cls ) : Ext.Component
chainable ch

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

Parameters

cls :  String/String[]

The CSS class name to add.

Returns

:Ext.Component

Returns the Component to allow method chaining.

addClsWithUI ( classes, [skip] )

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

Parameters

classes :  String/String[]

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

skip :  Boolean (optional)

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

addDeprecations ( deprecations )
private pri

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

Parameters

deprecations :  Object

addFocusListener
private pri

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

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

addListener ( eventName, [fn], [scope], [options] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

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

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

myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

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

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

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

Parameters

eventName :  String/Object

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

fn :  Function (optional)

The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable#fireEvent plus the options parameter described below.

scope :  Object (optional)

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

options :  Object (optional)

An object containing handler configuration.

Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

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

delay :  Number

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

single :  Boolean

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

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

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

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

  new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

destroyable :  Boolean (optional)

When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

Combining Options

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

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

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

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

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

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

fn :  Function (optional)

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

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

options :  Object (optional)

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

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

addPropertyToState ( state, propName, [value] ) : Boolean
protected pro

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

Parameters

state :  Object

The state object.

propName :  String

The name of the property on this object to save.

value :  String (optional)

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

Returns

:Boolean

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

addStateEvents ( events )

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

Parameters

events :  String/String[]

The event name or an array of event names.

addTool ( tool )

Add a tool to the header

Parameters

tool :  Object

addUIClsToElement ( uiCls )
protected pro

Method which adds a specified UI + uiCls to the components element. Can be overridden to add the UI to more than just the component's element.

Parameters

uiCls :  String

The UI class to add to the element.

addUIToElement
private pri

Method which adds a specified UI to the components element.

afterClassMixedIn ( targetClass )
private pri

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

Parameters

targetClass :  Ext.Class

afterComponentLayout ( width, height, oldWidth, oldHeight )
template tpl protected pro

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

Parameters

width :  Number

The width that was set

height :  Number

The height that was set

oldWidth :  Number/undefined

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

oldHeight :  Number/undefined

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

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

afterHide ( [callback], [scope] )
template tpl protected pro

Invoked after the Component has been hidden.

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

Parameters

callback :  Function (optional)

scope :  Object (optional)

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

afterLayout ( layout )
template tpl protected pro

Invoked after the Container has laid out (and rendered if necessary) its child Components.

Parameters

layout :  Ext.layout.container.Container

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

afterRender
template tpl protected pro

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

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

afterSetPosition ( x, y )
template tpl protected pro

Template method called after a Component has been positioned.

Parameters

x :  Number

y :  Number

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

afterShow ( [animateTarget], [callback], [scope] )
template tpl protected pro

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

Gets passed the same parameters as #show.

Parameters

animateTarget :  String/Ext.dom.Element (optional)

callback :  Function (optional)

scope :  Object (optional)

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

alignTo ( element, [position], [offsets] ) : Ext.util.Positionable

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

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

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

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

Example Usage:

// align el to other-el using the default positioning
// ("tl-bl", non-constrained)
el.alignTo("other-el");

// align the top left corner of el with the top right corner of other-el
// (constrained to viewport)
el.alignTo("other-el", "tr?");

// align the bottom right corner of el with the center left edge of other-el
el.alignTo("other-el", "br-l?");

// align the center of el with the bottom left corner of other-el and
// adjust the x position by -6 pixels (and the y position by 0)
el.alignTo("other-el", "c-bl", [-6, 0]);

Parameters

element :  Ext.util.Positionable/HTMLElement/String

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

position :  String (optional)

The position to align to

Defaults to: "tl-bl?"

offsets :  Number[] (optional)

Offset the positioning by [x, y] Element animation config object

Returns

:Ext.util.Positionable

this

animate ( config ) : Object
chainable ch

Performs custom animation on this object.

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

Animating a Ext.Component

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

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

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

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

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

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

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

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

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

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

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

Parameters

config :  Object

Configuration for Ext.fx.Anim. Note that the to config is required.

Returns

:Object

this

applyBind ( binds, currentBindings ) : Object
private pri

Available since: 5.0.0

Parameters

binds :  String/Object

currentBindings :  Object

Returns

:Object

applyRenderSelectors
private pri

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

applySession ( session ) : Ext.data.Session
private pri

Transforms a Session config to a proper instance.

Available since: 5.0.0

Parameters

session :  Object

Returns

:Ext.data.Session

applyState ( state )

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

Parameters

state :  Object

The state

applyViewModel ( viewModel ) : Ext.app.ViewModel
private pri

Transforms a ViewModel config to a proper instance.

Available since: 5.0.0

Parameters

viewModel :  String/Object/Ext.app.ViewModel

Returns

:Ext.app.ViewModel

attachChildEls ( el, owner )
private pri

Sets references to elements inside the component.

Parameters

el :  Object

owner :  Object

attachReference ( component )
private pri

Sets up a component reference.

Parameters

component :  Ext.Component

The component to reference.

beforeComponentLayout ( adjWidth, adjHeight ) : Boolean
template tpl protected pro

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

Parameters

adjWidth :  Number

The box-adjusted width that was set.

adjHeight :  Number

The box-adjusted height that was set.

Returns

:Boolean

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

beforeDestroy
template tpl protected pro

Invoked before the Component is destroyed.

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

beforeLayout
template tpl protected pro

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

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

beforeSetPosition ( x, y, animate )
private pri

Template method called before a Component is positioned.

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

Parameters

x :  Object

y :  Object

animate :  Object

beforeShow
template tpl protected pro

Invoked before the Component is shown.

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

bubble ( fn, [scope], [args] ) : Ext.Component
chainable ch

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

Parameters

fn :  Function

The function to call

scope :  Object (optional)

The scope of the function. Defaults to current node.

args :  Array (optional)

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

Returns

:Ext.Component

this

cacheRefEls ( el )
private pri

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

Parameters

el :  Object

calculateAnchorXY ( [anchor], [extraX], [extraY], [size] ) : Number[]
private pri

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

Parameters

anchor :  String (optional)

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

Defaults to: 'tl'

extraX :  Number (optional)

value to be added to the x coordinate

extraY :  Number (optional)

value to be added to the y coordinate

size :  Object (optional)

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

Returns

:Number[]

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

calculateConstrainedPosition ( [constrainTo], [proposedPosition], [local], [proposedSize] ) : Number[]
private pri

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

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

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

An alternative constraint may be passed.

Parameters

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

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

proposedPosition :  Number[] (optional)

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

local :  Boolean (optional)

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

proposedSize :  Number[] (optional)

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

Returns

:Number[]

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

callParent ( args ) : Object
protected pro

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

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10));     // alerts 10
 alert(My.Derived2.method(10)); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

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

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     extend: 'Ext.some.Class',

     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

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

 Ext.define('App.patches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

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

Parameters

args :  Array/Arguments

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

Returns

:Object

Returns the result of calling the superclass method

cancelFocus
protected pro

Cancel any deferred focus on this component

cascade ( fn, [scope], [args] ) : Ext.container.Container
chainable ch

Cascades down the component/container heirarchy from this component (passed in the first call), calling the specified function with each component. The scope (this reference) of the function call will be the scope provided or the current component. The arguments to the function will be the args provided or the current component. If the function returns false at any point, the cascade is stopped on that branch.

Available since: 2.3.0

Parameters

fn :  Function

The function to call

scope :  Object (optional)

The scope of the function (defaults to current component)

args :  Array (optional)

The args to call the function with. The current component always passed as the last argument.

Returns

:Ext.container.Container

this

center Ext.Component
chainable ch

Center this Component in its container.

Returns

:Ext.Component

this

child ( [selector] ) :

Retrieves the first direct child of this container which matches the passed selector or component. The passed in selector must comply with an Ext.ComponentQuery selector, or it can be an actual Ext.Component.

Parameters

selector :  String/Ext.Component (optional)

An Ext.ComponentQuery selector. If no selector is specified, the first child will be returned.

Returns

:

Ext.Component The matching child Ext.Component (or null if no match was found).

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

clearReference ( component )
private pri

Clear a component reference.

Parameters

component :  Ext.Component

The component to remove.

clearReferences
private pri

Invalidates the references collection. Typically called when removing a container from this container, since it's difficult to know what references got removed.

cloneConfig ( overrides ) : Ext.Component

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

Parameters

overrides :  Object

A new config containing any properties to override in the cloned version. An id property can be passed on this object, otherwise one will be generated to avoid duplicates.

Returns

:Ext.Component

clone The cloned copy of this component

constrainBox ( box )
private pri

Parameters

box :  Object

constructPlugin ( ptype )
private pri

Parameters

ptype :  String/Object

string or config object containing a ptype property.

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

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

constructPlugins
private pri

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

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

constructor ( config )

Creates new Component.

Parameters

config :  Ext.dom.Element/String/Object

The configuration options may be specified as either:

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

contains ( comp, [deep] ) : Boolean

Determines whether the passed Component is either an immediate child of this Container, or whether it is a descendant.

Parameters

comp :  Ext.Component

The Component to test.

deep :  Boolean (optional)

Pass true to test for the Component being a descendant at any level.

Defaults to: false

Returns

:Boolean

true if the passed Component is contained at the specified level.

createRelayer ( newName, [beginEnd] ) : Function
private pri

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

Parameters

newName :  String

The name under which to refire the passed parameters.

beginEnd :  Array (optional)

The caller can specify on which indices to slice.

Returns

:Function

destroy
private pri

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

Available since: 1.1.0

disable
chainable ch

Disables all child input fields and buttons.

Returns

:

doApplyRenderTpl ( out, values )
private pri

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

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

Parameters

out :  Object

values :  Object

doAutoRender
private pri

Handles autoRender. Floating Components may have an ownerCt. If they are asking to be constrained, constrain them within that ownerCt, and have their z-index managed locally. Floating Components are always rendered to document.body

doComponentLayout Ext.Component
chainable ch deprecated dep

This method needs to be called whenever you change something on this component that requires the Component's layout to be recalculated.

Returns

:Ext.Component

this

Deprecated since version 4.1
Use updateLayout instead.

doConstrain ( [constrainTo] )

Moves this floating Component into a constrain region.

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

An alternative constraint may be passed.

Parameters

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

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

doFireEvent ( eventName, args, bubbles )
private pri

Continue to fire event.

Parameters

eventName :  String

args :  Array

bubbles :  Boolean

doLayout Ext.container.Container
chainable ch deprecated dep

Manually force this container's layout to be recalculated.

Available since: 2.3.0

Returns

:Ext.container.Container

this

Deprecated since version 4.1
Use updateLayout instead.

down ( [selector] ) :

Retrieves the first descendant of this container which matches the passed selector. The passed in selector must comply with an Ext.ComponentQuery selector, or it can be an actual Ext.Component.

Parameters

selector :  String/Ext.Component (optional)

An Ext.ComponentQuery selector or Ext.Component. If no selector is specified, the first child will be returned.

Returns

:

Ext.Component The matching descendant Ext.Component (or null if no match was found).

enable
chainable ch

Enables all child input fields and buttons.

Returns

:

enableBubble ( eventNames )

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Parameters

eventNames :  String/String[]

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

ensureAttachedToBody ( [runLayout] )

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

Parameters

runLayout :  Boolean (optional)

True to run the component's layout.

Defaults to: false

findParentBy ( fn ) : Ext.container.Container

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

See also the up method.

Parameters

fn :  Function

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

Returns

:Ext.container.Container

The first Container for which the custom function returns true

findParentByType ( xtype ) : Ext.container.Container

Find a container above this component at any level by xtype or class

See also the up method.

Parameters

xtype :  String/Ext.Class

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

Returns

:Ext.container.Container

The first Container which matches the given xtype or class

findPlugin ( ptype ) : Ext.plugin.Abstract

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

Parameters

ptype :  String

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

Returns

:Ext.plugin.Abstract

plugin instance.

finishRender ( containerIdx )
private pri

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

Parameters

containerIdx :  Number

The index into the Container items of this Component.

fireEvent ( eventName, args ) : Boolean

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

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

Parameters

eventName :  String

The name of the event to fire.

args :  Object...

Variable number of parameters are passed to handlers.

Returns

:Boolean

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

fireEventArgs ( eventName, args ) : Boolean

Fires the specified event with the passed parameter list.

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

Parameters

eventName :  String

The name of the event to fire.

args :  Object[]

An array of parameters which are passed to handlers.

Returns

:Boolean

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

fireHierarchyEvent ( eventName )
private pri

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

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

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

Available since: 4.2.0

Parameters

eventName :  String

The event name.

fixReference
private pri

Sets up a reference on our current reference holder.

focus ( [selectText], [delay], [callback], [scope] ) : Ext.Component
chainable ch

Try to focus this component.

Parameters

selectText :  Mixed (optional)

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

delay :  Boolean/Number (optional)

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

callback :  Function (optional)

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

scope :  Function (optional)

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

Returns

:Ext.Component

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

forceComponentLayout ( [options] )
deprecated dep

Updates this component's layout. If this update affects this components ownerCt, that component's updateLayout method will be called to perform the layout instead. Otherwise, just this component (and its child items) will layout.

Parameters

options :  Object (optional)

An object with layout options.

defer :  Boolean

true if this layout should be deferred.

isRoot :  Boolean

true if this layout should be the root of the layout.

Deprecated since version 4.1
Use updateLayout instead.

getActiveAnimation Ext.fx.Anim/Boolean

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

Returns

:Ext.fx.Anim/Boolean

Anim if element has active effects, else false

getAlignToXY ( element, [position], [offsets] ) : Number[]

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

Parameters

element :  Ext.util.Positionable/HTMLElement/String

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

position :  String (optional)

The position to align to

Defaults to: "tl-bl?"

offsets :  Number[] (optional)

Offset the positioning by [x, y]

Returns

:Number[]

[x, y]

getAnchorToXY ( el, [anchor], [local], [size] ) : Number[]
private pri

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

Parameters

el :  Ext.dom.Element

The element

anchor :  String (optional)

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

Defaults to: 'tl'

local :  Boolean (optional)

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

size :  Object (optional)

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

Returns

:Number[]

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

getAnchorXY ( [anchor], [local], [size] ) : Number[]

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

Parameters

anchor :  String (optional)

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

Defaults to: 'tl'

local :  Boolean (optional)

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

size :  Object (optional)

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

Returns

:Number[]

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

getBorderPadding Object
private pri

Returns the size of the element's borders and padding.

Returns

:Object

an object with the following numeric properties

  • beforeX
  • afterX
  • beforeY
  • afterY

getBox ( [contentBox], [local] ) : Object

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

Parameters

contentBox :  Boolean (optional)

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

local :  Boolean (optional)

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

Returns

:Object

An object in the format

x :  Number

The element's X position.

y :  Number

The element's Y position.

width :  Number

The element's width.

height :  Number

The element's height.

bottom :  Number

The element's lower bound.

right :  Number

The element's rightmost bound.

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

getBubbleParent Ext.util.Observable
private pri

Gets the bubbling parent for an Observable

Returns

:Ext.util.Observable

The bubble parent. null is returned if no bubble target exists

getBubbleTarget
protected pro

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

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

getChildByElement ( el, deep ) : Ext.Component

Return the immediate child Component in which the passed element is located.

Parameters

el :  Ext.dom.Element/HTMLElement/String

The element to test (or ID of element).

deep :  Boolean

If true, returns the deepest descendant Component which contains the passed element.

Returns

:Ext.Component

The child item which contains the passed element.

getChildItemsToDisable Ext.Component[]
private pri

Gets a list of child components to enable/disable when the container is enabled/disabled

Returns

:Ext.Component[]

Items to be enabled/disabled

getComponent ( comp ) : Ext.Component

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

Available since: 2.3.0

Parameters

comp :  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 property-items property

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

Returns

:Ext.Component

The component (if found).

getConfig ( [name], [peek] ) : Object

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

Parameters

name :  String (optional)

The name of the config property to get.

peek :  Boolean (optional)

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

Defaults to: false

Returns

:Object

The config property value.

getConstrainVector ( [constrainTo], [proposedPosition], [proposedSize] ) : Number[]/Boolean

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

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

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

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

Parameters

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

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

proposedPosition :  Number[] (optional)

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

proposedSize :  Number[] (optional)

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

Returns

:Number[]/Boolean

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

getEl Ext.dom.Element

Retrieves the top level element representing this component.

Available since: 1.1.0

Returns

:Ext.dom.Element

getFocusClsEl Ext.dom.Element
private pri

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

Returns

:Ext.dom.Element

The focus styling element.

getFocusEl Ext.dom.Element
private pri

Returns the focus holder element associated with this Container. By default, this is the Container's target element. Subclasses which use embedded focusable elements (such as Window and Button) should override this for use by the method-focus method.

Returns

:Ext.dom.Element

the focus holding element.

getFrameInfo Boolean
private pri

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

Returns

:Boolean

getFrameTpl ( table )
private pri

Parameters

table :  Object

getInherited ( [inner] ) : Object

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

Available since: 5.0.0

Parameters

inner :  Boolean (optional)

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

Defaults to: false

Returns

:Object

The inheritedState object containing inherited properties.

getInheritedConfig ( property, [skipThis] ) : Mixed

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

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

Available since: 5.0.0

Parameters

property :  String

The name of the config property to return.

skipThis :  Boolean (optional)

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

Defaults to: false

Returns

:Mixed

The value of the requested property.

getInitialConfig ( [name] ) : Object/Mixed

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

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed

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

getInsertPosition ( position ) : HTMLElement

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

Parameters

position :  String/Number/Ext.dom.Element/HTMLElement

Index, element id or element you want to put this component before.

Returns

:HTMLElement

DOM element that you can use in the insertBefore

getLocalX Number

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

Returns

:Number

The local x coordinate

getLocalXY Number[]

Returns the x and y coordinates of this element relative to its offsetParent.

Returns

:Number[]

The local XY position of the element

getLocalY Number

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

Returns

:Number

The local y coordinate

getMaskTarget
protected pro

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

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

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

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

getOffsetsTo ( offsetsTo ) : Number[]

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

Parameters

offsetsTo :  Ext.util.Positionable/HTMLElement/String

The Positionable, HTMLElement, or element id to get get the offsets from.

Returns

:Number[]

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

getOverflowEl
private pri

Get an el for overflowing, defaults to the target el

getOverflowStyle
private pri

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

getPlugin ( pluginId ) : Ext.plugin.Abstract

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

Parameters

pluginId :  String

Returns

:Ext.plugin.Abstract

plugin instance.

getPosition ( [local] ) : Number[]

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

Parameters

local :  Boolean (optional)

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

Defaults to: false

Returns

:Number[]

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

getRefItems ( deep )
protected pro

Used by Ext.ComponentQuery, child and down to retrieve all of the items which can potentially be considered a child of this Container.

This may be overriden by Components which have ownership of Components that are not contained in the property-items collection.

NOTE: IMPORTANT note for maintainers: Items are returned in tree traversal order. Each item is appended to the result array followed by the results of that child's getRefItems call. Floating child items are appended after internal child items.

Parameters

deep :  Object

getRefOwner
protected pro

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

By default this returns the Container which contains this Component.

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

getReferences Object

Returns an object holding the descendants of this view keyed by their reference. This object should not be held past the scope of the function calling this method. It will not be valid if items are added or removed from this or any sub-container.

The intended usage is shown here (assume there are 3 components with reference values of "foo", "bar" and "baz" at some level below this container):

 onClick: function () {
     var refs = this.getReferences();

     // using "refs" we can access any descendant by its "reference"

     refs.foo.getValue() + refs.bar.getValue() + refs.baz.getValue();
 }

If this component has a reference assigned to it, that is not included in this object. That reference is understood to belong to the ancestor container configured as the referenceHolder.

Available since: 5.0.0

Returns

:Object

An object with each child reference. This will be null if this container has no descendants with a reference specified.

getScrollX Number

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

Returns

:Number

getScrollY Number

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

Returns

:Number

getSize ( [contentSize] ) : Object

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

Parameters

contentSize :  Boolean (optional)

true to get the width/size minus borders and padding

Returns

:Object

An object containing the element's size:

width :  Number

height :  Number

getSizeModel ( ownerCtSizeModel ) : Object
protected pro

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

Parameters

ownerCtSizeModel :  Object

Returns

:Object

The size model for this component.

width :  Ext.layout.SizeModel

The Ext.layout.SizeModel for the width.

height :  Ext.layout.SizeModel

The Ext.layout.SizeModel for the height.

getState Object

The supplied default state gathering method for the Component class.

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

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

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

Returns

:Object

getStyleProxy ( cls )
private pri

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

Parameters

cls :  Object

getTargetEl
private pri

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

getTdCls
private pri

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

getTdType
private pri

Partner method to getTdCls.

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

getTools Ext.panel.Tool[]

Gets the tools for this header.

Returns

:Ext.panel.Tool[]

The tools

getViewRegion Ext.util.Region

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

Returns

:Ext.util.Region

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

getX Number

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

Returns

:Number

The X position of the element

getXType String

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

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

Returns

:String

The xtype

getXTypes String

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

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

Example usage:

Available since: 2.3.0

Returns

:String

The xtype hierarchy string

getXY Number[]

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

Returns

:Number[]

The XY position of the element

getY Number

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

Returns

:Number

The Y position of the element

hasActiveFx Ext.fx.Anim/Boolean
deprecated dep

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

Returns

:Ext.fx.Anim/Boolean

Anim if element has active effects, else false

Deprecated since version 4.0
Replaced by getActiveAnimation

hasCls ( className ) : Boolean

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

Parameters

className :  String

The CSS class to check for.

Returns

:Boolean

true if the class exists, else false.

hasConfig ( config )
private pri

Parameters

config :  Object

hasListener ( eventName ) : Boolean

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

Parameters

eventName :  String

The name of the event to check for

Returns

:Boolean

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

hasUICls ( cls )

Checks if there is currently a specified uiCls.

Parameters

cls :  String

The cls to check.

hide ( [animateTarget], [callback], [scope] ) : Ext.Component
chainable ch

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

Parameters

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

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

Defaults to: null

callback :  Function (optional)

A callback function to call after the Component is hidden.

scope :  Object (optional)

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

Returns

:Ext.Component

this

initBindable
private pri

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

Available since: 5.0.0

initComponent
template tpl protected pro

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

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

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

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

Ext.define('DynamicButtonText', {
    extend: 'Ext.button.Button',

    initComponent: function() {
        this.text = new Date();
        this.renderTo = Ext.getBody();
        this.callParent();
    }
});

Ext.onReady(function() {
    Ext.create('DynamicButtonText');
});

Available since: 1.1.0

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

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Parameters

instanceConfig :  Object

Returns

:Ext.Base

this

initEvents
protected pro

Initialize any events on this component

initFocusableEvents
protected pro

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

initInheritedState ( inheritedState, inheritedStateInner )
protected pro

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

Parameters

inheritedState :  Object

inheritedStateInner :  Object

initItems
protected pro

This method is called to initialize the items collection. A derived class can override this method to do any last minute manipulation of items and then call this method using callParent. Upon return, the items will no longer be a simple array.

initPadding ( targetEl )
private pri

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

Parameters

targetEl :  Object

initRenderData Object
protected pro

Initialized the renderData to be used when rendering the renderTpl.

Returns

:Object

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

initRenderTpl Ext.XTemplate
private pri

Initializes the renderTpl.

Returns

:Ext.XTemplate

The renderTpl XTemplate instance.

initState
private pri

Initializes the state of the object upon construction.

initStyles ( targetEl )
private pri

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

Parameters

targetEl :  Object

insert ( index, component ) : Ext.Component

Inserts a Component into this Container at a specified index. Fires the beforeadd event before inserting, then fires the event-add event after the Component has been inserted.

Available since: 2.3.0

Parameters

index :  Number

The index at which the Component will be inserted into the Container's items collection

component :  Ext.Component/Object/Ext.Component[]/Object[]

The child Component or config object to insert.

Ext uses lazy rendering, and will only render the inserted Component should it become necessary.

A Component config object may be passed in order to avoid the overhead of constructing a real Component object if lazy rendering might mean that the inserted Component will not be rendered immediately. To take advantage of this 'lazy instantiation', set the Ext.Component#xtype config property to the registered type of the Component wanted.

You can pass an array of Component instances and config objects.

For a list of all available xtypes, see Ext.enums.Widget.

Returns

:Ext.Component

component The Component (or config object) that was inserted with the Container's default config values applied.

invalidateInheritedState
private pri

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

Available since: 5.0.0

is ( selector ) : Boolean

Tests whether this Component matches a Ext.ComponentQuery selector string.

Parameters

selector :  String

The selector string to test against.

Returns

:Boolean

true if this Component matches the selector.

isAncestor ( possibleDescendant ) : Boolean

Determines whether this Container is an ancestor of the passed Component. This will return true if the passed Component is anywhere within the subtree beneath this Container.

Parameters

possibleDescendant :  Ext.Component

The Component to test for presence within this Container's subtree.

Returns

:Boolean

isDescendantOf ( container ) : Boolean

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

Parameters

container :  Ext.container.Container

Returns

:Boolean

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

isDisabled Boolean

Method to determine whether this Component is currently disabled.

Returns

:Boolean

the disabled state of this Component.

isDraggable Boolean

Method to determine whether this Component is draggable.

Returns

:Boolean

the draggable state of this component.

isDroppable Boolean

Method to determine whether this Component is droppable.

Returns

:Boolean

the droppable state of this component.

isFloating Boolean

Method to determine whether this Component is floating.

Returns

:Boolean

the floating state of this component.

isHidden Boolean

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

Returns

:Boolean

the hidden state of this Component.

isLayoutRoot Boolean
protected pro

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

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

Returns

:Boolean

isLayoutSuspended Boolean

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

Returns

:Boolean

true layout of this component is suspended.

isMasked ( [deep] ) : Boolean

Returns masked state for this Component.

Parameters

deep :  Boolean (optional)

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

Defaults to: false

Returns

:Boolean

True if masked, false otherwise.

isSuspended ( [event] ) : Boolean

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

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean

true if events are suspended

isVisible ( [deep] ) : Boolean

Returns true if this component is visible.

Available since: 1.1.0

Parameters

deep :  Boolean (optional)

Pass true to interrogate the visibility status of all parent Containers to determine whether this Component is truly visible to the user.

Generally, to determine whether a Component is hidden, the no argument form is needed. For example when creating dynamically laid out UIs in a hidden Container before showing them.

Defaults to: false

Returns

:Boolean

true if this component is visible, false otherwise.

isXType ( xtype, [shallow] ) : Boolean

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:

Available since: 2.3.0

Parameters

xtype :  String

The xtype to check for this Component

shallow :  Boolean (optional)

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

Defaults to: false

Returns

:Boolean

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

lookupController ( [skipThis] ) : Ext.app.ViewController

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

Available since: 5.0.1

Parameters

skipThis :  Boolean (optional)

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

Defaults to: false

Returns

:Ext.app.ViewController

The controller. null if no controller is found.

lookupReference ( key ) : Ext.Component

Gets a reference to a child specified using the reference configuration.

Parameters

key :  String

The name of the reference.

Returns

:Ext.Component

The referenced component or null if it is not found.

lookupReferenceHolder ( [skipThis] ) : Ext.app.ViewController/Ext.container.Container
private pri

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

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

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

Defaults to: true

Returns

:Ext.app.ViewController/Ext.container.Container

The reference holder.

lookupSession ( [skipThis] ) : Ext.data.Session

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

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

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

Defaults to: false

Returns

:Ext.data.Session

lookupViewModel ( [skipThis] ) : Ext.app.ViewModel

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

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

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

Defaults to: false

Returns

:Ext.app.ViewModel

makeBindableUpdater ( cfg ) : Function
private pri

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

Available since: 5.0.0

Parameters

cfg :  Ext.Config

Returns

:Function

The updater function.

mask ( [msg], [msgCls] )

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

See unmask.

Parameters

msg :  String (optional)

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

msgCls :  String (optional)

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

mon ( item, ename, [fn], [scope], [options] ) : Object

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

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item to which to add a listener/listeners.

ename :  Object/String

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

fn :  Function (optional)

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

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

options :  Object (optional)

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

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

move ( fromIdx, toIdx ) : Ext.Component
deprecated dep

Moves a Component within the Container. This method does not account for things like splitter components added by a layout. To better handle these situations, it is recommended to use moveBefore or moveAfter instead.

Parameters

fromIdx :  Number/Ext.Component

The index/component to move.

toIdx :  Number

The new index for the Component.

Returns

:Ext.Component

component The Component that was moved.

Deprecated since version 5.0
Use moveBefore or moveAfter instead.

moveAfter ( item, after ) : Ext.Component

Moves the given item into this container following after. This method will account for layout-generated components like splitters and should be used instead of index based move. If after is null then the item will be the first item in this container.

Available since: 5.0.0

Parameters

item :  Ext.Component

The item to move. May be a component configuration object.

after :  Ext.Component

The reference component. May be null.

Returns

:Ext.Component

The moved item.

moveBefore ( item, before ) : Ext.Component

Moves the given item into this container in front of before. This method will account for layout-generated components like splitters and should be used instead of index based move. If before is null then the item will be the last item in this container.

Available since: 5.0.0

Parameters

item :  Object/Ext.Component

The item to move. May be a component configuration object.

before :  Ext.Component

The reference component. May be null.

Returns

:Ext.Component

The moved item.

mun ( item, ename, [fn], [scope] )

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

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

fn :  Function (optional)

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

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

nextChild ( child, [selector] ) : Ext.Component

A method to find a child component after the passed child parameter. If a selector is also provided, the first child component matching the selector will be returned.

Parameters

child :  Ext.Component

The child to use as a starting point to find the next child.

selector :  String (optional)

A Ext.ComponentQuery selector to find the next child. This will return the next child matching this selector. This parameter is optional.

Returns

:Ext.Component

The next child found, null if no child found.

nextNode ( [selector] ) : Ext.Component

Returns the next node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree to attempt to find a match. Contrast with nextSibling.

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following nodes.

Returns

:Ext.Component

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

nextSibling ( [selector] ) : Ext.Component

Returns the next sibling of this Component.

Optionally selects the next sibling which matches the passed Ext.ComponentQuery selector.

May also be referred to as next()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with nextNode

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the following items.

Returns

:Ext.Component

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

on ( eventName, [fn], [scope], [options] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

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

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

myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

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

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

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

Parameters

eventName :  String/Object

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

fn :  Function (optional)

The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable#fireEvent plus the options parameter described below.

scope :  Object (optional)

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

options :  Object (optional)

An object containing handler configuration.

Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

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

delay :  Number

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

single :  Boolean

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

buffer :  Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame :  Number

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

target :  Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element :  String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

  new Ext.panel.Panel({
      title: 'The title',
      listeners: {
          click: this.handlePanelClick,
          element: 'body'
      }
  });

destroyable :  Boolean (optional)

When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

Defaults to:

false

priority :  Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

Combining Options

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

A delayed, one-time listener.

myPanel.on('hide', this.handleClick, this, {
    single: true,
    delay: 100
});

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

onAdd ( component, position )
template tpl protected pro

This method is invoked after a new Component has been added. It is passed the Component which has been added. This method may be used to update any internal structure which may depend upon the state of the child items.

Parameters

component :  Ext.Component

position :  Number

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

onAdded ( container, pos, instanced )
template tpl protected pro

Method to manage awareness of when components are added to their respective Container, firing an #added event. References are established at add time rather than at render time.

Allows addition of behavior when a Component is added to a Container. At this stage, the Component is in the parent Container's collection of child items. After calling the superclass's onAdded, the ownerCt reference will be present, and if configured with a ref, the refOwner will be set.

Available since: 3.4.0

Parameters

container :  Ext.container.Container

Container which holds the component.

pos :  Number

Position at which the component was added.

instanced :  Boolean

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

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

onBeforeAdd ( item )
template tpl protected pro

This method is invoked before adding a new child Component. It is passed the new Component, and may be used to modify the Component, or prepare the Container in some way. Returning false aborts the add operation.

Parameters

item :  Ext.Component

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

onBoxReady ( width, height )
template tpl protected pro

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

Parameters

width :  Number

The width of this component

height :  Number

The height of this component

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

onDestroy
template tpl protected pro

Allows addition of behavior to the destroy operation. After calling the superclass's onDestroy, the Component will be destroyed.

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

onDisable
template tpl protected pro

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

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

onEnable
template tpl protected pro

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

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

onHide ( [animateTarget], [callback], [scope] )
template tpl protected pro

Allows addition of behavior to the hide operation. After calling the superclass's onHide, the Component will be hidden.

Gets passed the same parameters as #hide.

Parameters

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

callback :  Function (optional)

scope :  Object (optional)

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

onPosition ( x, y )
template tpl protected pro

Called after the component is moved, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a move occurs.

Parameters

x :  Number

The new x position.

y :  Number

The new y position.

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

onRemove ( component, isDestroying )
template tpl protected pro

This method is invoked after a new Component has been removed. It is passed the Component which has been removed. This method may be used to update any internal structure which may depend upon the state of the child items.

Parameters

component :  Ext.Component

The removed component

isDestroying :  Boolean

true if the the component is being destroyed in the remove action

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

onRemoved ( destroying )
template tpl protected pro

Method to manage awareness of when components are removed from their respective Container, firing a #removed event. References are properly cleaned up after removing a component from its owning container.

Allows addition of behavior when a Component is removed from its parent Container. At this stage, the Component has been removed from its parent Container's collection of child items, but has not been destroyed (It will be destroyed if the parent Container's autoDestroy is true, or if the remove call was passed a truthy second parameter). After calling the superclass's onRemoved, the ownerCt and the refOwner will not be present.

Available since: 3.4.0

Parameters

destroying :  Boolean

Will be passed as true if the Container performing the remove operation will delete this Component upon remove.

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

onRender ( parentNode, containerIdx )
template tpl protected pro

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

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

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

Parameters

parentNode :  Ext.dom.Element

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

containerIdx :  Number

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

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

onResize ( width, height, oldWidth, oldHeight )
template tpl protected pro

Allows addition of behavior to the resize operation.

Called when Ext.resizer.Resizer#drag event is fired.

Parameters

width :  Object

height :  Object

oldWidth :  Object

oldHeight :  Object

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

onShow ( [animateTarget], [callback], [scope] )
template tpl protected pro

Allows addition of behavior to the show operation. After calling the superclass's onShow, the Component will be visible.

Override in subclasses where more complex behaviour is needed.

Gets passed the same parameters as #show.

Parameters

animateTarget :  String/Ext.dom.Element (optional)

callback :  Function (optional)

scope :  Object (optional)

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

onShowComplete ( [callback], [scope] )
template tpl protected pro

Invoked after the #afterShow method is complete.

Gets passed the same callback and scope parameters that #afterShow received.

Parameters

callback :  Function (optional)

scope :  Object (optional)

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

onStateChange
private pri

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

owns ( element )
private pri

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

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

Parameters

element :  Object

prevChild ( child, [selector] ) : Ext.Component

A method to find a child component before the passed child parameter. If a selector is also provided, the first child component matching the selector will be returned.

Parameters

child :  Ext.Component

The child to use as a starting point to find the previous child.

selector :  String (optional)

A Ext.ComponentQuery selector to find the previous child. This will return the first child matching this selector. This parameter is optional.

Returns

:Ext.Component

The previous child found, null if no child found.

previousNode ( [selector] ) : Ext.Component

Returns the previous node in the Component tree in tree traversal order.

Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree in reverse order to attempt to find a match. Contrast with previousSibling.

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding nodes.

Returns

:Ext.Component

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

previousSibling ( [selector] ) : Ext.Component

Returns the previous sibling of this Component.

Optionally selects the previous sibling which matches the passed Ext.ComponentQuery selector.

May also be referred to as prev()

Note that this is limited to siblings, and if no siblings of the item match, null is returned. Contrast with previousNode

Parameters

selector :  String (optional)

A Ext.ComponentQuery selector to filter the preceding items.

Returns

:Ext.Component

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

publishState ( [property], [value] )
protected pro

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

This method is called only by component authors.

Available since: 5.0.0

Parameters

property :  String (optional)

The name of the property to update.

value :  Object (optional)

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

query ( [selector] ) : Ext.Component[]

Retrieves all descendant components which match the passed selector. Executes an Ext.ComponentQuery.query using this container as its root.

Parameters

selector :  String (optional)

Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned.

Returns

:Ext.Component[]

Components which matched the selector

queryBy ( fn, [scope] ) : Ext.Component[]

Retrieves all descendant components which match the passed function. The function should return false for components that are to be excluded from the selection.

Parameters

fn :  Function

The matcher function. It will be called with a single argument, the component being tested.

scope :  Object (optional)

The scope in which to run the function. If not specified, it will default to the active component.

Returns

:Ext.Component[]

Components matched by the passed function

queryById ( id ) : Ext.Component

Finds a component at any level under this container matching the id/itemId. This is a shorthand for calling ct.down('#' + id);

Parameters

id :  String

The id to find

Returns

:Ext.Component

The matching id, null if not found

refreshScroll
private pri

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

registerFloatingItem ( cmp )

Called by Component#doAutoRender

Register a Container configured floating: true with this Component's Ext.ZIndexManager.

Components added in this way will not participate in any layout, but will be rendered upon first show in the way that Ext.window.Windows are.

Parameters

cmp :  Object

relayEvents ( origin, events, [prefix] ) : Object

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

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

Parameters

origin :  Object

The Observable whose events this object is to relay.

events :  String[]

Array of event names to relay.

prefix :  String (optional)

A common prefix to prepend to the event names. For example:

this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

:Object

A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Can be undone by calling

Ext.destroy(this.storeRelayers);

or this.store.relayers.destroy();

remove ( component, [autoDestroy] ) : Ext.Component

Removes a component from this container. Fires the beforeremove event before removing, then fires the event-remove event after the component has been removed.

Available since: 2.3.0

Parameters

component :  Ext.Component/String

The component reference or id to remove.

autoDestroy :  Boolean (optional)

True to automatically invoke the removed Component's Ext.Component#method-destroy function.

Defaults to the value of this Container's autoDestroy config.

Returns

:Ext.Component

component The Component that was removed.

removeAll ( [autoDestroy] ) : Ext.Component[]

Removes all components from this container.

Available since: 2.3.0

Parameters

autoDestroy :  Boolean (optional)

True to automatically invoke the removed Component's Ext.Component#method-destroy function. Defaults to the value of this Container's autoDestroy config.

Returns

:Ext.Component[]

Array of the removed components

removeClass ( cls ) : Ext.Component
deprecated dep

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

Available since: 2.3.0

Parameters

cls :  String/String[]

The CSS class name to remove.

Returns

:Ext.Component

Returns the Component to allow method chaining.

Deprecated since version 4.1
Use addCls instead.

removeCls ( cls ) : Ext.Component
chainable ch

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

Parameters

cls :  String/String[]

The CSS class name to remove.

Returns

:Ext.Component

Returns the Component to allow method chaining.

removeClsWithUI ( cls )

Removes a cls to the uiCls array, which will also call removeUIClsFromElement and removes it from all elements of this component.

Parameters

cls :  String/String[]

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

removeListener ( eventName, fn, [scope] )

Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the Ext.util.Observable#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 Ext.util.Observable#addListener or the listener will not be removed.

removeManagedListener ( item, ename, [fn], [scope] )

Removes listeners that were added by the mon method.

Parameters

item :  Ext.util.Observable/Ext.dom.Element

The item from which to remove a listener/listeners.

ename :  Object/String

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

fn :  Function (optional)

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

scope :  Object (optional)

If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

removeManagedListenerItem ( isClear, managedListener )
private pri

Remove a single managed listener item

Parameters

isClear :  Boolean

True if this is being called during a clear

managedListener :  Object

The managed listener item See removeManagedListener for other args

removeUIClsFromElement ( uiCls )
protected pro

Method which removes a specified UI + uiCls from the components element. The cls which is added to the element will be: this.baseCls + '-' + ui + uiCls.

Parameters

uiCls :  String

The UI class to remove from the element.

removeUIFromElement
private pri

Method which removes a specified UI from the components element.

render ( [container], [position] )

Renders the Component into the passed HTML element.

If you are using a Ext.container.Container object to house this Component, then do not use the render method.

A Container's child Components are rendered by that Container's layout manager when the Container is first rendered.

If the Container is already rendered when a new child Component is added, you may need to call the Container's doLayout to refresh the view which causes any unrendered child Components to be rendered. This is required so that you can add multiple child components if needed while only refreshing the layout once.

When creating complex UIs, it is important to remember that sizing and positioning of child items is the responsibility of the Container's layout manager. If you expect child items to be sized in response to user interactions, you must configure the Container with a layout manager which creates and manages the type of layout you have in mind.

Omitting the Container's layout config means that a basic layout manager is used which does nothing but render child components sequentially into the Container. No sizing or positioning will be performed in this situation.

Parameters

container :  Ext.dom.Element/HTMLElement/String (optional)

The element this Component should be rendered into. If it is being created from existing markup, this should be omitted.

position :  String/Number (optional)

The element ID or DOM node index within the container before which this component will be inserted (defaults to appending to the end of the container)

resolveListenerScope ( [defaultScope] ) : Ext.app.ViewController/Ext.container.Container
protected pro

Gets the Controller or Component that is used as the event root for this view.

Available since: 5.0.0

Parameters

defaultScope :  Object (optional)

The default scope to return if none is found.

Defaults to: this

Returns

:Ext.app.ViewController/Ext.container.Container

The default listener scope.

resumeEvent ( eventName )

Resumes firing of the named event(s).

After calling this method to resume events, the events will fire when requested to fire.

Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to resume.

resumeEvents ( [discardQueue] )

Resumes firing events (see suspendEvents).

If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

Parameters

discardQueue :  Boolean (optional)

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

savePropToState ( propName, state, [stateName] ) : Boolean

Conditionally saves a single property from this object to the given state object. The idea is to only save state which has changed from the initial state so that current software settings do not override future software settings. Only those values that are user-changed state should be saved.

Parameters

propName :  String

The name of the property to save.

state :  Object

The state object in to which to save the property.

stateName :  String (optional)

The name to use for the property in state.

Returns

:Boolean

True if the property was saved, false if not.

savePropsToState ( propNames, state ) : Object

Gathers additional named properties of the instance and adds their current values to the passed state object.

Parameters

propNames :  String/String[]

The name (or array of names) of the property to save.

state :  Object

The state object in to which to save the property values.

Returns

:Object

state

saveState

Saves the state of the object to the persistence store.

scrollBy ( deltaX, deltaY, animate )

Scrolls this Component by the passed delta values, optionally animating.

All of the following are equivalent:

 comp.scrollBy(10, 10, true);
 comp.scrollBy([10, 10], true);
 comp.scrollBy({ x: 10, y: 10 }, true);

Parameters

deltaX :  Number/Number[]/Object

Either the x delta, an Array specifying x and y deltas or an object with "x" and "y" properties.

deltaY :  Number/Boolean/Object

Either the y delta, or an animate flag or config object.

animate :  Boolean/Object

Animate flag/config object if the delta values were passed separately.

scrollTo ( x, y, [animate] )

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

Parameters

x :  Number

y :  Number

animate :  Boolean/Object (optional)

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

sequenceFx Object
chainable ch

Ensures that all effects queued after sequenceFx is called on this object are run in sequence. This is the opposite of syncFx.

Returns

:Object

this

setActive ( [active], [newActive] )
private pri

This method is called internally by Ext.ZIndexManager to signal that a floating Component has either been moved to the top of its zIndex stack, or pushed from the top of its zIndex stack.

If a Window is superceded by another Window, deactivating it hides its shadow.

This method also fires the activate or deactivate event depending on which action occurred.

Parameters

active :  Boolean (optional)

True to activate the Component, false to deactivate it.

Defaults to: false

newActive :  Ext.Component (optional)

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

setBox ( box ) : Ext.util.Positionable
chainable ch

Sets the element's box.

Parameters

box :  Object

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

Returns

:Ext.util.Positionable

this

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

name :  String/Object

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

value :  Object (optional)

The value to set for the name parameter.

Returns

:Ext.Base

this

setDock ( dock ) : Ext.Component
chainable ch

Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part of the dockedItems collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default)

Parameters

dock :  Object

The dock position.

Returns

:Ext.Component

this

setDocked ( dock ) : Ext.Component
deprecated dep

Sets the dock position of this component in its parent panel. Note that this only has effect if this item is part of the dockedItems collection of a parent that has a DockLayout (note that any Panel has a DockLayout by default)

Parameters

dock :  Object

The dock position.

Returns

:Ext.Component

this

Deprecated since version 5.0
Use setDock instead.

setFlex ( flex )
private pri

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

Parameters

flex :  Number

setLoading ( load ) : Ext.LoadMask

This method allows you to show or hide a LoadMask on top of this component.

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

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

Ext.view.Table however will direct a LoadMask to be rendered into the owning Ext.panel.Table.

Parameters

load :  Boolean/Object/String

True to show the default LoadMask, a config object that will be passed to the LoadMask constructor, or a message String to show. False to hide the current LoadMask.

Returns

:Ext.LoadMask

The LoadMask instance that has just been shown.

setLocalX ( x ) : Ext.util.Positionable

Sets the local x coordinate of this element using CSS style. When used on an absolute positioned element this method is symmetrical with getLocalX, but may not be symmetrical when used on a relatively positioned element.

Parameters

x :  Number

The x coordinate. A value of null sets the left style to 'auto'.

Returns

:Ext.util.Positionable

this

setLocalXY ( x, [y] ) : Ext.util.Positionable

Sets the local x and y coordinates of this element using CSS style. When used on an absolute positioned element this method is symmetrical with getLocalXY, but may not be symmetrical when used on a relatively positioned element.

Parameters

x :  Number/Array

The x coordinate or an array containing [x, y]. A value of null sets the left style to 'auto'

y :  Number (optional)

The y coordinate, required if x is not an array. A value of null sets the top style to 'auto'

Returns

:Ext.util.Positionable

this

setLocalY ( y ) : Ext.util.Positionable

Sets the local y coordinate of this element using CSS style. When used on an absolute positioned element this method is symmetrical with getLocalY, but may not be symmetrical when used on a relatively positioned element.

Parameters

y :  Number

The y coordinate. A value of null sets the top style to 'auto'.

Returns

:Ext.util.Positionable

this

setMasked ( isMasked ) :
chainable ch private pri

Set masked state for this Component.

Parameters

isMasked :  Boolean

True if masked, false otherwise.

Returns

:

setOverflowXY ( overflowX, overflowY ) : Ext.Component
chainable ch

Sets the overflow x/y on the content element of the component. The x/y overflow values can be any valid CSS overflow (e.g., 'auto' or 'scroll'). By default, the value is 'hidden'. Passing null for one of the values will erase the inline style. Passing undefined will preserve the current value.

Parameters

overflowX :  String

The overflow-x value.

overflowY :  String

The overflow-y value.

Returns

:Ext.Component

this

setPagePosition ( x, [y], [animate] ) : Ext.Component
chainable ch

Sets the page XY position of the component. To set the left and top instead, use setPosition. This method fires the event-move event.

Parameters

x :  Number/Number[]

The new x position or an array of [x,y].

y :  Number (optional)

The new y position.

animate :  Boolean/Object (optional)

True to animate the Component into its new position. You may also pass an animation configuration.

Returns

:Ext.Component

this

setPosition ( x, [y], [animate] ) : Ext.Component
chainable ch

Sets the left and top of the component. To set the page XY position instead, use setPagePosition. This method fires the event-move event.

Parameters

x :  Number/Number[]/Object

The new left, an array of [x,y], or animation config object containing x and y properties.

y :  Number (optional)

The new top.

animate :  Boolean/Object (optional)

If true, the Component is animated into its new position. You may also pass an animation configuration.

Returns

:Ext.Component

this

setScrollX ( x )

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

Parameters

x :  Number

setScrollY ( y )

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

Parameters

y :  Number

setSize ( width, height ) : Ext.Component
chainable ch

Sets the width and height of this Component. This method fires the resize event. This method can accept either width and height as separate arguments, or you can pass a size object like {width:10, height:20}.

Parameters

width :  Number/String/Object

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

  • A Number specifying the new width in pixels.
  • A String used to set the CSS width style.
  • A size object in the format {width: widthValue, height: heightValue}.
  • undefined to leave the width unchanged.

height :  Number/String

The new height to set (not required if a size object is passed as the first arg). This may be one of:

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

Returns

:Ext.Component

this

setVisible ( visible ) : Ext.Component
chainable ch

Convenience function to hide or show this component by Boolean.

Available since: 1.1.0

Parameters

visible :  Boolean

true to show, false to hide.

Returns

:Ext.Component

this

setX ( The ) : Ext.util.Positionable

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

Parameters

The :  Number

X position

Returns

:Ext.util.Positionable

this

setXY ( pos ) : Ext.util.Positionable

Sets the position of the DOM element in page coordinates.

Parameters

pos :  Number[]

Contains X & Y [x, y] values for new position (coordinates are page-based)

Returns

:Ext.util.Positionable

this

setY ( The ) : Ext.util.Positionable

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

Parameters

The :  Number

Y position

Returns

:Ext.util.Positionable

this

setupFramingTpl ( frameTpl )
private pri

Inject a reference to the function which applies the render template into the framing template. The framing template wraps the content.

Parameters

frameTpl :  Object

show ( [animateTarget], [callback], [scope] ) : Ext.Component
chainable ch

Shows this Component, rendering it first if autoRender or floating are true.

After being shown, a floating Component (such as a Ext.window.Window), is activated it and brought to the front of its z-index stack.

Parameters

animateTarget :  String/Ext.dom.Element (optional)

only valid for floating Components such as Ext.window.Windows or Ext.tip.ToolTips, or regular Components which have been configured with floating: true. The target from which the Component should animate from while opening.

Defaults to: null

callback :  Function (optional)

A callback function to call after the Component is displayed. Only necessary if animation was specified.

scope :  Object (optional)

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

Returns

:Ext.Component

this

showAt ( x, [y], [animate] ) : Ext.Component

Displays component at specific xy position. A floating component (like a menu) is positioned relative to its ownerCt if any. Useful for popping up a context menu:

listeners: {
    itemcontextmenu: function(view, record, item, index, event, options) {
        Ext.create('Ext.menu.Menu', {
            width: 100,
            height: 100,
            margin: '0 0 10 0',
            items: [{
                text: 'regular item 1'
            },{
                text: 'regular item 2'
            },{
                text: 'regular item 3'
            }]
        }).showAt(event.getXY());
    }
}

Parameters

x :  Number/Number[]

The new x position or array of [x,y].

y :  Number (optional)

The new y position

animate :  Boolean/Object (optional)

True to animate the Component into its new position. You may also pass an animation configuration.

Returns

:Ext.Component

this

showBy ( component, [position], [offsets] ) : Ext.Component
chainable ch

Shows this component by the specified Ext.Component or Ext.dom.Element. Used when this component is floating.

Parameters

component :  Ext.Component/Ext.dom.Element

The Ext.Component or Ext.dom.Element to show the component by.

position :  String (optional)

Alignment position as used by Ext.util.Positionable#getAlignToXY. Defaults to defaultAlign. See alignTo for possible values.

offsets :  Number[] (optional)

Alignment offsets as used by Ext.util.Positionable#getAlignToXY. See alignTo for possible values.

Returns

:Ext.Component

this

statics Ext.Class
protected pro

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

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

    constructor: function() {
        var statics = this.statics();

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self();   // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

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

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

alert(My.Cat.totalCreated);             // alerts 3

Returns

:Ext.Class

stopAnimation Ext.dom.Element
chainable ch

Stops any running effects and clears this object's internal effects queue if it contains any additional effects that haven't started yet.

Returns

:Ext.dom.Element

The Element

stopFx Ext.dom.Element
deprecated dep

Stops any running effects and clears this object's internal effects queue if it contains any additional effects that haven't started yet.

Returns

:Ext.dom.Element

The Element

Deprecated since version 4.0
Replaced by stopAnimation

suspendEvent ( eventName )

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to suspend.

suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended :  Boolean

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

syncFx Object
chainable ch

Ensures that all effects queued after syncFx is called on this object are run concurrently. This is the opposite of sequenceFx.

Returns

:Object

this

syncHidden
private pri

synchronizes the hidden state of this component with the state of its hierarchy

toBack Ext.Component
chainable ch

Sends this Component to the back of (lower z-index than) any other visible windows

Returns

:Ext.Component

this

toFront ( [preventFocus] ) : Ext.Component
chainable ch

Brings this floating Component to the front of any other visible, floating Components managed by the same Ext.ZIndexManager

If this Component is modal, inserts the modal mask just below this Component in the z-index stack.

Parameters

preventFocus :  Boolean (optional)

Specify true to prevent the Component from being focused.

Defaults to: false

Returns

:Ext.Component

this

translatePoints ( x, [y] ) : Object

Translates the passed page coordinates into left/top css values for the element

Parameters

x :  Number/Array

The page x or an array containing [x, y]

y :  Number (optional)

The page y, required if x is not an array

Returns

:Object

An object with left and top properties. e.g. {left: (value), top: (value)}

translateXY ( x, [y] ) : Object
private pri

Translates the passed page coordinates into x and y css values for the element

Parameters

x :  Number/Array

The page x or an array containing [x, y]

y :  Number (optional)

The page y, required if x is not an array

Returns

:Object

An object with x and y properties. e.g. {x: (value), y: (value)}

un ( eventName, fn, [scope] )

Shorthand for removeListener. Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the Ext.util.Observable#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 Ext.util.Observable#addListener or the listener will not be removed.

unmask

Removes the mask applied by mask

up ( [selector], [limit] ) : Ext.container.Container

Navigates up the ownership hierarchy searching for an ancestor Container which matches any passed selector or component.

Important. There is not a universal upwards navigation pointer. There are several upwards relationships such as the Ext.button.Button which activates a menu, or the Ext.menu.Item which activated a submenu, or the Ext.grid.column.Column which activated the column menu.

These differences are abstracted away by this method.

Example:

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

Parameters

selector :  String/Ext.Component (optional)

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

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

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

Returns

:Ext.container.Container

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

update ( htmlOrData, [loadScripts], [callback] )

Update the content area of a component.

Available since: 3.4.0

Parameters

htmlOrData :  String/Object

If this component has been configured with a template via the tpl config then it will use this argument as data to populate the template. If this component was not configured with a template, the components content area will be updated via Ext.Element update.

loadScripts :  Boolean (optional)

Only legitimate when using the html configuration.

Defaults to: false

callback :  Function (optional)

Only legitimate when using the html configuration. Callback to execute when scripts have finished loading.

updateBox ( box ) : Ext.Component
chainable ch

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

Parameters

box :  Object

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

Returns

:Ext.Component

this

updateFrame
private pri

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

updateLayout ( [options] )

Updates this component's layout. If this update affects this components ownerCt, that component's updateLayout method will be called to perform the layout instead. Otherwise, just this component (and its child items) will layout.

Parameters

options :  Object (optional)

An object with layout options.

defer :  Boolean

true if this layout should be deferred.

isRoot :  Boolean

true if this layout should be the root of the layout.

updateSession ( session )
private pri

Updates the session config.

Available since: 5.0.0

Parameters

session :  Ext.data.Session

updateViewModel ( viewModel )
private pri

Updates the viewModel config.

Available since: 5.0.0

Parameters

viewModel :  Ext.app.ViewModel

visitPostOrder ( selector, fn, [scope], [extraArgs] )

Traverses the tree rooted at this node in post-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node after being called on its children).

This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.

If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.

Parameters

selector :  Object

A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.

fn :  Function

The function to call. Return false to aborl the traverse.

node :  Object

The node being visited.

scope :  Object (optional)

The context (this reference) in which the function is executed.

extraArgs :  Array (optional)

A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.

visitPreOrder ( selector, fn, [scope], [extraArgs] )

Traverses the tree rooted at this node in pre-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node before being called on its children).

This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.

If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.

Parameters

selector :  Object

A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.

fn :  Function

The function to call. Return false to aborl the traverse.

node :  Object

The node being visited.

scope :  Object (optional)

The context (this reference) in which the function is executed.

extraArgs :  Array (optional)

A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.

Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

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

Parameters

config :  Object

mixinClass :  Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

addMember ( name, member ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

Returns

:

addMembers ( members, [isStatic], [privacy] ) :
chainable ch static sta

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat();
 kitty.meow();

Parameters

members :  Object

The members to add to this class.

isStatic :  Boolean (optional)

Pass true if the members are static.

Defaults to: false

privacy :  Boolean (optional)

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

Defaults to: false

Returns

:

addStatics ( members ) : Ext.Base
chainable ch static sta

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

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

Parameters

members :  Object

Returns

:Ext.Base

this

borrow ( fromClass, members ) : Ext.Base
static sta private pri

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

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base

this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Returns

:Object

the created instance.

createAlias ( alias, origin )
static sta

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

Get the current class' name in string format.

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

My.cool.Class.getName(); // 'My.cool.Class'

Returns

:String

className

mixin ( name, mixinClass ) :
chainable ch static sta private pri

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

override ( members ) : Ext.Base
chainable ch static sta

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

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

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Direct use of this method should be rare. Use Ext.define instead:

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

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

Parameters

members :  Object

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

Returns

:Ext.Base

this class

triggerExtended
static sta private pri

events

activate ( this, eOpts )

Fires after a Component has been visually activated.

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

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

add ( this, component, index, eOpts )

Fires after any Ext.Component is added or inserted into the container.

This event bubbles: 'add' will also be fired when Component is added to any of the child containers or their childern or ...

Available since: 2.3.0

Parameters

this :  Ext.container.Container

component :  Ext.Component

The component that was added

index :  Number

The index at which the component was added to the container's items collection

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

added ( this, container, pos, eOpts )

Fires after a Component had been added to a Container.

Available since: 3.4.0

Parameters

this :  Ext.Component

container :  Ext.container.Container

Parent Container

pos :  Number

position of Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

afterlayout ( this, layout, eOpts )

Fires when the components in this container are arranged by the associated layout manager.

Available since: 2.3.0

Parameters

this :  Ext.container.Container

layout :  Ext.layout.container.Container

The ContainerLayout implementation for this container

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

afterrender ( this, eOpts )

Fires after the component rendering is finished.

The afterrender event is fired after this Component has been rendered, been postprocessed by any afterRender method defined for the Component.

Available since: 3.4.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforeactivate ( this, eOpts )

Fires before a Component has been visually activated. Returning false from an event listener can prevent the activate from occurring.

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

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforeadd ( this, component, index, eOpts )

Fires before any Ext.Component is added or inserted into the container. A handler can return false to cancel the add.

Available since: 2.3.0

Parameters

this :  Ext.container.Container

component :  Ext.Component

The component being added

index :  Number

The index at which the component will be added to the container's items collection

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforedeactivate ( this, eOpts )

Fires before a Component has been visually deactivated. Returning false from an event listener can prevent the deactivate from occurring.

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

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforedestroy ( this, eOpts )

Fires before the component is method-destroyed. Return false from an event handler to stop the method-destroy.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforehide ( this, eOpts )

Fires before the component is hidden when calling the hide method. Return false from an event handler to stop the hide.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforeremove ( this, component, eOpts )

Fires before any Ext.Component is removed from the container. A handler can return false to cancel the remove.

Available since: 2.3.0

Parameters

this :  Ext.container.Container

component :  Ext.Component

The component being removed

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforerender ( this, eOpts )

Fires before the component is rendered. Return false from an event handler to stop the method-render.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforeshow ( this, eOpts )

Fires before the component is shown when calling the show method. Return false from an event handler to stop the show.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforestaterestore ( this, state, eOpts )

Fires before the state of the object is restored. Return false from an event handler to stop the restore.

Parameters

this :  Ext.state.Stateful

state :  Object

The hash of state values returned from the StateProvider. If this event is not vetoed, then the state object is passed to applyState. By default, that simply copies property values into this object. The method maybe overriden to provide custom state restoration.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

beforestatesave ( this, state, eOpts )

Fires before the state of the object is saved to the configured state provider. Return false to stop the save.

Parameters

this :  Ext.state.Stateful

state :  Object

The hash of state values. This is determined by calling getState() on the object. This method must be provided by the developer to return whatever representation of state is required, by default, Ext.state.Stateful has a null implementation.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

blur ( this, event, eOpts )

Fires when this Component loses focus.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The blur event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

boxready ( this, width, height, eOpts )

Fires one time - after the component has been laid out for the first time at its initial size.

Parameters

this :  Ext.Component

width :  Number

The initial width.

height :  Number

The initial height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

click ( this, e, eOpts )

Fires when the header is clicked. This event will not be fired if the click was on a Ext.panel.Tool

Parameters

this :  Ext.panel.Header

e :  Ext.event.Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

dblclick ( this, e, eOpts )

Fires when the header is double clicked. This event will not be fired if the click was on a Ext.panel.Tool

Parameters

this :  Ext.panel.Header

e :  Ext.event.Event

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

deactivate ( this, eOpts )

Fires after a Component has been visually deactivated.

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

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

destroy ( this, eOpts )

Fires after the component is method-destroyed.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

disable ( this, eOpts )

Fires after the component is disabled.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

enable ( this, eOpts )

Fires after the component is enabled.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

focus ( this, event, eOpts )

Fires when this Component receives focus.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focus event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

hide ( this, eOpts )

Fires after the component is hidden. Fires after the component is hidden when calling the hide method.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

move ( this, component, prevIndex, newIndex, eOpts )

Fires after any Ext.Component has changed its ordinal position within the container.

This event bubbles: 'move' will also be fired when Component is removed from any of the child containers or their children or ...

Parameters

this :  Ext.container.Container

component :  Ext.Component

The component that was moved

prevIndex :  Ext.Component

The previous ordinal position of the Component

newIndex :  Ext.Component

The new ordinal position of the Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

remove ( this, component, eOpts )

Fires after any Ext.Component is removed from the container.

This event bubbles: 'remove' will also be fired when Component is removed from any of the child containers or their children or ...

Available since: 2.3.0

Parameters

this :  Ext.container.Container

component :  Ext.Component

The component that was removed

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

removed ( this, ownerCt, eOpts )

Fires when a component is removed from an Ext.container.Container

Available since: 3.4.0

Parameters

this :  Ext.Component

ownerCt :  Ext.container.Container

Container which holds the component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

render ( this, eOpts )

Fires after the component markup is rendered.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

resize ( this, width, height, oldWidth, oldHeight, eOpts )

Fires after the component is resized. Note that this does not fire when the component is first laid out at its initial size. To hook that point in the life cycle, use the boxready event.

Parameters

this :  Ext.Component

width :  Number

The new width that was set.

height :  Number

The new height that was set.

oldWidth :  Number

The previous width.

oldHeight :  Number

The previous height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

show ( this, eOpts )

Fires after the component is shown when calling the show method.

Available since: 1.1.0

Parameters

this :  Ext.Component

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

staterestore ( this, state, eOpts )

Fires after the state of the object is restored.

Parameters

this :  Ext.state.Stateful

state :  Object

The hash of state values returned from the StateProvider. This is passed to applyState. By default, that simply copies property values into this object. The method maybe overridden to provide custom state restoration.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

statesave ( this, state, eOpts )

Fires after the state of the object is saved to the configured state provider.

Parameters

this :  Ext.state.Stateful

state :  Object

The hash of state values. This is determined by calling getState() on the object. This method must be provided by the developer to return whatever representation of state is required, by default, Ext.state.Stateful has a null implementation.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

theme variables

$scroll-indicator-background-color : color

The background color of scroll indicators when touch scrolling is enabled

Defaults to:

#000

$scroll-indicator-border-radius : Number

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

Defaults to:

3px

$scroll-indicator-margin : Number

The space between scroll indicators and the edge of their container

Defaults to:

2px

$scroll-indicator-opacity : Number

The opacity of scroll indicators when touch scrolling is enabled

Defaults to:

.5

$scroll-indicator-size : color

The background color of scroll indicators when touch scrolling is enabled

Defaults to:

6px

Ext JS 5.0.1