Ext.panel.Table

true to animate the transition when the panel is collapsed, false to skip the animation (defaults to true if the Ext.fx.Anim class is available, otherwise false). May also be specified as the animation duration in milliseconds.

Available since: 2.3.0

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: Ext 2

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

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

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

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

Available since: Ext 2

This config is intended mainly for non-floating Components which may or may not be shown. Instead of using renderTo in the configuration, and rendering upon construction, this allows a Component to render itself upon first show. If floating is true, the value of this config is omited 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.

This defaults to true for the Window class.

Defaults to: false

Available since: 4.0.0

true to use overflow:'auto' on the components layout element and show scroll bars automatically when necessary, false to clip any overflowing content.

Defaults to: false

Available since: 4.0.0

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: Ext 2

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

Defaults to: 'x-panel'

Available since: Ext 2

Overrides: Ext.container.AbstractContainer.baseCls

Convenience config. Short for 'Bottom Bar'.

bbar: [
  { xtype: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'bottom',
    items: [
        { xtype: 'button', text: 'Button 1' }
    ]
}]

Available since: 2.3.0

A shortcut to add or remove the border on the body of a panel. This only applies to a panel which has the frame configuration set to true.

Available since: Ext 2

A CSS class, space-delimited string of classes, or array of classes to be applied to the panel's body element. The following examples are all valid:

bodyCls: 'foo'
bodyCls: 'foo bar'
bodyCls: ['foo', 'bar']

Available since: 4.0.0

A shortcut for setting a padding style on the body element. The value can either be a number to be applied to all sides, or a normal css string describing padding.

Available since: 4.0.0

Custom CSS styles to be applied to the panel's body element, which can be supplied as a valid CSS style string, an object containing style property name/value pairs or a function that returns such a string or object. For example, these two formats are interpreted to be equivalent:

bodyStyle: 'background:#ffc; padding:10px;'

bodyStyle: {
    background: '#ffc',
    padding: '10px'
}

Available since: Ext 2

Specifies the border 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'.

Defaults to: true

Available since: Ext 2

Overrides: Ext.AbstractComponent.border

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

Defaults to: ['add', 'remove']

Available since: Ext 3

The alignment of any buttons added to this panel. Valid values are 'right', 'left' and 'center' (defaults to 'right' for buttons/fbar, 'left' for other toolbar types).

NOTE: The prefered way to specify toolbars is to use the dockedItems config. Instead of buttonAlign you would add the layout: { pack: 'start' | 'center' | 'end' } option to the dockedItem config.

Available since: 2.3.0

Convenience config used for adding buttons docked to the bottom of the panel. This is a synonym for the fbar config.

buttons: [
  { text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'bottom',
    ui: 'footer',
    defaults: {minWidth: minButtonWidth},
    items: [
        { xtype: 'component', flex: 1 },
        { xtype: 'button', text: 'Button 1' }
    ]
}]

The minButtonWidth is used as the default minWidth for each of the buttons in the buttons toolbar.

Available since: 2.3.0

An array describing the child elements of the Component. Each member of the array is an object with these properties:

• name - The property name on the Component for the child element.
• 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.

If the array member is a string, it is equivalent to { name: m, itemId: m }.

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

Ext.create('Ext.Component', {
    renderTo: Ext.getBody(),
    renderTpl: [
        '<h1 id="{id}-title">{title}</h1>',
        '<p>{msg}</p>',
    ],
    renderData: {
        title: "Error",
        msg: "Something went wrong"
    },
    childEls: ["title"],
    listeners: {
        afterrender: function(cmp){
            // After rendering the component will have a title property
            cmp.title.setStyle({color: "red"});
        }
    }
});

A more flexible, but somewhat slower, approach is renderSelectors.

Available since: 4.0.5

True to display the 'close' tool button and allow the user to close the window, false to hide the button and disallow closing the window.

By default, when close is requested by clicking the close button in the header, the close method will be called. This will destroy the Panel and its content meaning that it may not be reused.

To make closing a Panel hide the Panel so that it may be reused, set closeAction to 'hide'.

Defaults to: false

Available since: 3.4.0

The action to take when the close header tool is clicked:

• 'destroy' :

  remove the window from the DOM and destroy it and all descendant Components. The window will not be available to be redisplayed via the show method.

• 'hide' :

  hide the window by setting visibility to hidden and applying negative offsets. The window will be available to be redisplayed via the show method.

Note: This behavior has changed! setting does affect the close method which will invoke the approriate closeAction.

Defaults to: 'destroy'

Available since: 4.0.0

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: Ext 1

The direction to collapse the Panel when the toggle button is clicked.

Defaults to the headerPosition

Important: This config is ignored for collapsible Panels which are direct child items of a border layout.

Specify as 'top', 'bottom', 'left' or 'right'.

Available since: 4.0.0

true to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the panel's title bar, false to render it last.

Defaults to: true

Available since: 2.3.0

Important: this config is only effective for collapsible Panels which are direct child items of a border layout.

When not a direct child item of a border layout, then the Panel's header remains visible, and the body is collapsed to zero dimensions. If the Panel has no header, then a new header (orientated correctly depending on the collapseDirection) will be inserted to show a the title and a re- expand tool.

When a child item of a border layout, this config has two options:

• undefined/omitted

  When collapsed, a placeholder Header is injected into the layout to represent the Panel and to provide a UI with a Tool to allow the user to re-expand the Panel.

• header :

  The Panel collapses to leave its header visible as when not inside a border layout.

Available since: 4.0.0

true to render the panel collapsed, false to render it expanded.

Defaults to: false

Available since: 2.3.0

A CSS class to add to the panel's element after it has been collapsed.

Defaults to: 'collapsed'

Available since: 2.3.0

True to make the panel collapsible and have an expand/collapse toggle Tool added into the header tool button area. False to keep the panel sized either statically, or by an owning layout manager, with no toggle Tool.

See collapseMode and collapseDirection

Defaults to: false

Available since: 2.3.0

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

Available since: 4.0.0

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

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

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

Defaults to: 'dock'

Available since: 4.0.0

Overrides: Ext.AbstractComponent.componentLayout

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

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

Notes:

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

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

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

Available since: Ext 3

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

Available since: Ext 3

This object holds the default weights applied to dockedItems that have no weight. These start with a weight of 1, to allow negative weights to insert before top items and are odd numbers so that even weights can be used to get between different dock orders.

To make default docking order match border layout, do this:

Ext.panel.AbstractPanel.prototype.defaultDockWeights = { top: 1, bottom: 3, left: 5, right: 7 };

Changing these defaults as above or individually on this object will effect all Panels. To change the defaults on a single panel, you should replace the entire object:

initComponent: function () {
    // NOTE: Don't change members of defaultDockWeights since the object is shared.
    this.defaultDockWeights = { top: 1, bottom: 3, left: 5, right: 7 };

    this.callParent();
}

To change only one of the default values, you do this:

initComponent: function () {
    // NOTE: Don't change members of defaultDockWeights since the object is shared.
    this.defaultDockWeights = Ext.applyIf({ top: 10 }, this.defaultDockWeights);

    this.callParent();
}

Defaults to: {top: 1, left: 3, right: 5, bottom: 7}

Available since: 4.0.2

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

Defaults to: 'panel'

Available since: Ext 2

This option is a means of applying default settings to all added items whether added through the items config or via the 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: Ext 2

True to disable the component.

Defaults to: false

Available since: Ext 2

CSS class to add when the Component is disabled. Defaults to 'x-item-disabled'.

Defaults to: 'x-item-disabled'

Available since: 4.0.0

A component or series of components to be added as docked items to this panel. The docked items can be docked to either the top, right, left or bottom of a panel. This is typically used for things like toolbars or tab bars:

var panel = new Ext.panel.Panel({
    dockedItems: [{
        xtype: 'toolbar',
        dock: 'top',
        items: [{
            text: 'Docked to the top'
        }]
    }]
});

Available since: 4.0.0

Overrides: Ext.panel.AbstractPanel.dockedItems

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

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

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

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

Defaults to: false

Available since: 4.0.0

Overrides: Ext.AbstractComponent.draggable

Convenience config used for adding items to the bottom of the panel. Short for Footer Bar.

fbar: [
  { type: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'bottom',
    ui: 'footer',
    defaults: {minWidth: minButtonWidth},
    items: [
        { xtype: 'component', flex: 1 },
        { xtype: 'button', text: 'Button 1' }
    ]
}]

The minButtonWidth is used as the default minWidth for each of the buttons in the fbar.

Available since: 3.4.0

Important: This config is only effective for collapsible Panels which are direct child items of a border layout.

true to allow clicking a collapsed Panel's placeholder to display the Panel floated above the layout, false to force the user to fully expand a collapsed region by clicking the expand button to see it again.

Defaults to: true

Available since: 4.0.0

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

Components such as Windows and Menus are floating by default.

Floating Components that are programatically rendered will register themselves with the global ZIndexManager

Floating Components as child items of a Container

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

When configured as floating, Components acquire, at render time, a ZIndexManager which manages a stack of related floating Components. The ZIndexManager brings a single floating Component to the top of its stack when the Component's toFront method is called.

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

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

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

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

Defaults to: false

Available since: 4.0.0

Overrides: Ext.AbstractComponent.floating

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

Defaults to: true

Available since: 4.0.0

True to apply a frame to the panel.

Defaults to: false

Available since: 2.3.0

Overrides: Ext.AbstractComponent.frame

True to apply a frame to the panel panels header (if 'frame' is true).

Defaults to: true

Available since: 4.0.0

Specify as 'top', 'bottom', 'left' or 'right'.

Defaults to: 'top'

Available since: 4.0.0

The height of this component in pixels.

Available since: 4.0.0

True to hide the component.

Defaults to: false

Available since: Ext 2

true to hide the expand/collapse toggle button when collapsible == true, false to display it.

Defaults to: false

Available since: 2.3.0

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: Ext 1

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

Defaults to: ''

Available since: Ext 3

CSS class for icon in header. Used for displaying an icon to the left of a title.

Available since: 2.3.0

The unique id of this component instance.

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

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

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

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

Note: to access the container of a Component see ownerCt.

Defaults to an auto-assigned id.

Available since: Ext 1

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

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: to access the container of an item see ownerCt.

Available since: Ext 3

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:

• A Component
• A Component configuration object

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.

Available since: Ext 2

Convenience config. Short for 'Left Bar' (left-docked, vertical toolbar).

lbar: [
  { xtype: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'left',
    items: [
        { xtype: 'button', text: 'Button 1' }
    ]
}]

Available since: 4.0.0

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

DOM events from Ext JS Components

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

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

Available since: 1.1.0

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

Available since: 4.0.0

Only valid when a sibling element of a Splitter within a VBox or HBox layout.

Specifies that if an immediate sibling Splitter is moved, the Component on the other side is resized, and this Component maintains its configured flex value.

Defaults to: false

Available since: 4.0.0

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

Available since: 4.0.0

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

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

Available since: 4.0.0

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

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

Available since: 4.0.0

Minimum width of all footer toolbar buttons in pixels. If set, this will be used as the default value for the Ext.button.Button.minWidth config of each Button added to the footer toolbar via the fbar or buttons configurations. It will be ignored for buttons that have a minWidth configured some other way, e.g. in their own config object or via the defaults of their parent container.

Defaults to: 75

Available since: 2.3.0

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

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

Available since: 4.0.0

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

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

Available since: 4.0.0

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: Ext 2

True to overlap the header in a panel over the framing of the panel itself. This is needed when frame:true (and is done automatically for you). Otherwise it is undefined. If you manually add rounded corners to a panel header which does not have frame:true, this will need to be set to true.

Available since: 4.0.1

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

Available since: 4.0.0

Important: This config is only effective for collapsible Panels which are direct child items of a border layout when not using the 'header' collapseMode.

Optional. A Component (or config object for a Component) to show in place of this Panel when this Panel is collapsed by a border layout. Defaults to a generated Header containing a Tool to re-expand the Panel.

Available since: 4.0.0

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

Available since: Ext 2

Prevent a Header from being created and shown.

Defaults to: false

Available since: 4.0.0

Convenience config. Short for 'Right Bar' (right-docked, vertical toolbar).

rbar: [
  { xtype: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'right',
    items: [
        { xtype: 'button', text: 'Button 1' }
    ]
}]

Available since: 4.0.0

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

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

See renderSelectors and childEls for usage examples.

Available since: Ext JS 4.0.7

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

For a faster, but less flexible, alternative that achieves the same end result (properties for child elements on the Component after render), see childEls and addChildEls.

Available since: 4.0.0

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

Notes:

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

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

See render also.

Available since: Ext 2

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

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

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

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

Defaults to: ['<div id="{id}-body" class="{baseCls}-body<tpl if="bodyCls"> {bodyCls}</tpl>', ' {baseCls}-body-{ui}<tpl if="uiCls">', '<tpl for="uiCls"> {parent.baseCls}-body-{parent.ui}-{.}</tpl>', '</tpl>"<tpl if="bodyStyle"> style="{bodyStyle}"</tpl>>', '</div>']

Available since: 4.0.0

Overrides: Ext.AbstractComponent.renderTpl

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

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

Available since: 4.0.0

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

Defaults to: 'all'

Available since: 4.0.0

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

Defaults to: 100

Available since: 4.0.6

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'

Available since: 4.0.0

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.

Available since: 4.0.0

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

See stateful for an explanation of saving and restoring state.

Available since: 4.0.0

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()+(1000*60*60*24*7)), //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. By default, this function does nothing. The developer must provide an implementation which returns an object hash which represents the restorable state of the 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 more behaviour.

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

Defaults to: true

Available since: 4.0.0

A custom style specification to be applied to this component's Element. Should be a valid argument to Ext.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: Ext 1

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

Defaults to: 'x-html'

Available since: 4.0.0

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

Defaults to: false

Available since: 4.0.0

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

Available since: 4.0.0

Convenience config. Short for 'Top Bar'.

tbar: [
  { xtype: 'button', text: 'Button 1' }
]

is equivalent to

dockedItems: [{
    xtype: 'toolbar',
    dock: 'top',
    items: [
        { xtype: 'button', text: 'Button 1' }
    ]
}]

Available since: 2.3.0

The title text to be used to display in the panel header. When a title is specified the Ext.panel.Header will automatically be created and displayed unless preventHeader is set to true.

Defaults to: ''

Available since: 2.3.0

true to allow expanding and collapsing the panel (when collapsible = true) by clicking anywhere in the header bar, false) to allow it only by clicking to tool butto).

Defaults to: false

Available since: 2.3.0

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

Defaults to: true

Available since: 4.0.0

An array of Ext.panel.Tool configs/instances to be added to the header tool area. The tools are stored as child components of the header container. They can be accessed using down and {query}, as well as the other component methods. The toggle tool is automatically created if collapsible is set to true.

Note that, apart from the toggle tool which is provided when a panel is collapsible, these tools only provide the visual button. Any required functionality must be provided by adding handlers that implement the necessary behavior.

Example usage:

tools:[{
    type:'refresh',
    tooltip: 'Refresh form Data',
    // hidden:true,
    handler: function(event, toolEl, panel){
        // refresh logic
    }
},
{
    type:'help',
    tooltip: 'Get Help',
    handler: function(event, toolEl, panel){
        // show help here
    }
}]

Available since: 2.3.0

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: Ext 3

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: Ext 3

A set style for a component. Can be a string or an Array of multiple strings (UIs)

Defaults to: 'default'

Available since: 4.0.0

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

Defaults to: []

Available since: 4.0.0

The width of this component in pixels.

Available since: 4.0.0

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

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

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

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

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

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

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

Available since: Ext 2

Defaults to: true

Available since: 4.0.0

Available since: 4.0.0

Defaults to: 'presentation'

Available since: 4.0.0

Defaults to: /^((\w+-)|(ext-comp-))\d{4,}$/i

Available since: 4.0.0

Defaults to: []

Available since: 4.0.0

The number of component layout calls made on this object.

Defaults to: 0

Available since: 4.0.3

If this Panel is configured draggable, this property will contain an instance of Ext.dd.DragSource which handles dragging the Panel.

The developer must provide implementations of the abstract methods of Ext.dd.DragSource in order to supply behaviour for each stage of the drag/drop process. See draggable.

Available since: 2.3.0

Read-only property indicating whether or not the component can be dragged

Defaults to: false

Available since: 4.0.0

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal|freezeEvent)$/

Available since: 4.0.0

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

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

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

For example, the dropdown BoundList of a ComboBox which is in a Window will have the Window as its floatParent

See floating and zIndexManager

Available since: 4.0.0

Defaults to: Ext.baseCSSPrefix + 'frame'

Available since: 4.0.0

Defaults to: {tl: [], tc: [], tr: [], ml: [], mc: [], mr: [], bl: [], bc: [], br: []}

Available since: 4.0.2

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

Available since: 4.0.5

Read-only property indicating the width of any framing elements which were added within the encapsulating element to provide graphical, rounded borders. See the frame config.

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

Available since: 4.0.0

• top : Number

  The width of the top framing element in pixels.

• right : Number

  The width of the right framing element in pixels.

• bottom : Number

  The width of the bottom framing element in pixels.

• left : Number

  The width of the left framing element in pixels.

Defaults to: ['<table><tbody>', '<tpl if="top">', '<tr>', '<tpl if="left"><td id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl></tpl>" style="background-position: {tl}; padding-left:{frameWidth}px" role="presentation"></td></tpl>', '<td id="{fgid}TC" class="{frameCls}-tc {baseCls}-tc {baseCls}-{ui}-tc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl></tpl>" style="background-position: {tc}; height: {frameWidth}px" role="presentation"></td>', '<tpl if="right"><td id="{fgid}TR" class="{frameCls}-tr {baseCls}-tr {baseCls}-{ui}-tr<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl></tpl>" style="background-position: {tr}; padding-left: {frameWidth}px" role="presentation"></td></tpl>', '</tr>', '</tpl>', '<tr>', '<tpl if="left"><td id="{fgid}ML" class="{frameCls}-ml {baseCls}-ml {baseCls}-{ui}-ml<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl></tpl>" style="background-position: {ml}; padding-left: {frameWidth}px" role="presentation"></td></tpl>', '<td id="{fgid}MC" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl></tpl>" style="background-position: 0 0;" role="presentation"></td>', '<tpl if="right"><td id="{fgid}MR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl></tpl>" style="background-position: {mr}; padding-left: {frameWidth}px" role="presentation"></td></tpl>', '</tr>', '<tpl if="bottom">', '<tr>', '<tpl if="left"><td id="{fgid}BL" class="{frameCls}-bl {baseCls}-bl {baseCls}-{ui}-bl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl></tpl>" style="background-position: {bl}; padding-left: {frameWidth}px" role="presentation"></td></tpl>', '<td id="{fgid}BC" class="{frameCls}-bc {baseCls}-bc {baseCls}-{ui}-bc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl></tpl>" style="background-position: {bc}; height: {frameWidth}px" role="presentation"></td>', '<tpl if="right"><td id="{fgid}BR" class="{frameCls}-br {baseCls}-br {baseCls}-{ui}-br<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl></tpl>" style="background-position: {br}; padding-left: {frameWidth}px" role="presentation"></td></tpl>', '</tr>', '</tpl>', '</tbody></table>']

Available since: 4.0.0

Defaults to: ['<tpl if="top">', '<tpl if="left"><div id="{fgid}TL" class="{frameCls}-tl {baseCls}-tl {baseCls}-{ui}-tl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tl</tpl></tpl>" style="background-position: {tl}; padding-left: {frameWidth}px" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}TR" class="{frameCls}-tr {baseCls}-tr {baseCls}-{ui}-tr<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tr</tpl></tpl>" style="background-position: {tr}; padding-right: {frameWidth}px" role="presentation"></tpl>', '<div id="{fgid}TC" class="{frameCls}-tc {baseCls}-tc {baseCls}-{ui}-tc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-tc</tpl></tpl>" style="background-position: {tc}; height: {frameWidth}px" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>', '<tpl if="left"><div id="{fgid}ML" class="{frameCls}-ml {baseCls}-ml {baseCls}-{ui}-ml<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-ml</tpl></tpl>" style="background-position: {ml}; padding-left: {frameWidth}px" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}MR" class="{frameCls}-mr {baseCls}-mr {baseCls}-{ui}-mr<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mr</tpl></tpl>" style="background-position: {mr}; padding-right: {frameWidth}px" role="presentation"></tpl>', '<div id="{fgid}MC" class="{frameCls}-mc {baseCls}-mc {baseCls}-{ui}-mc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-mc</tpl></tpl>" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '<tpl if="bottom">', '<tpl if="left"><div id="{fgid}BL" class="{frameCls}-bl {baseCls}-bl {baseCls}-{ui}-bl<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bl</tpl></tpl>" style="background-position: {bl}; padding-left: {frameWidth}px" role="presentation"></tpl>', '<tpl if="right"><div id="{fgid}BR" class="{frameCls}-br {baseCls}-br {baseCls}-{ui}-br<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-br</tpl></tpl>" style="background-position: {br}; padding-right: {frameWidth}px" role="presentation"></tpl>', '<div id="{fgid}BC" class="{frameCls}-bc {baseCls}-bc {baseCls}-{ui}-bc<tpl if="uiCls"><tpl for="uiCls"> {parent.baseCls}-{parent.ui}-{.}-bc</tpl></tpl>" style="background-position: {bc}; height: {frameWidth}px" role="presentation"></div>', '<tpl if="right"></div></tpl>', '<tpl if="left"></div></tpl>', '</tpl>']

Available since: 4.0.0

Deprecate 5.0

Defaults to: false

Available since: 4.0.0

End Definitions

Defaults to: true

Available since: 4.0.0

Defaults to: true

Available since: 4.0.0

Defaults to: true

Available since: 4.0.0

The MixedCollection containing all the child items of this container.

Available since: Ext 2

The number of container layout calls made on this object.

Defaults to: 0

Available since: 4.0.3

Flag set by the container layout to which this Component is added. If the layout manages this Component's height, it sets the value to 1. If it does NOT manage the height, it sets it to 2. If the layout MAY affect the height, but only if the owning Container has a fixed height, this is set to 0.

Available since: 4.0.2

Flag set by the container layout to which this Component is added. If the layout manages this Component's width, it sets the value to 1. If it does NOT manage the width, it sets it to 2. If the layout MAY affect the width, but only if the owning Container has a fixed width, this is set to 0.

Available since: 4.0.2

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 its disabled. Components like FieldContainer, FieldSet, Field, Button, Tab override this property to false since they want to implement custom disable logic.

Defaults to: true

Available since: 4.0.0

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate)$/

Available since: 4.0.0

Defaults to: false

Available since: 4.0.0

This Component's owner Container (is set automatically when this Component is added to a Container). Read-only.

Note: to access items within the Container see itemId.

Available since: Ext 2

Read-only property indicating whether or not the component has been rendered.

Defaults to: false

Available since: Ext 1

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

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

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

        return this;
    },

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


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

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

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

Available since: 4.0.0

Defaults to: /\s+/

Available since: 4.0.0

Defaults to: /^\s+|\s+$/g

Available since: 4.0.0

Defaults to: 0

Available since: 4.0.0

Only present for floating Components after they have been rendered.

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

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

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

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

For floating Components which are added to a Container, the ZIndexManager is acquired from the first ancestor Container found which is floating, or if not found the global ZIndexManager is used.

See floating and floatParent

Available since: 4.0.0

Adds Component(s) to this Container.

Description:

• Fires the beforeadd event before adding.
• The Container's default config values will be applied accordingly (see defaults for details).
• Fires the add event after the component has been added.

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
tb.add([{text:'Button 1'}, {text:'Button 2'}]); // add multiple items. (defaultType for Toolbar is 'button')

Warning:

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

Available since: Ext 2

Parameters

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

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

Returns

• Ext.Component[]/Ext.Component

  The Components that were added.

Adds each argument passed to this method to the childEls array.

Available since: 4.0.5

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

Available since: Ext 2

Parameters

• cls : String

  The CSS class name to add

Returns

• Ext.Component

  Returns the Component to allow method chaining.

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

Available since: 4.0.0

Parameters

• cls : String

  The CSS class name to add

Returns

• Ext.Component

  Returns the Component to allow method chaining.

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

Available since: 4.0.0

Parameters

• cls : String/String[]

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

• skip : Object

  (Boolean) skip True to skip adding it to the class and do it later (via the return)

Adds docked item(s) to the panel.

Available since: 4.0.0

Parameters

• component : Object/Object[]

  The Component or array of components to add. The components must include a 'dock' parameter on each component to indicate where it should be docked ('top', 'right', 'bottom', 'left').

• pos : Number (optional)

  The index at which the Component will be added

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

Available since: 1.1.0

Parameters

• o : Object/String

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

  this.addEvents({
      storeloaded: true,
      storecleared: true
  });
  

• more : String... (optional)

  Additional event names if multiple event names are being passed as separate parameters. Usage:

  this.addEvents('storeloaded', 'storecleared');
  

Available since: 4.0.6

Parameters

• members : Object

Returns

• Ext.Base

  this

Appends an event handler to this object.

Available since: 4.0.0

Parameters

• eventName : String

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

• fn : Function

  The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

• scope : Object (optional)

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

• options : Object (optional)

  An object containing handler configuration.

  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.

  • target : Observable

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

  • element : String

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

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

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

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

  Attaching multiple handlers in 1 call

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

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

Overrides: Ext.util.Observable.addListener

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

Available since: 4.0.0

Parameters

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

• opt : Object (optional)

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

Available since: 4.0.0

Add events that will trigger the state to be saved.

Available since: 4.0.0

Parameters

• events : String/String[]

  The event name or an array of event names.

Available since: 2.3.0

Parameters

• tool : Object

Template method to be implemented in subclasses to add their tools after the collapsible tool.

Available since: 4.0.0

inherit docs

Method which adds a specified UI + uiCls to the components element. Can be overridden to remove the UI from more than just the components element.

Available since: 4.0.0

Parameters

• ui : String

  The UI to remove from the element

Overrides: Ext.AbstractComponent.addUIClsToElement

inherit docs

Method which adds a specified UI to the components element.

Available since: 4.0.0

Parameters

• force : Object

Overrides: Ext.AbstractComponent.addUIToElement

private

Available since: 4.0.0

Parameters

• x : Object
• y : Object

Available since: 4.0.0

Parameters

• cb : Object
• scope : Object

Available since: 4.0.0

Parameters

• layout : Object

Available since: 2.3.0

Overrides: Ext.container.AbstractContainer.afterRender

Template method called after a Component has been positioned.

Available since: 4.0.0

Parameters

• ax : Object
• ay : Object

Available since: 4.0.0

Parameters

• animateTarget : Object
• cb : Object
• scope : Object

Aligns this floating Component to the specified element

Available since: 4.0.0

Parameters

• element : Ext.Component/Ext.Element/HTMLElement/String

  The element or Ext.Component to align to. If passing a component, it must be a omponent instance. If a string id is passed, it will be used as an element id.

• position : String (optional)

  The position to align to (see Ext.Element.alignTo for more details).

  Defaults to: "tl-bl?"

• offsets : Number[] (optional)

  Offset the positioning by [x, y]

Returns

• Ext.Component

  this

• process the passed fx configuration.

Available since: 4.0.0

Parameters

• config : Object

Perform custom animation on this object.

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

The sole parameter is an object which specifies start property values, end property values, and properties which describe the timeline. Of the properties listed below, only to is mandatory.

Properties include

• from
  An object which specifies start values for the properties being animated. If not supplied, properties are animated from current settings. The actual properties which may be animated depend upon ths object being animated. See the sections below on Element and Component animation.
• to
  An object which specifies end values for the properties being animated.
• duration
  The duration in milliseconds for which the animation will run.
• easing
  A string value describing an easing type to modify the rate of change from the default linear to non-linear. Values may be one of:

  • ease
  • easeIn
  • easeOut
  • easeInOut
  • backIn
  • backOut
  • elasticIn
  • elasticOut
  • bounceIn
  • bounceOut
• keyframes
  This is an object which describes the state of animated properties at certain points along the timeline. it is an object containing properties who's names are the percentage along the timeline being described and who's values specify the animation state at that point.
• listeners
  This is a standard listeners configuration object which may be used to inject behaviour at either the beforeanimate event or the afteranimate event.

Animating an Element

• x
  The page X position in pixels.
• y
  The page Y position in pixels
• left
  The element's CSS left value. Units must be supplied.
• top
  The element's CSS top value. Units must be supplied.
• width
  The element's CSS width value. Units must be supplied.
• height
  The element's CSS height value. Units must be supplied.
• scrollLeft
  The element's scrollLeft value.
• scrollTop
  The element's scrollLeft value.
• opacity
  The element's opacity value. This must be a value between 0 and 1.

Be aware than animating an Element which is being used by an Ext Component without in some way informing the Component about the changed element state will result in incorrect Component behaviour. This is because the Component will be using the old state of the element. To avoid this problem, it is now possible to directly animate certain properties of Components.

Animating a Component

• 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.
• width
  The Component's width 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%',
        margins: '5 0 5 5',
        flex: 1
    }, {
        title: 'Left: 66%',
        margins: '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.

Available since: 4.0.0

Parameters

• config : Object

  An object containing properties which describe the animation's start and end states, and the timeline of the animation.

Returns

• Object

  this

Overrides: Ext.util.Animate.animate

Available since: 4.0.0

Parameters

• config : Object

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

Available since: 4.0.0

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

Available since: 4.0.0

Parameters

• adjWidth : Number

  The box-adjusted width that was set

• adjHeight : Number

  The box-adjusted height that was set

• isSetSize : Boolean

  Whether or not the height/width are stored on the component permanently

• callingContainer : Ext.Component

  Container requesting sent the layout. Only used when isSetSize is false.

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

Available since: 4.0.0

Available since: 4.0.0

private

Available since: 4.0.0

Returns

• Ext.Component

  this

Available since: 4.0.0

Bubbles up the component/container heirarchy, 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.

Available since: 3.4.0

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

Call the original method that was previously overridden with override

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

        return this;
    }
});

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

        var instance = this.callOverridden();

        alert("Meeeeoooowwww");

        return instance;
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Available since: 4.0.0

Parameters

• args : Array/Arguments

  The arguments, either an array or the arguments object

Returns

• Object

  Returns the result after calling the overridden method

Call the parent's overridden method. For example:

Ext.define('My.own.A', {
    constructor: function(test) {
        alert(test);
    }
});

Ext.define('My.own.B', {
    extend: 'My.own.A',

    constructor: function(test) {
        alert(test);

        this.callParent([test + 1]);
    }
});

Ext.define('My.own.C', {
    extend: 'My.own.B',

    constructor: function() {
        alert("Going to call parent's overriden constructor...");

        this.callParent(arguments);
    }
});

var a = new My.own.A(1); // alerts '1'
var b = new My.own.B(1); // alerts '1', then alerts '2'
var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                         // alerts '2', then alerts '3'

Available since: 4.0.0

Parameters

• args : Array/Arguments

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

Returns

• Object

  Returns the result from the superclass' method

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: Ext 2

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

  this

Center this Component in its container.

Available since: 4.0.0

Returns

• Ext.Component

  this

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

Available since: 4.0.0

Parameters

• selector : String (optional)

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

Returns

• Object

  Ext.Component

Remove any references to elements added via renderSelectors/childEls

Available since: 4.0.6

Removes all listeners for this object including the managed listeners

Available since: 4.0.0

Removes all managed listeners for this object.

Available since: 4.0.0

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

Available since: 2.3.0

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

Closes the Panel. By default, this method, removes it from the DOM, destroys the Panel object and all its descendant Components. The beforeclose event is fired before the close happens and will cancel the close action if it returns false.

Note: This method is also affected by the closeAction setting. For more explicit control use destroy and hide methods.

Available since: 4.0.0

Collapses the panel body so that the body becomes hidden. Docked Components parallel to the border towards which the collapse takes place will remain visible. Fires the beforecollapse event which will cancel the collapse action if it returns false.

Available since: 2.3.0

Parameters

• direction : String

  . The direction to collapse towards. Must be one of

  • Ext.Component.DIRECTION_TOP
  • Ext.Component.DIRECTION_RIGHT
  • Ext.Component.DIRECTION_BOTTOM
  • Ext.Component.DIRECTION_LEFT
• animate : Boolean (optional)

  True to animate the transition, else false (defaults to the value of the animCollapse panel config)

Returns

• Ext.panel.Panel

  this

Available since: 4.0.0

Parameters

• plugin : Object

Ensures that the plugins array contains fully constructed plugin instances. This converts any configs into their appropriate instances.

Available since: 4.0.5

Continue to fire event.

Available since: Ext JS 4.0.7

Parameters

• eventName : String
• args : Array
• bubbles : Boolean

Available since: 4.0.0

Parameters

• config : Object
• defaultType : Object

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

Available since: 4.0.0

Parameters

• newName : Object

Returns

• Function

Available since: 4.0.0

Destroys the Component.

Available since: Ext 1

Overrides: Ext.state.Stateful.destroy

Disable the component.

Available since: Ext 1

Parameters

• silent : Boolean (optional)

  Passing true will supress the 'disable' event from being fired.

  Defaults to: false

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

Available since: 4.0.0

private

Available since: 4.0.0

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

Available since: 4.0.0

Parameters

• width : Object
• height : Object
• isSetSize : Object
• callingContainer : Object

Returns

• Ext.container.Container

  this

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.

Available since: 4.0.0

Parameters

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

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

Manually force this container's layout to be recalculated. The framework uses this internally to refresh layouts form most cases.

Available since: Ext 2

Returns

• Ext.container.Container

  this

Available since: 4.0.0

Parameters

• component : Object
• autoDestroy : Object

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

Available since: 4.0.0

Parameters

• selector : String (optional)

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

Returns

• Object

  Ext.Component

Enable the component

Available since: Ext 1

Parameters

• silent : Boolean (optional)

  Passing true will supress the 'enable' event from being fired.

  Defaults to: false

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.override(Ext.form.field.Base, {
    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
        this.enableBubble('change');
    }),

    //  We know that we want Field's events to bubble directly to the FormPanel.
    getBubbleTarget : function() {
        if (!this.formPanel) {
            this.formPanel = this.findParentByType('form');
        }
        return this.formPanel;
    }
});

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

Available since: 3.4.0

Parameters

• events : String/String[]

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

Expands the panel body so that it becomes visible. Fires the beforeexpand event which will cancel the expand action if it returns false.

Available since: 2.3.0

Parameters

• animate : Boolean (optional)

  True to animate the transition, else false (defaults to the value of the animCollapse panel config)

Returns

• Ext.panel.Panel

  this

This method finds the topmost active layout who's processing will eventually determine the size and position of this Component.

This method is useful when dynamically adding Components into Containers, and some processing must take place after the final sizing and positioning of the Component has been performed.

Available since: 4.0.0

Returns

• Ext.Component

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

Available since: 2.3.0

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

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

See also the up method.

Available since: 2.3.0

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

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.

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to fire.

• args : Object...

  Variable number of parameters are passed to handlers.

Returns

• Boolean

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

private

Available since: 4.0.0

Try to focus this component.

Available since: 1.1.0

Parameters

• selectText : Boolean (optional)

  If applicable, true to also select the text in this component

• delay : Boolean/Number (optional)

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

Returns

• Ext.Component

  this

Forces this component to redo its componentLayout.

Available since: 4.0.2

Deprecate 5.0

Available since: 4.0.0

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

Available since: 4.0.0

Returns

• Ext.fx.Anim/Boolean

  Anim if element has active effects, else false

Available since: 4.0.0

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

Available since: 4.0.0

Parameters

• local : Boolean (optional)

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

  Defaults to: false

Returns

• Object

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

Gets the bubbling parent for an Observable

Available since: Ext JS 4.0.7

Returns

• Ext.util.Observable

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

private

Provides the link for Observable's fireEvent method to bubble up the ownership hierarchy.

Available since: Ext 3

Returns

• Ext.container.Container

  the Container which owns this Component.

Overrides: Ext.AbstractComponent.getBubbleTarget

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

Available since: 4.0.0

Parameters

• el : Ext.Element/HTMLElement/String

  The element to test (or ID of element).

Returns

• Ext.Component

  The child item which contains the passed element.

Attempts a default component lookup (see Ext.container.Container.getComponent). If the component is not found in the normal items, the dockedItems are searched and the matched component (if any) returned (see getDockedComponent). Note that docked items will only be matched by component id or itemId -- if you pass a numeric index only non-docked child components will be searched.

Available since: Ext 2

Parameters

• comp : String/Number

  The component id, itemId or position to find

Returns

• Ext.Component

  The component (if found)

Overrides: Ext.container.AbstractContainer.getComponent

• used as the key lookup function for the items collection

Available since: 4.0.0

Parameters

• comp : Object

Available since: 4.0.0

Gets the x/y offsets to constrain this float

Available since: 4.0.1

Parameters

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

  The Element or Region into which this Component is to be constrained.

Returns

• Number[]

  The x/y constraints

private

Available since: 3.4.0

Overrides: Ext.Component.getContentTarget

Finds a docked component by id, itemId or position. Also see getDockedItems

Available since: 4.0.0

Parameters

• comp : String/Number

  The id, itemId or position of the docked component (see getComponent for details)

Returns

• Ext.Component

  The docked component (if found)

Retrieve an array of all currently docked Components.

Available since: 4.0.0

Parameters

• cqSelector : String

  A ComponentQuery selector string to filter the returned items.

Returns

• Ext.Component[]

  An array of components.

Available since: 4.0.0

Retrieves the top level element representing this component.

Available since: Ext 1

Returns

• Ext.core.Element

Overrides: Ext.AbstractComponent.getEl

Available since: 4.0.0

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

Available since: 4.0.0

Returns

• Ext.Element

  the focus holing element.

Available since: 4.0.0

Available since: 4.0.0

Parameters

• frameInfo : Object

Available since: 4.0.0

Parameters

• table : Object

Available since: 4.0.0

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

Available since: 4.0.0

Returns

• Number

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

Available since: 1.1.0

Returns

• String

Overrides: Ext.AbstractComponent.getId

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

Available since: 4.0.0

Parameters

• position : String/Number/Ext.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

Available since: 4.0.0

private

Available since: 2.3.0

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

Available since: 4.0.0

Returns

• Ext.layout.container.AbstractContainer

  The layout

Gets the Ext.ComponentLoader for this Component.

Available since: 4.0.0

Returns

• Ext.ComponentLoader

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

Available since: 4.0.0

Parameters

• d : Object

Include margins

Available since: 4.0.0

Retrieves a plugin by its pluginId which has been bound to this component.

Available since: 4.0.0

Parameters

• pluginId : Object

Returns

• Ext.AbstractPlugin

  plugin instance.

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

Available since: 4.0.0

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

Deprecate 5.0

Available since: 4.0.0

Available since: 4.0.0

Available since: 4.0.0

Parameters

• deep : Object

Overrides: Ext.container.AbstractContainer.getRefItems

Deprecate 5.0

Available since: 4.0.0

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

Available since: 4.0.0

Returns

• Object

  An object containing the element's size {width: (element width), height: (element height)}

Gets the state id for this object.

Available since: 4.0.0

Returns

• String

  The state id, null if not found.

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

Available since: 4.0.0

Overrides: Ext.panel.AbstractPanel.getTargetEl

Available since: 4.0.0

Parameters

• name : Object

Deprecate 5.0

Available since: 4.0.0

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

Available since: 4.0.0

Returns

• Number

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'

Available since: 2.3.0

Returns

• String

  The xtype

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

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

Example usage:

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

Available since: Ext 2

Returns

• String

  The xtype hierarchy string

Finds the ancestor Container responsible for allocating zIndexes for the passed Component.

That will be the outermost floating Container (a Container which has no ownerCt and has floating:true).

If we have no ancestors, or we walk all the way up to the document body, there's no zIndexParent, and the global Ext.WindowManager will be used.

Available since: 4.0.0

private - used for dragging

Available since: 4.0.0

Parameters

• cls : Object

private - helper function for ghost

Available since: 4.0.0

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

Available since: 4.0.0

Returns

• Ext.fx.Anim/Boolean

  Anim if element has active effects, else false

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

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to check for

Returns

• Boolean

  True if the event is being listened for, else false

Checks if there is currently a specified uiCls

Available since: 4.0.0

Parameters

• cls : String

  The cls to check

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

Available since: 1.1.0

Parameters

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

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

  Defaults to: null

• callback : Function (optional)

  A callback function to call after the Component is hidden.

• scope : Object (optional)

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

Returns

• Ext.Component

  this

Available since: 4.0.0

Overrides: Ext.Component.initAria

Parse the bodyCls config if available to create a comma-delimited string of CSS classes to be applied to the body element.

Available since: 4.0.0

Returns

• String

  The CSS class(es)

Parses the bodyStyle config if available to create a style string that will be applied to the body element. This also includes bodyPadding and bodyBorder if available.

Available since: 4.0.0

Returns

• String

  A CSS style string with body styles, padding and border.

Creates an array of class names from the configurations to add to this Component's el on render.

Private, but (possibly) used by ComponentQuery for selection by class name if Component is not rendered.

Available since: 4.0.0

Returns

• String[]

  An array of class names with which the Component's element will be rendered.

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

        return this;
    }
});

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

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

Available since: 4.0.0

Parameters

• config : Object

Returns

• Object

  mixins The mixin prototypes as key - value pairs

Adds ctCls to container.

Available since: 4.0.0

Parameters

• container : Object

Returns

• Ext.Element

  The initialized container

Initializes this components contents. It checks for the properties html, contentEl and tpl/data.

Available since: 4.0.0

private

Available since: 2.3.0

Overrides: Ext.Component.initDraggable

Available since: 4.0.0

Available since: 4.0.0

Available since: 4.0.0