<ExtSurface/> xtype: surface premium

alwaysOnTop : Boolean / Number

bindable bind

<ExtSurface alwaysOnTop="true" />

let element = document.body.querySelector('ExtSurface');
element.alwaysOnTop = true;
let alwaysOnTop = element.alwaysOnTop;

A flag indicating that this component should be above its floated siblings.

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:

null

Available since: 6.2.0

ariaAttributes : Object

bindable bind

<ExtSurface ariaAttributes="{ }" />

let element = document.body.querySelector('ExtSurface');
element.ariaAttributes = { };
let ariaAttributes = element.ariaAttributes;

An object containing ARIA attributes to be set on this Component's ARIA element. Use this to set the attributes that cannot be determined by the Component's state, such as aria-live, aria-flowto, etc.

Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.

ariaDescribedBy : String

<ExtSurface ariaDescribedBy="value" />

let element = document.body.querySelector('ExtSurface');
element.ariaDescribedBy = 'value';
let ariaDescribedBy = element.ariaDescribedBy;

DOM selector for a child element that is to be used as description for this Component, set in aria-describedby attribute. The selector works the same way as ariaLabelledBy.

ariaLabel : String

<ExtSurface ariaLabel="value" />

let element = document.body.querySelector('ExtSurface');
element.ariaLabel = 'value';
let ariaLabel = element.ariaLabel;

ARIA label for this Component. It is best to use ariaLabelledBy option instead, because screen readers prefer aria-labelledby attribute to aria-label. ariaLabel and ariaLabelledBy config options are mutually exclusive.

ariaLabelledBy : String

<ExtSurface ariaLabelledBy="value" />

let element = document.body.querySelector('ExtSurface');
element.ariaLabelledBy = 'value';
let ariaLabelledBy = element.ariaLabelledBy;

DOM selector for a child element that is to be used as label for this Component, set in aria-labelledby attribute. If the selector is by id, the label element can be any existing element, not necessarily a child of the main Component element.

ariaLabelledBy and ariaLabel config options are mutually exclusive, and ariaLabelledBy has the higher precedence.

border : Boolean

bindable bind

<ExtSurface border="true" />

let element = document.body.querySelector('ExtSurface');
element.border = true;
let border = element.border;

Enables or disables bordering on this component. The following values are accepted:

• null or `true (default): Do nothing and allow the border to be specified by the theme.
• false: suppress the default border provided by the theme.

Please note that enabling bordering via this config will not add a border-color or border-style CSS property to the component; you provide the border-color and border-style via CSS rule or style configuration (if not already provide by the theme).

Defaults to:

null

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

bindable bind

<ExtSurface constrainTo="value" />

let element = document.body.querySelector('ExtSurface');
element.constrainTo = 'value';
let constrainTo = element.constrainTo;

The element into which floated or positioned items constrain their position.

Defaults to the parent container for positioned components, and to the viewport for floated components.

Defaults to:

null

disabled : Boolean

bindable bind

<ExtSurface disabled="true" />

let element = document.body.querySelector('ExtSurface');
element.disabled = true;
let disabled = element.disabled;

Whether or not this component is disabled

Defaults to:

null

flex : Number / String / Object

bindable bind

<ExtSurface flex="value" />

let element = document.body.querySelector('ExtSurface');
element.flex = 'value';
let flex = element.flex;

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

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

When supplied as a string or number this option supports the same syntax as CSS href="https://developer.mozilla.org/en-US/docs/Web/CSS/flex" class="external-link" target="_blank">https://developer.mozilla.org/en-US/docs/Web/CSS/flex flex. For example:

flex: '1 2 auto'

sets flex-grow property to 0, flex-shrink to 2 and flex-basis to 'auto'.

The default flex-shrink value for box layout items is set to 0 in the stylesheet, which is different from the browser's default flex-shrink value of 1. This accommodates the majority use case for applications since where non-flexed components are typically not expected to shrink smaller than their default size.

For convenience when only a single number is supplied it is used as the value for both flex-grow and flex-shrink, for example flex: 3 is the same as flex: '3 3'

An object form with camel-cased names is also accepted:

flex: {
    grow: 1,
    shrink: 2,
    basis: 'auto'
}

When the object form is supplied shrink always defaults to 0 regardless of the value of grow.

Although 'auto' is the default value for flex-basis, flex-basis defaults to 0% when flex is supplied as a single numeric or string value (e.g. flex: 1). If this behavior is not desired either explicitly set flex-basis to 'auto' or use the object form to set only grow and/or shrink:

flex: {
    grow: 2
}

floated : Boolean

bindable bind

<ExtSurface floated="true" />

let element = document.body.querySelector('ExtSurface');
element.floated = true;
let floated = element.floated;

A Component may be floated above all other components in the application. This means that the component is absolutely positioned, and will move to the front and occlude other sibling floated component if clicked.

A Floated component may have floated descendants. It will bring these decendants to the front with it when brought to the front of its sibling floated components.

By default, descendant floated components are all positioned using the viewport coordinate system. To make a floating component a positioning parent for descendants, and have the ancestors positioned relatively, configure the parent floated component with cfg-relative: true.

Defaults to:

null

Available since: 6.2.0

focusCls : String

<ExtSurface focusCls="value" />

let element = document.body.querySelector('ExtSurface');
element.focusCls = 'value';
let focusCls = element.focusCls;

CSS class that will be added to focused component's focusClsEl, and removed when component blurs.

Defaults to:

'x-focused'

height : Number / String

bindable bind

<ExtSurface height="value" />

let element = document.body.querySelector('ExtSurface');
element.height = 'value';
let height = element.height;

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

Defaults to:

null

hidden : Boolean

bindable bind

<ExtSurface hidden="true" />

let element = document.body.querySelector('ExtSurface');
element.hidden = true;
let hidden = element.hidden;

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

Defaults to true for floated Components.

Defaults to:

null

id : String

bindable bind

<ExtSurface id="value" />

let element = document.body.querySelector('ExtSurface');
element.id = 'value';
let id = element.id;

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 Ext.ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The <ExtContainer/> class contains shortcut methods to query its descendant Components by selector.

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

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

Defaults to an auto-assigned id.

itemId : String

bindable bind

<ExtSurface itemId="value" />

let element = document.body.querySelector('ExtSurface');
element.itemId = 'value';
let itemId = element.itemId;

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

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

keyMap : Object

bindable bind

<ExtSurface keyMap="{ }" />

let element = document.body.querySelector('ExtSurface');
element.keyMap = { };
let keyMap = element.keyMap;

An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.

The handler descriptor can be simply the handler function (either the literal function or the method name), or it can be an object with these properties:

• handler: The function or its name to call to handle the event.
• scope: The this pointer context (can be "this" or "controller").
• event: An optional override of the key event to which to listen.

Important: Calls to setKeyMap do not replace the entire keyMap but instead update the provided mappings. That is, unless null is passed as the value of the keyMap which will clear the keyMap of all entries.

Properties

scope : String

The default scope to apply to key handlers which do not specify a scope. This is processed the same way as the scope of cfg-listeners. It defaults to the "controller", but using 'this' means that an instance method will be used.

keyMapEnabled : Boolean

bindable bind

<ExtSurface keyMapEnabled="true" />

let element = document.body.querySelector('ExtSurface');
element.keyMapEnabled = true;
let keyMapEnabled = element.keyMapEnabled;

Enables or disables processing keys in the keyMap. This value starts as null and if it is null when initKeyMap is called, it will automatically be set to true. Since initKeyMap is called by Ext.Component at the proper time, this is not something application code normally handles.

Defaults to:

null

listeners : Object

bindable bind

<ExtSurface listeners="{ }" />

let element = document.body.querySelector('ExtSurface');
element.listeners = { };
let listeners = element.listeners;

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

let element = document.body.querySelector('ExtSurface');
element.setListeners(listeners);

margin : Number / String

<ExtSurface margin="value" />

let element = document.body.querySelector('ExtSurface');
element.margin = 'value';
let margin = element.margin;

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

name : String

<ExtSurface name="value" />

let element = document.body.querySelector('ExtSurface');
element.name = 'value';
let name = element.name;

Name for the widget to be used with Ext.Container#lookupName et al.

Defaults to:

null

plugins : Object / String / Object[] / String[]

bindable bind

<ExtSurface plugins="value" />

let element = document.body.querySelector('ExtSurface');
element.plugins = 'value';
let plugins = element.plugins;

An object or array of objects that will provide custom functionality for this component. If a string is provided or a string is one of the elements of the array, that string is treated as the type alias. For example, "listpaging" is the type alias for Ext.plugin.ListPaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

Plugins should derive from Ext.plugin.Abstract but this is not required. The only requirement for a valid plugin is that it contain an init() method that accepts a reference to the owning 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.

Example code

A plugin by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: 'listpaging'
 });

Multiple plugins by alias:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

Single plugin by class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         type: 'listpaging',
         autoPaging: true
     }
 });

Multiple plugins by type and class name with config options:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: [{
         xclass: 'Ext.plugin.PullRefresh',
         pullRefreshText: 'Pull to refresh...'
     }, {
         type: 'listpaging',
         autoPaging: true
     }]
 });

relative : Boolean

bindable bind

<ExtSurface relative="true" />

let element = document.body.querySelector('ExtSurface');
element.relative = true;
let relative = element.relative;

Only valid when a component is cfg-floated

Configure this as true if you require descendant floated components to be positioned relative to this component's coordinate space, not the viewport's coordinate space.

Note: The coordinate space is this Component's encapsulating element's area. Not that of the inner element in which static child items are rendered by the layout.

Defaults to:

null

Available since: 6.2.0

renderTo : Ext.dom.Element

<ExtSurface renderTo="value" />

let element = document.body.querySelector('ExtSurface');
element.renderTo = 'value';
let renderTo = element.renderTo;

Optional element to render this Component to. Not required if this component is an item of a Container of a Container.

Defaults to:

null

shadow : Boolean

bindable bind

<ExtSurface shadow="true" />

let element = document.body.querySelector('ExtSurface');
element.shadow = true;
let shadow = element.shadow;

Configure as true for the component to have a drop shadow. 'false' will suppress any default shadow. By default the theme will determine the presence of a shadow.

Defaults to:

null

Available since: 6.2.0

shim : Boolean

bindable bind

<ExtSurface shim="true" />

let element = document.body.querySelector('ExtSurface');
element.shim = true;
let shim = element.shim;

Only valid when a component is cfg-floated

Configure as true for the component to use an <iframe> as an underlay to ensure certain non-standard browser plugins are occluded by this component.

Defaults to:

null

Available since: 6.2.0

style : String / Object

bindable bind

<ExtSurface style="value" />

let element = document.body.querySelector('ExtSurface');
element.style = 'value';
let style = element.style;

Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.

You can pass either a string syntax:

style: 'background:red'

Or by using an object:

style: {
    background: 'red'
}

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

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

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

Defaults to:

null

toFrontOnShow : Boolean

bindable bind

<ExtSurface toFrontOnShow="true" />

let element = document.body.querySelector('ExtSurface');
element.toFrontOnShow = true;
let toFrontOnShow = element.toFrontOnShow;

True to automatically call toFront when a cfg-floated Component is shown.

Defaults to:

true

touchAction : Object

<ExtSurface touchAction="{ }" />

let element = document.body.querySelector('ExtSurface');
element.touchAction = { };
let touchAction = element.touchAction;

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

Keys in this object are touch action names, and values are false to disable a touch action or true to enable it. Accepted keys are:

• panX
• panY
• pinchZoom
• doubleTapZoom

All touch actions are enabled (true) by default, so it is usually only necessary to specify which touch actions to disable. For example, the following disables only horizontal scrolling and pinch-to-zoom on the component's main element:

touchAction: {
    panX: false,
    pinchZoom: false
}

Touch actions can be specified on reference elements using the reference element name, for example:

// disables horizontal scrolling on the main element, and double-tap-zoom
// on the child element named "body"
touchAction: {
    panY: false
    body: {
        doubleTapZoom: false
    }
}

The primary motivation for setting the touch-action of an element is to prevent the browser's default handling of a gesture such as pinch-to-zoom, or drag-to-scroll, so that the application can implement its own handling of that gesture on the element. Suppose, for example, a component has a custom drag handler on its element and wishes to prevent horizontal scrolling of its container while it is being dragged:

Defaults to:

null

ui : String / String[]

<ExtSurface ui="value" />

let element = document.body.querySelector('ExtSurface');
element.ui = 'value';
let ui = element.ui;

The ui or uis to be used on this Component

When a ui is configured, CSS class names are added to the element, created by appending the ui name(s) to each classCls and/or baseCls.

Defaults to:

null

userCls : String / String[]

<ExtSurface userCls="value" />

let element = document.body.querySelector('ExtSurface');
element.userCls = 'value';
let userCls = element.userCls;

One or more CSS classes to add to the component's primary element. This config is intended solely for use by the component instantiator (the "user"), not by derived classes.

Defaults to:

null

width : Number / String

bindable bind

<ExtSurface width="value" />

let element = document.body.querySelector('ExtSurface');
element.width = 'value';
let width = element.width;

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

Defaults to:

null

x : Number

bindable bind

<ExtSurface x="10" />

let element = document.body.querySelector('ExtSurface');
element.x = 10;
let x = element.x;

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

y : Number

bindable bind

<ExtSurface y="10" />

let element = document.body.querySelector('ExtSurface');
element.y = 10;
let y = element.y;

Only valid when a component is cfg-floated

The x position at which to position this component. This is usually viewport-relative. But if there is a relative: true ancestor, it will be relative to that.

Defaults to:

0

factoryConfig : Object

<ExtSurface factoryConfig="{ }" />

let element = document.body.querySelector('ExtSurface');
element.factoryConfig = { };
let factoryConfig = element.factoryConfig;

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

focusClsEl : Ext.dom.Element

<ExtSurface focusClsEl="value" />

let element = document.body.querySelector('ExtSurface');
element.focusClsEl = 'value';
let focusClsEl = element.focusClsEl;

The element that will have the focusCls applied when component's focusEl is focused.

focusEl : Ext.dom.Element

<ExtSurface focusEl="value" />

let element = document.body.querySelector('ExtSurface');
element.focusEl = 'value';
let focusEl = element.focusEl;

The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.

Defaults to:

'el'

isObservable : Boolean

<ExtSurface isObservable="true" />

let element = document.body.querySelector('ExtSurface');
element.isObservable = true;
let isObservable = element.isObservable;

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

Defaults to:

true

addAfterListener

let element = document.body.querySelector('ExtSurface');
element.addAfterListener();

Alias for onAfter.

addBeforeListener

let element = document.body.querySelector('ExtSurface');
element.addBeforeListener();

Alias for onBefore.

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

let element = document.body.querySelector('ExtSurface');
let addListener = element.addListener(eventName, fn, scope, options, order);

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, 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,
    select: this.onSelect,
    viewready: this.onViewReady,
    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},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

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

 panel.body.un(...)

false

'current'

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

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Returns

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

Ext.destroy(this.btnListeners);

this.btnListeners.destroy();

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

let element = document.body.querySelector('ExtSurface');
let addManagedListener = element.addManagedListener(item, ename, fn, scope, options);

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

Returns

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

Ext.destroy(this.btnListeners);

this.btnListeners.destroy();

addPlugin ( plugin )

let element = document.body.querySelector('ExtSurface');
element.addPlugin(plugin);

Adds a plugin. For example:

 list.addPlugin('pullrefresh');

Or:

 list.addPlugin({
     type: 'pullrefresh',
     pullRefreshText: 'Pull to refresh...'
 });

Available since: 6.2.0

Parameters

clearListeners

let element = document.body.querySelector('ExtSurface');
element.clearListeners();

Removes all listeners for this object including the managed listeners

clearManagedListeners

let element = document.body.querySelector('ExtSurface');
element.clearManagedListeners();

Removes all managed listeners for this object.

destroyPlugin ( plugin ) : Ext.plugin.Abstract

let element = document.body.querySelector('ExtSurface');
let destroyPlugin = element.destroyPlugin(plugin);

Removes and destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

Returns

enableBubble ( eventNames )

let element = document.body.querySelector('ExtSurface');
element.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

findPlugin ( type ) : Ext.plugin.Abstract

let element = document.body.querySelector('ExtSurface');
let findPlugin = element.findPlugin(type);

Retrieves plugin by its type alias. For example:

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: ['listpaging', 'pullrefresh']
 });

 list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');

Note: See also getPlugin.

Available since: 6.2.0

Parameters

Returns

fireEvent ( eventName, args ) : Boolean

let element = document.body.querySelector('ExtSurface');
let fireEvent = element.fireEvent(eventName, args);

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

Returns

fireEventArgs ( eventName, args ) : Boolean

let element = document.body.querySelector('ExtSurface');
let fireEventArgs = element.fireEventArgs(eventName, args);

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

Returns

fireEventedAction ( eventName, args, fn, [scope], [fnArgs] )

let element = document.body.querySelector('ExtSurface');
element.fireEventedAction(eventName, args, fn, scope, fnArgs);

Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.

Parameters

focus ( [selectText] ) : Boolean

let element = document.body.querySelector('ExtSurface');
let focus = element.focus(selectText);

Try to focus this component.

If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.

Parameters

Returns

getInherited ( [inner] ) : Object

let element = document.body.querySelector('ExtSurface');
let getInherited = element.getInherited(inner);

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

Available since: 5.0.0

Parameters

Returns

getInheritedConfig ( property, [skipThis] ) : Mixed

let element = document.body.querySelector('ExtSurface');
let getInheritedConfig = element.getInheritedConfig(property, skipThis);

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

Returns

getParent Ext.Component

let element = document.body.querySelector('ExtSurface');
let getParent = element.getParent();

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

Returns

getPlugin ( id ) : Ext.plugin.Abstract

let element = document.body.querySelector('ExtSurface');
let getPlugin = element.getPlugin(id);

Retrieves a plugin by its id.

 var list = Ext.create({
     xtype: 'list',
     itemTpl: '<div class="item">{title}</div>',
     store: 'Items',

     plugins: {
         xclass: 'Ext.plugin.PullRefresh',
         id: 'foo'
     }
 });

 list.getPlugin('foo').setPullRefreshText('Pull to refresh...');

Note: See also findPlugin.

Available since: 6.2.0

Parameters

Returns

getTabIndex Number

let element = document.body.querySelector('ExtSurface');
let getTabIndex = element.getTabIndex();

Return the actual tabIndex for this Focusable.

Returns

hasListener ( eventName ) : Boolean

let element = document.body.querySelector('ExtSurface');
let hasListener = element.hasListener(eventName);

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

Returns

hasParent Boolean

let element = document.body.querySelector('ExtSurface');
let hasParent = element.hasParent();

Returns true if this component has a parent.

Returns

is Boolean

template tpl

let element = document.body.querySelector('ExtSurface');
let is = element.is();

Selector processing function for use by nextSibling,previousibling, nextNode,and previousNode, to filter candidate nodes.

The base implementation returns true. Classes which mix in Traversable may implement their own implementations. @link{Ext.Widget} does this to implement Ext.ComponentQuery based filterability.

Returns

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

isAncestor ( possibleDescendant )

let element = document.body.querySelector('ExtSurface');
element.isAncestor(possibleDescendant);

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

Parameters

isDescendantOf ( ancestor ) : Boolean

let element = document.body.querySelector('ExtSurface');
let isDescendantOf = element.isDescendantOf(ancestor);

Determines whether this component is the descendant of a passed component.

Parameters

Returns

isFocusable ( [deep] ) : Boolean

let element = document.body.querySelector('ExtSurface');
let isFocusable = element.isFocusable(deep);

Determine if this Focusable can receive focus at this time.

Note that Containers can be non-focusable themselves while delegating focus treatment to a child Component; see <ExtContainer/> for more information.

Parameters

Returns

isSuspended ( [event] ) : Boolean

let element = document.body.querySelector('ExtSurface');
let isSuspended = element.isSuspended(event);

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

Parameters

Returns

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

let element = document.body.querySelector('ExtSurface');
let mon = element.mon(item, ename, fn, scope, options);

Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Ext.define('Foo', {
    extend: 'Ext.Component',

    initComponent: function () {
        this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
        this.callParent();
    }
});

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (MyApp.SomeGlobalSharedMenu) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

Parameters

Returns

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

Ext.destroy(this.btnListeners);

this.btnListeners.destroy();

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

let element = document.body.querySelector('ExtSurface');
element.mun(item, ename, fn, scope);

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

Parameters

nextNode ( [selector] ) : Ext.Component

let element = document.body.querySelector('ExtSurface');
let nextNode = element.nextNode(selector);

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

Returns

nextSibling ( [selector] ) : Ext.Component

let element = document.body.querySelector('ExtSurface');
let nextSibling = element.nextSibling(selector);

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

Returns

on ( eventName, [fn], [scope], [options], [order] ) : Object

let element = document.body.querySelector('ExtSurface');
let on = element.on(eventName, fn, scope, options, order);

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

myGridPanel.on("itemclick", this.onItemClick, 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,
    select: this.onSelect,
    viewready: this.onViewReady,
    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},
    viewready: {fn: panel.onViewReady, scope: panel}
});

Names of methods in a specified scope may also be used:

myGridPanel.on({
    cellclick: {fn: 'onCellClick', scope: this, single: true},
    viewready: {fn: 'onViewReady', scope: panel}
});

Parameters

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

 panel.body.un(...)

false

'current'

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

grid.on({
    itemclick: 'onItemClick',
    itemcontextmenu: grid.onItemContextmenu,
    destroy: {
        fn: function () {
            // function called within the 'altCmp' scope instead of grid
        },
        scope: altCmp // unique scope for the destroy handler
    },
    scope: grid       // default scope - provided for example clarity
});

var panel = Ext.create({
    xtype: 'panel',
    renderTo: document.body,
    title: 'Delegate Handler Example',
    frame: true,
    height: 220,
    width: 220,
    html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
});

// The click handler will only be called when the click occurs on the
// delegate: h1.myTitle ("h1" tag with class "myTitle")
panel.on({
    click: function (e) {
        console.log(e.getTarget().innerHTML);
    },
    element: 'body',
    delegate: 'h1.myTitle'
 });

Returns

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

Ext.destroy(this.btnListeners);

this.btnListeners.destroy();

onAfter ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ExtSurface');
element.onAfter(eventName, fn, scope, options);

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

onBefore ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ExtSurface');
element.onBefore(eventName, fn, scope, options);

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

Same as addListener with order set to 'before'.

Parameters

previousNode ( [selector] ) : Ext.Component

let element = document.body.querySelector('ExtSurface');
let previousNode = element.previousNode(selector);

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

Returns

previousSibling ( [selector] ) : Ext.Component

let element = document.body.querySelector('ExtSurface');
let previousSibling = element.previousSibling(selector);

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

Returns

relayEvents ( origin, events, [prefix] ) : Object

let element = document.body.querySelector('ExtSurface');
let relayEvents = element.relayEvents(origin, events, prefix);

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

this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Returns

this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Ext.destroy(this.storeRelayers);

removeAfterListener

let element = document.body.querySelector('ExtSurface');
element.removeAfterListener();

Alias for unAfter.

removeBeforeListener

let element = document.body.querySelector('ExtSurface');
element.removeBeforeListener();

Alias for unBefore.

removeListener ( eventName, fn, [scope] )

let element = document.body.querySelector('ExtSurface');
element.removeListener(eventName, fn, scope);

Removes an event handler.

Parameters

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

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

let element = document.body.querySelector('ExtSurface');
element.removeManagedListener(item, ename, fn, scope);

Removes listeners that were added by the mon method.

Parameters

removePlugin ( plugin, [destroy] ) : Ext.plugin.Abstract

let element = document.body.querySelector('ExtSurface');
let removePlugin = element.removePlugin(plugin, destroy);

Removes and (optionally) destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

Parameters

Returns

resumeEvent ( eventName )

let element = document.body.querySelector('ExtSurface');
element.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

resumeEvents ( [discardQueue] )

let element = document.body.querySelector('ExtSurface');
element.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

setListeners

setTabIndex ( newTabIndex )

let element = document.body.querySelector('ExtSurface');
element.setTabIndex(newTabIndex);

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

Parameters

suspendEvent ( eventName )

let element = document.body.querySelector('ExtSurface');
element.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

suspendEvents ( queueSuspended )

let element = document.body.querySelector('ExtSurface');
element.suspendEvents(queueSuspended);

Suspends the firing of all events. (see resumeEvents)

Parameters

un ( eventName, fn, [scope] )

let element = document.body.querySelector('ExtSurface');
element.un(eventName, fn, scope);

Shorthand for removeListener. Removes an event handler.

Parameters

var listeners = cmp.on({
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide,
    destroyable: true
});

// Remove listeners
listeners.destroy();
// or
cmp.un(
    scope: cmp,
    afterrender: cmp.onAfterrender,
    beforehide: cmp.onBeforeHide
);

panel.on({
    element: 'body',
    click: 'onBodyCLick'
});

panel.body.un({
    click: 'onBodyCLick'
});

unAfter ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ExtSurface');
element.unAfter(eventName, fn, scope, options);

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

unBefore ( eventName, fn, [scope], [options] )

let element = document.body.querySelector('ExtSurface');
element.unBefore(eventName, fn, scope, options);

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

up ( [selector], [limit] ) : Ext.Container

let element = document.body.querySelector('ExtSurface');
let up = element.up(selector, limit);

Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.

Example:

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

Parameters

Returns