<ext-lockedgrid/> Ext.grid.locked.Grid

activeChildTabIndex : Number

immutable imm

<ext-lockedgrid activeChildTabIndex="10" />

let element = document.body.querySelector('ext-lockedgrid');
element.activeChildTabIndex = 10;
let activeChildTabIndex = element.activeChildTabIndex;

DOM tabIndex attribute to set on the active Focusable child of this container when using the "Roaming tabindex" technique.

Defaults to:

0

activeItem : <ext-component/> / Object / String / Number

<ext-lockedgrid activeItem="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.activeItem = 'value';
let activeItem = element.activeItem;

The item from the cfg-items collection that will be active first. This is usually only meaningful in a Ext.layout.Card, where only one item can be active at a time. If passed a string, it will be assumed to be a Ext.ComponentQuery selector. A number will reference an index or a <ext-component/> instance may be passed as well. An object config will be created as a new component.

Defaults to:

0

alignSelf : String

<ext-lockedgrid alignSelf="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.alignSelf = 'value';
let alignSelf = element.alignSelf;

Specifies the self alignment of this widget in a box layout

Defaults to:

null

allowFocusingDisabledChildren : Boolean

immutable imm

<ext-lockedgrid allowFocusingDisabledChildren="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.allowFocusingDisabledChildren = true;
let allowFocusingDisabledChildren = element.allowFocusingDisabledChildren;

Set this to true to enable focusing disabled child items via keyboard.

Defaults to:

false

alwaysOnTop : Boolean / Number

<ext-lockedgrid alwaysOnTop="true" />

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

false

Available since: 6.2.0

anchor : Boolean

<ext-lockedgrid anchor="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.anchor = true;
let anchor = element.anchor;

Configure true to show an anchor element pointing to the target component when this Panel is floating and shown by another component.

Defaults to:

false

ariaAttributes : Object

<ext-lockedgrid ariaAttributes="{ }" />

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

Defaults to:

null

ariaDescribedBy : String

immutable imm

<ext-lockedgrid ariaDescribedBy="value" />

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

immutable imm

<ext-lockedgrid ariaLabel="value" />

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

immutable imm

<ext-lockedgrid ariaLabelledBy="value" />

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

ariaRole : String

readonly ro

<ext-lockedgrid ariaRole="value" />

let element = document.body.querySelector('ext-lockedgrid');
let ariaRole = element.ariaRole;

ARIA role for this Component, defaults to no role. With no role, no other ARIA attributes are set.

autoDestroy : Boolean

<ext-lockedgrid autoDestroy="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.autoDestroy = true;
let autoDestroy = element.autoDestroy;

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

Defaults to:

true

autoSize : Boolean

<ext-lockedgrid autoSize="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.autoSize = true;
let autoSize = element.autoSize;

May be set to false for improved layout performance if auto-sizing is not required.

Some versions of Safari, both desktop and mobile, have very slow performance if the application has deeply nested containers due to the following WebKit bug: https://bugs.webkit.org/show_bug.cgi?id=150445

Applications that experience performance issues in the affected versions of Safari may need to turn off autoSizing globally for all <ext-container/> instances by placing the following override in the application's "overrides" directory:

Ext.define('MyApp.overrides.Container', {
    override: 'Ext.Container',
    config: {
        autoSize: false
    }
});

Once auto-sizing support has turned off by default, it can be selectively turned back on only on those container instances that explicitly need auto-sizing behavior by setting autoSize to true.

This option can also be used to allow items to be sized in percentage units as a workaround for the following browser bug: https://bugs.webkit.org/show_bug.cgi?id=137730

To illustrate, the following example should render a 200px by 200px green box (the container) with a yellow box inside of it (the child item). The child item's height and width are both set to '50%' so the child should render exactly 100px by 100px in size.

Ext.create({
    xtype: 'container',
    renderTo: Ext.getBody(),
    height: 200,
    width: 200,
    style: 'background: green',
    items: [{
        xtype: 'component',
        style: 'background: yellow',
        height: '50%',
        width: '50%'
    }]
});

All browsers except for Safari render the previous example correctly, but Safari does not assign a height to the component. To make percentage-sized items work in Safari, simply set autoSize to false on the container.

Since the underlying implementation works by absolutely positioning the container's body element, this option can only be used when the container is not "shrink wrapping" the content in either direction. When autoSize is set to false, shrink wrapped dimension(s) will collapse to 0.

Defaults to:

true

axisLock : Boolean

<ext-lockedgrid axisLock="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.axisLock = true;
let axisLock = element.axisLock;

If true, then, when showBy or alignTo fallback on constraint violation only takes place along the major align axis.

That is, if alignment "l-r" is being used, and axisLock: true is used, then if constraints fail, only fallback to "r-l" is considered.

Defaults to:

null

bbar : Object / Object[]

<ext-lockedgrid bbar="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.bbar = { };
let bbar = element.bbar;

Convenience config. Short for 'Bottom Bar'.

is equivalent to

Defaults to:

null

Available since: 6.5.0

bind : Object / String

<ext-lockedgrid bind="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.bind = 'value';
let bind = element.bind;

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

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

To dynamically add bindings:

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

To remove bindings:

 panel.setBind({
     title: null
 });

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

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

Defaults to:

null

bodyBorder : Boolean

<ext-lockedgrid bodyBorder="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.bodyBorder = true;
let bodyBorder = element.bodyBorder;

Controls the border style of the panel body using the following values:

• true to enable the border around the panel body (as defined by the theme) Note that even when enabled, the bodyBorder is only visible when there are docked items around the edges of the panel. Where the bodyBorder touches the panel's outer border it is automatically collapsed into a single border.

• false to disable the body border

• null - use the value of border as the value for bodyBorder

Defaults to:

null

bodyCls : String / String[]

<ext-lockedgrid bodyCls="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.bodyCls = 'value';
let bodyCls = element.bodyCls;

The CSS class to add to this container's body element.

Defaults to:

null

Available since: 7.0

bodyPadding : Number / Boolean / String

<ext-lockedgrid bodyPadding="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.bodyPadding = true;
let bodyPadding = element.bodyPadding;

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.

bodyPadding: 5 // 5px padding on all sides

bodyPadding: '10 20' // 10px top and bottom padding - 20px side padding

See the unitizeBox method for more information on what string values are valid

Defaults to:

null

bodyStyle : String / Object

<ext-lockedgrid bodyStyle="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.bodyStyle = 'value';
let bodyStyle = element.bodyStyle;

Custom CSS styles to be applied to the panel's body element, which can be supplied as a valid CSS style string or an object containing style property name/value pairs.

For example, these two formats are interpreted to be equivalent:

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

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

Defaults to:

null

Available since: 6.5.0

border : Boolean

<ext-lockedgrid border="true" />

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

Using style:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    style: 'border: 1px solid blue;'
    // ...
});

Using CSS:

Ext.Viewport.add({
    centered: true,
    width: 100,
    height: 100,

    cls: 'my-component'
    // ...
});

And your CSS file:

.my-component {
    border: 1px solid red;
}

Defaults to:

false

bottom : Number / String

<ext-lockedgrid bottom="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.bottom = 'value';
let bottom = element.bottom;

The absolute bottom position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

buttonAlign : String

<ext-lockedgrid buttonAlign="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.buttonAlign = 'value';
let buttonAlign = element.buttonAlign;

The alignment of any buttons added to this panel. Valid values are 'right', 'left' and 'center'

Defaults to:

'center'

Available since: 6.5.0

buttonToolbar : Object / <ext-toolbar/>

<ext-lockedgrid buttonToolbar="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.buttonToolbar = { };
let buttonToolbar = element.buttonToolbar;

Configure the toolbar that holds the buttons inside.

Defaults to:

{
    xtype: 'toolbar',
    itemId: 'buttonToolbar',
    docked: 'bottom',
    defaultType: 'button',
    weighted: true,
    ui: 'footer',
    defaultButtonUI: 'action',
    layout: {
        type: 'box',
        vertical: false,
        pack: 'center'
    }
}

Available since: 6.5.0

buttons : Object / Ext.Button[]

immutable imm

<ext-lockedgrid buttons="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.buttons = { };
let buttons = element.buttons;

The buttons for this panel to be displayed in the buttonToolbar as a keyed object (or array) of button configuration objects.

For buttons that are defined in standardButtons (such as 'ok'), there is a more convenient short-hand for this config:

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

Available since: 6.5.0

centered : Boolean

<ext-lockedgrid centered="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.centered = true;
let centered = element.centered;

Configure this as true to have this Component centered within its Container. Setting this value to true will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

false

classCls

readonly ro

<ext-lockedgrid classCls="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.classCls = 'value';
let classCls = element.classCls;

A CSS class to apply to the main element that will be inherited down the class hierarchy. Subclasses may override this property on their prototype to add their own CSS class in addition to the CSS classes inherited from ancestor classes via the prototype chain. For example

Ext.define('Foo', {
    extend: 'Ext.Widget',
    classCls: 'foo'
});

Ext.define('Bar', {
    extend: 'Foo',
    classCls: 'bar'
});

var bar = new Bar();

console.log(bar.element.className); // outputs 'foo bar'

Defaults to:

Ext.baseCSSPrefix + 'panel'

closable : Boolean

<ext-lockedgrid closable="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.closable = true;
let closable = element.closable;

True to display the 'close' tool button and allow the user to close the panel or 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 method-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:

null

closeAction : String

<ext-lockedgrid closeAction="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.closeAction = 'value';
let closeAction = element.closeAction;

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

• 'method-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 method-show method.

• 'method-hide' :

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

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

Defaults to:

'destroy'

closeToolText : String

<ext-lockedgrid closeToolText="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.closeToolText = 'value';
let closeToolText = element.closeToolText;

Text to be announced by screen readers when the close <ext-tool/> <ext-paneltool/> is focused. Will also be set as the close tool's tooltip text.

Note: Applicable when the panel is closable: true

Defaults to:

'Close panel'

cls : String / String[]

<ext-lockedgrid cls="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.cls = 'value';
let cls = element.cls;

The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a <ext-container/>).

Defaults to:

null

collapsed : Boolean

<ext-lockedgrid collapsed="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.collapsed = true;
let collapsed = element.collapsed;

true to start collapsed.

Defaults to:

null

collapsible : 'top' / 'right' / 'bottom' / 'left' / Boolean / Object

<ext-lockedgrid collapsible="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.collapsible = true;
let collapsible = element.collapsible;

A configuration for a Ext.panel.Collapser.

True to make the panel collapsible and have an expand/collapse toggle Tool added into the header tool button area.

You can also set top/right/bottom/left to directly specify the collapse direction.

IMPORTANT: To use this config, the application must require the following class:

 requires: [
     'Ext.panel.Collapser'
 ]

Defaults to:

null

Available since: 6.5.0

constrainAlign : String / Ext.util.Region / Ext.dom.Element

<ext-lockedgrid constrainAlign="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.constrainAlign = 'value';
let constrainAlign = element.constrainAlign;

A specification of the constraint to apply when showBy or alignTo is called to align a floated or positioned component.

Defaults to the parent container for positioned components (components which have their top, right, bottom or left set to move them out of their container's layout flow).

Defaults to the viewport for floated components.

May be a Ext.ComponentQuery selector to find an ancestor component to constrain within.

May be false to specify that constraining is not applied.

You may also specify an element, or a Ext.util.Region

Defaults to:

null

containsFocus : Boolean

readonly ro

<ext-lockedgrid containsFocus="true" />

let element = document.body.querySelector('ext-lockedgrid');
let containsFocus = element.containsFocus;

true if this currently focused element is within this Component's or Container's hierarchy. This property is set separately from hasFocus, and can be true when hasFocus is false.

Examples:

• Text field with input element focused would be: focusable: true, hasFocus: true, containsFocus: true

• Date field with drop-down picker currently focused would be: focusable: true, hasFocus: false, containsFocus: true

• Form Panel with a child input field currently focused would be: focusable: false, hasFocus: false, containsFocus: true

See also hasFocus.

Defaults to:

false

contentEl : Ext.dom.Element / HTMLElement / String

<ext-lockedgrid contentEl="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.contentEl = 'value';
let contentEl = element.contentEl;

The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.

Defaults to:

null

controller : String / Object / Ext.app.ViewController

<ext-lockedgrid controller="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.controller = 'value';
let controller = element.controller;

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

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

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

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

Defaults to:

null

data : Object

<ext-lockedgrid data="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.data = { };
let data = element.data;

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

Note: Data will be appended to any existing data.

Defaults to:

null

defaultBindProperty : String

readonly ro

<ext-lockedgrid defaultBindProperty="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.defaultBindProperty = 'value';
let defaultBindProperty = element.defaultBindProperty;

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

 bind: '{name}'

Is equivalent to this object form:

 bind: {
     value: '{name}'
 }

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

Defaults to:

'title'

defaultFocus : String

<ext-lockedgrid defaultFocus="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.defaultFocus = 'value';
let defaultFocus = element.defaultFocus;

Specifies a child Component to receive focus when this Container's method-focus method is called. Should be a valid Ext.ComponentQuery selector.

Defaults to:

null

defaultListenerScope : Boolean

<ext-lockedgrid defaultListenerScope="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.defaultListenerScope = true;
let defaultListenerScope = element.defaultListenerScope;

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

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

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

Defaults to:

false

defaultToolWeights : Object

<ext-lockedgrid defaultToolWeights="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.defaultToolWeights = { };
let defaultToolWeights = element.defaultToolWeights;

The default weight for tools in the header.

Defaults to:

{
    toggle: 10,
    gear: 20,
    prev: 30,
    next: 40,
    left: 50,
    right: 60,
    down: 70,
    up: 80,
    refresh: 90,
    disclosure: 100,
    // was originally defined in ListItem
    plus: 100,
    minus: 110,
    search: 120,
    edit: 125,
    save: 130,
    print: 140,
    expand: 150,
    collapse: 160,
    help: 170,
    pin: 180,
    unpin: 190,
    minimize: 200,
    maximize: 210,
    restore: 220,
    close: 230,
    trash: 240
}

Available since: 6.5.0

defaults : Object

<ext-lockedgrid defaults="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.defaults = { };
let defaults = element.defaults;

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

Ext.create({
    xtype: 'container',
    defaults: {
        xtype: 'panel'
    },
    items: [
        {
            html: 'Panel 1'
        },
        {
            html: 'Panel 2'
        }
    ]
});

Defaults to:

null

destroyed : Boolean

readonly ro

<ext-lockedgrid destroyed="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.destroyed = true;
let destroyed = element.destroyed;

This property is set to true after the destroy method is called.

Defaults to:

false

disabled : Boolean

<ext-lockedgrid disabled="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.disabled = true;
let disabled = element.disabled;

Whether or not this component is disabled

Defaults to:

null

displayed : Boolean

<ext-lockedgrid displayed="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.displayed = true;
let displayed = element.displayed;

Set to true to call show and false to call hide. Unlike the hidden config, changing this config will potentially involve animations to show or hide the component.

Defaults to:

null

Available since: 6.5.0

docked : String

<ext-lockedgrid docked="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.docked = 'value';
let docked = element.docked;

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

<!doctype html>

So your index.html file should look a little like this:

<!doctype html>
<html>
    <head>
        <title>MY application title</title>
        ...

Defaults to:

null

draggable : Boolean / Object / Ext.drag.Source

<ext-lockedgrid draggable="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.draggable = true;
let draggable = element.draggable;

Set to true to allow this component to be dragged. This can also be the config object for the Ext.drag.Source that will manage the drag.

Defaults to:

null

factoryConfig : Object

readonly ro

<ext-lockedgrid factoryConfig="{ }" />

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

flex : Number / String / Object

<ext-lockedgrid flex="value" />

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

Defaults to:

null

floated : Boolean

<ext-lockedgrid floated="true" />

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

false

Available since: 6.2.0

floatingCls : String

readonly ro

<ext-lockedgrid floatingCls="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.floatingCls = 'value';
let floatingCls = element.floatingCls;

The CSS class to add to this component when it is floated at the viewport level.

Defaults to:

Ext.baseCSSPrefix + 'floating'

focusCls : String

immutable imm

<ext-lockedgrid focusCls="value" />

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

focusClsEl : Ext.dom.Element

readonly ro

<ext-lockedgrid focusClsEl="value" />

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

readonly ro

<ext-lockedgrid focusEl="value" />

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

focusable : Boolean

readonly ro

<ext-lockedgrid focusable="true" />

let element = document.body.querySelector('ext-lockedgrid');
let focusable = element.focusable;

true for keyboard interactive Components or Widgets, false otherwise. For Containers, this property reflects interactiveness of the Container itself, not its children. See isFocusable.

Note: It is not enough to set this property to true to make a component keyboard interactive. You also need to make sure that the component's focusEl is reachable via Tab key (tabbable). See also tabIndex.

Defaults to:

false

focusableContainer : Boolean

immutable imm

<ext-lockedgrid focusableContainer="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.focusableContainer = true;
let focusableContainer = element.focusableContainer;

Enable or disable navigation with arrow keys for this FocusableContainer. This option may be useful with nested FocusableContainers, when only the root container should handle keyboard events.

Defaults to:

false

focusableContainerEl : String / Ext.dom.Element

readonly ro

<ext-lockedgrid focusableContainerEl="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.focusableContainerEl = 'value';
let focusableContainerEl = element.focusableContainerEl;

The name of the element that FocusableContainer should bind its keyboard handler to. Similar to ariaEl, this name is resolved to the Ext.dom.Element instance after rendering.

Defaults to:

"el"

fullscreen : Boolean

immutable imm

<ext-lockedgrid fullscreen="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.fullscreen = true;
let fullscreen = element.fullscreen;

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

hasCollapsible : Boolean

readonly ro

<ext-lockedgrid hasCollapsible="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.hasCollapsible = true;
let hasCollapsible = element.hasCollapsible;

true if this panel has the collapsible override added.

Defaults to:

true

Available since: 6.5.0

hasFocus : Boolean

readonly ro

<ext-lockedgrid hasFocus="true" />

let element = document.body.querySelector('ext-lockedgrid');
let hasFocus = element.hasFocus;

true if this component's focusEl is focused. See also containsFocus.

Defaults to:

false

hasListeners : Object

readonly ro

<ext-lockedgrid hasListeners="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
let hasListeners = element.hasListeners;

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

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

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

hasResizable : Boolean

readonly ro

<ext-lockedgrid hasResizable="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.hasResizable = true;
let hasResizable = element.hasResizable;

true if this panel has the resizable override added.

Defaults to:

true

Available since: 6.5.0

header : Boolean / Object

<ext-lockedgrid header="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.header = true;
let header = element.header;

Pass as false to prevent a header from being created.

You may also assign a header with a config object (optionally containing an xtype) to custom-configure your panel's header.

See <ext-panelheader/> for all the options that may be specified here.

Defaults to:

null

headerPosition : 'top' / 'right' / 'bottom' / 'left'

<ext-lockedgrid headerPosition="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.headerPosition = 'value';
let headerPosition = element.headerPosition;

The position of the header. Ignored if no cfg-header is created.

Defaults to:

'top'

Available since: 6.5.0

height : Number / String

<ext-lockedgrid height="value" />

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

<ext-lockedgrid hidden="true" />

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

hideAnimation : String / Mixed

<ext-lockedgrid hideAnimation="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.hideAnimation = 'value';
let hideAnimation = element.hideAnimation;

Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

hideMode : 'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

<ext-lockedgrid hideMode="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.hideMode = 'value';
let hideMode = element.hideMode;

A String which specifies how this component's DOM element will be hidden. The accepted values are any of these:

• 'clip' : Hide using clip.
• 'display' : Hide using display.
• 'offsets' : Hide using positioning offsets.
• 'opacity' : Hide using opacity.
• 'visibility' : Hide using visibility.

Hiding using display results in having no dimensions as well as resetting scroll positions to 0.

The other modes overcome this but may have different trade-offs in certain circumstances.

Defaults to:

'display'

Available since: 6.5.0

hideOnMaskTap : Boolean

<ext-lockedgrid hideOnMaskTap="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.hideOnMaskTap = true;
let hideOnMaskTap = element.hideOnMaskTap;

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

Defaults to:

null

html : String / Ext.dom.Element / HTMLElement

<ext-lockedgrid html="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.html = 'value';
let html = element.html;

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

Defaults to:

null

icon : String

<ext-lockedgrid icon="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.icon = 'value';
let icon = element.icon;

Path to an image to use as an icon.

For instructions on how you can use icon fonts including those distributed in the SDK see iconCls.

Defaults to:

null

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

<ext-lockedgrid iconAlign="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.iconAlign = 'value';
let iconAlign = element.iconAlign;

The side of the title to render the icon.

Defaults to:

'left'

iconCls : String

<ext-lockedgrid iconCls="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.iconCls = 'value';
let iconCls = element.iconCls;

One or more space separated CSS classes to be applied to the icon element. The CSS rule(s) applied should specify a background image to be used as the icon.

An example of specifying a custom icon class would be something like:

// specify the property in the config for the class:
iconCls: 'my-home-icon'

// css rule specifying the background image to be used as the icon image:
.my-home-icon {
    background-image: url(../images/my-home-icon.gif) !important;
}

In addition to specifying your own classes, you can use the font icons provided in the SDK using the following syntax:

// using Font Awesome
iconCls: 'x-fa fa-home'

// using Pictos
iconCls: 'pictos pictos-home'

Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:

• Font Awesome icons
• Pictos icons
• Theming Guide

Defaults to:

null

id : String

immutable imm

<ext-lockedgrid id="value" />

let element = document.body.querySelector('ext-lockedgrid');
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 <ext-container/> class contains shortcut methods to query its descendant Components by selector.

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

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

Defaults to an auto-assigned id.

inactiveChildTabIndex : Number

immutable imm

<ext-lockedgrid inactiveChildTabIndex="10" />

let element = document.body.querySelector('ext-lockedgrid');
element.inactiveChildTabIndex = 10;
let inactiveChildTabIndex = element.inactiveChildTabIndex;

DOM tabIndex attribute to set on inactive Focusable children of this container when using the "Roaming tabindex" technique. This value rarely needs to be changed from its default.

Defaults to:

-1

inheritUi : Boolean / String

readonly ro

<ext-lockedgrid inheritUi="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.inheritUi = true;
let inheritUi = element.inheritUi;

Set to true on widgets that should inherit ui from their parent container. This property is typically set on the class body, but can be set on an instance as long as it is set prior to the instance being added to its container. This property is inspected at the moment a widget is added to a container, and any UIs on the container are added to the widget at that time. Inherited UIs are in addition to the widget's own ui, and are updated when the container's UI changes.

Defaults to:

false

innerCls : String

<ext-lockedgrid innerCls="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.innerCls = 'value';
let innerCls = element.innerCls;

A string to add to the immediate parent element of the inner items of this container. That is, items that are not docked, positioned or floated. In some containers, positioned items may be in this same element.

Defaults to:

null

Available since: 6.5.0

isContainer : Boolean

readonly ro

<ext-lockedgrid isContainer="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.isContainer = true;
let isContainer = element.isContainer;

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

Defaults to:

true

isObservable : Boolean

readonly ro

<ext-lockedgrid isObservable="true" />

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

itemId : String

<ext-lockedgrid itemId="value" />

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

Defaults to:

undefined

keyMap : Object

<ext-lockedgrid keyMap="{ }" />

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

Defaults to:

null

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

<ext-lockedgrid keyMapEnabled="true" />

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

lastKeyMapEvent : Ext.event.Event

readonly ro

<ext-lockedgrid lastKeyMapEvent="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.lastKeyMapEvent = 'value';
let lastKeyMapEvent = element.lastKeyMapEvent;

The last key event processed is cached on the component for use in subsequent event handlers.

Available since: 6.6.0

layout : Object / String

<ext-lockedgrid layout="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.layout = 'value';
let layout = element.layout;

Configuration for this Container's layout. Example:

Ext.create({
    xtype: 'container',
    layout: {
        type: 'hbox',
        align: 'middle'
    },
    items: [{
        xtype: 'panel',
        flex: 1,
        bodyStyle: {
            background: "#000",
            color:"#fff"
        }
    }, {
       xtype: 'panel',
       flex: 2,
       bodyStyle: {
           background: "#f00",
           color:"#fff"
       }
    }]
});

Defaults to:

'auto'

lbar : Object / Object[]

<ext-lockedgrid lbar="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.lbar = { };
let lbar = element.lbar;

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

is equivalent to

Defaults to:

null

Available since: 6.5.0

left : Number / String

<ext-lockedgrid left="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.left = 'value';
let left = element.left;

The absolute left position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

listeners : Object

<ext-lockedgrid listeners="{ }" />

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

manageBorders : Boolean

immutable imm

<ext-lockedgrid manageBorders="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.manageBorders = true;
let manageBorders = element.manageBorders;

true to enable border management of docked items. When enabled, borders of docked items will collapse where they meet to avoid duplicated borders.

Defaults to:

true

margin : Number / String

<ext-lockedgrid margin="value" />

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

Defaults to:

null

masked : Boolean / String / Object / <ext-mask/> / <ext-loadmask/>

<ext-lockedgrid masked="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.masked = true;
let masked = element.masked;

A configuration to allow you to mask this container.

If the value is a string, it will be used as the message config for an <ext-loadmask/>.

For more precise control over the mask, you can optionally pass an object block with and xtype of loadmask, and an optional message value to display a loading mask. Please refer to the <ext-loadmask/> component to see other configurations.

Ext.create({
    xtype: 'container',
    fullscreen: true,
    html: 'Hello World',
    masked: {
        xtype: 'loadmask',
        message: 'My Message'
    }
});

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

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

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

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

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

Defaults to:

null

maxHeight : Number / String

<ext-lockedgrid maxHeight="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.maxHeight = 'value';
let maxHeight = element.maxHeight;

The maximum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

maxWidth : Number / String

<ext-lockedgrid maxWidth="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.maxWidth = 'value';
let maxWidth = element.maxWidth;

The maximum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to:

null

minButtonWidth : Number

<ext-lockedgrid minButtonWidth="10" />

let element = document.body.querySelector('ext-lockedgrid');
element.minButtonWidth = 10;
let minButtonWidth = element.minButtonWidth;

Minimum width of all buttonToolbar buttons in pixels. If set, this will be used as the default value for the Ext.Button#minWidth config of each <ext-button/> added to the `buttonToolbar via the buttons toolbar.

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: 6.5.0

minHeight : Number / String

<ext-lockedgrid minHeight="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.minHeight = 'value';
let minHeight = element.minHeight;

The minimum height of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

minWidth : Number / String

<ext-lockedgrid minWidth="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.minWidth = 'value';
let minWidth = element.minWidth;

The minimum width of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. If set to auto, it will set the width to null meaning it will have its own natural size.

Defaults to:

null

modal : Boolean

<ext-lockedgrid modal="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.modal = true;
let modal = element.modal;

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

Defaults to:

null

modelValidation : Boolean

immutable imm

<ext-lockedgrid modelValidation="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.modelValidation = true;
let modelValidation = element.modelValidation;

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

When set to true by a component (or by an ancestor container), the validators of for any {@Ext.data.Model record} fields will be used wherever the value is bound to such data fields.

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

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

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

Defaults to:

null

Available since: 6.5.0

name : String

immutable imm

<ext-lockedgrid name="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.name = 'value';
let name = element.name;

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

Defaults to:

null

nameHolder : Boolean

immutable imm

<ext-lockedgrid nameHolder="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.nameHolder = true;
let nameHolder = element.nameHolder;

When true child components are tracked by their name property and can be retrieved using the lookupName method.

Defaults to:

false

nameable : Boolean

immutable imm

<ext-lockedgrid nameable="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.nameable = true;
let nameable = element.nameable;

Set to true for this component's name property to be tracked by its containing nameHolder.

Defaults to:

false

padding : Number / String

<ext-lockedgrid padding="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.padding = 'value';
let padding = element.padding;

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

Defaults to:

null

plugins : Array / Ext.enums.Plugin / Object / Ext.plugin.Abstract

<ext-lockedgrid plugins="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.plugins = { };
let plugins = element.plugins;

This config describes one or more plugin config objects used to create plugin instances for this component.

Plugins are a way to bundle and reuse custom functionality. Plugins should extend Ext.plugin.Abstract but technically the only requirement for a valid plugin is that it contain an init method that accepts a reference to its owner. Once a plugin is created, the owner will call the init method, passing a reference to itself. Each plugin can then call methods or respond to events on its owner as needed to provide its functionality.

This config's value can take several different forms.

The value can be a single string with the plugin's Ext.enums.Plugin:

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

     plugins: 'listpaging'
 });

In the above examples, the string "listpaging" is the type alias for listpaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

The preferred form for multiple plugins or to configure plugins is the keyed-object form (new in version 6.5):

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

     plugins: {
         pullrefresh: true,
         listpaging: {
             autoPaging: true,
             weight: 10
         }
     }
 });

The object keys are the id's as well as the default type alias. This form allows the value of the plugins to be merged from base class to derived class and finally with the instance configuration. This allows classes to define a set of plugins that derived classes or instantiators can further configure or disable. This merge behavior is a feature of the config.

The plugins config can also be an array of plugin aliases (arrays are not merged so this form does not respect plugins defined by the class author):

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

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

An array can also contain elements that are config objects with a type property holding the type alias:

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

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

Defaults to:

null

publishes : String / String[] / Object

<ext-lockedgrid publishes="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.publishes = 'value';
let publishes = element.publishes;

One or more names of config properties that this component should publish to its ViewModel. Generally speaking, only properties defined in a class config block (including ancestor config blocks and mixins) are eligible for publishing to the viewModel. Some components override this and publish their most useful configs by default.

Note: We'll discuss publishing properties not found in the config block below.

Values determined to be invalid by component (often form fields and model validations) will not be published to the ViewModel.

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

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

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

Classes must provide this config as an Object:

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

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

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

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

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

In some cases, users may want to publish a property to the viewModel that is not found in a class config block. In these situations, you may utilize publishState if the property has a setter method. Let's use setFieldLabel as an example:

  setFieldLabel: function(fieldLabel) {
      this.callParent(arguments);
      this.publishState('fieldLabel', fieldLabel);
  }

With the above chunk of code, fieldLabel may now be published to the viewModel.

Defaults to:

null

Available since: 5.0.0

rbar : Object / Object[]

<ext-lockedgrid rbar="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.rbar = { };
let rbar = element.rbar;

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

is equivalent to

Defaults to:

null

Available since: 6.5.0

record : Ext.data.Model

<ext-lockedgrid record="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.record = 'value';
let record = element.record;

A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.

Defaults to:

null

reference : String

immutable imm

<ext-lockedgrid reference="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.reference = 'value';
let reference = element.reference;

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

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

Defaults to:

null

referenceHolder : Boolean

immutable imm

<ext-lockedgrid referenceHolder="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.referenceHolder = true;
let referenceHolder = element.referenceHolder;

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

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

Defaults to:

false

relative : Boolean

<ext-lockedgrid relative="true" />

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

false

Available since: 6.2.0

rendered : Boolean

readonly ro

<ext-lockedgrid rendered="true" />

let element = document.body.querySelector('ext-lockedgrid');
let rendered = element.rendered;

The rendered flag is set when a widget is inserted into the document for the first time.

Note that this is a one-way operation. The first time a widget is inserted into the document, this flag is set, and it is never unset.

resetFocusPosition : Boolean

immutable imm

<ext-lockedgrid resetFocusPosition="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.resetFocusPosition = true;
let resetFocusPosition = element.resetFocusPosition;

When true, FocusableContainer will reset last focused position whenever focus leaves the container. Subsequent tabbing into the container will always focus the first eligible child item.

When false, subsequent tabbing into the container will focus the child item that was last focused before.

Defaults to:

false

resizable : Object

<ext-lockedgrid resizable="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.resizable = { };
let resizable = element.resizable;

A configuration for a Ext.panel.Resizer.

IMPORTANT: To use this config, the application must require the following class:

 requires: [
     'Ext.panel.Resizer'
 ]

Defaults to:

null

Available since: 6.5.0

right : Number / String

<ext-lockedgrid right="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.right = 'value';
let right = element.right;

The absolute right position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

ripple : Boolean / Object / String

<ext-lockedgrid ripple="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.ripple = true;
let ripple = element.ripple;

Set to truthy, Color or Object value for the ripple.

Defaults to:

null

Available since: 6.5.0

Properties

color : String

The background color of the ripple.

position : Array

Position for the ripple to start at [x,y]. Determines if a Ripple effect should happen whenever this element is pressed.

For example: { ripple: true }

Or:

 {
     ripple: {
         color: 'red'
     }
 }

For complex components, individual elements can suppress ripples by adding the x-no-ripple class to disable rippling for a tree of elements.

scrollable : Boolean / String / Object

<ext-lockedgrid scrollable="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.scrollable = true;
let scrollable = element.scrollable;

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

• true to enable auto scrolling.
• false (or null) to disable scrolling - this is the default.
• x or horizontal to enable horizontal scrolling only
• y or vertical to enable vertical scrolling only

Also accepts a configuration object for a Ext.scroll.Scroller if if advanced configuration is needed.

The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:

// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);

Defaults to:

null

session : Boolean / Object / Ext.data.Session

<ext-lockedgrid session="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.session = true;
let session = element.session;

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

To create a new session you can specify true:

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

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

Alternatively, a config object can be provided:

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

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

Defaults to:

null

shadow : Boolean

<ext-lockedgrid shadow="true" />

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

shareableName : Boolean

immutable imm

<ext-lockedgrid shareableName="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.shareableName = true;
let shareableName = element.shareableName;

Set to true to allow this component's name to be shared by other items in the same nameHolder. Such items will be returned in an array from lookupName.

Defaults to:

false

shim : Boolean

<ext-lockedgrid shim="true" />

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

false

Available since: 6.2.0

showAnimation : String / Mixed

<ext-lockedgrid showAnimation="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.showAnimation = 'value';
let showAnimation = element.showAnimation;

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation#type config.

Defaults to:

null

standardButtons : Object

<ext-lockedgrid standardButtons="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.standardButtons = { };
let standardButtons = element.standardButtons;

This object contains config objects for the standard buttons (such as OK and Cancel). This object is keyed by the itemId for the button and contains the text and a default weight for weighted containers to use. These default weights vary by OS to provide the user with a button order that is consistent for their platform. In particular, Windows and Linux (or rather all platforms other then Mac OS and iOS) present the OK button followed by Cancel while Mac OS and iOS present them in reverse order of 'Cancelfollowed byOK`.

The standard buttons, in weight order, are as follows:

• ok
• abort
• retry
• ignore
• yes
• no
• cancel
• apply
• save
• submit
• help
• close

On Mac OS and iOS this order is reversed with the exception of help which is the first button. The buttons are assigned weights from 10 to 200.

Defaults to:

{
    ok: {
        text: 'OK',
        weight: isMacOrAndroid ? 120 : 10
    },
    abort: {
        text: 'Abort',
        weight: isMacOrAndroid ? 110 : 20
    },
    retry: {
        text: 'Retry',
        weight: isMacOrAndroid ? 100 : 30
    },
    ignore: {
        text: 'Ignore',
        weight: isMacOrAndroid ? 90 : 40
    },
    yes: {
        text: 'Yes',
        weight: isMacOrAndroid ? 80 : 50
    },
    no: {
        text: 'No',
        weight: isMacOrAndroid ? 70 : 60
    },
    cancel: {
        text: 'Cancel',
        weight: isMacOrAndroid ? 60 : 70
    },
    apply: {
        text: 'Apply',
        weight: isMacOrAndroid ? 50 : 80
    },
    save: {
        text: 'Save',
        weight: isMacOrAndroid ? 40 : 90
    },
    submit: {
        text: 'Submit',
        weight: isMacOrAndroid ? 30 : 100
    },
    help: {
        text: 'Help',
        weight: isMacOrAndroid ? 10 : 110
    },
    close: {
        text: 'Close',
        weight: isMacOrAndroid ? 20 : 120
    }
}

Available since: 6.5.0

stateId : String

<ext-lockedgrid stateId="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.stateId = 'value';
let stateId = element.stateId;

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

Defaults to:

null

stateful : Boolean / Object / String[]

<ext-lockedgrid stateful="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.stateful = true;
let stateful = element.stateful;

This config specifies the config properties that will be persisted using the Ext.state.Provider. If this config is set to true, the configs specified by statefulDefaults will be assumed.

 stateful: true

Otherwise, this config can be an array of strings of the properties to save:

 stateful: [
     'width',
     'height',
     'collapsed'
 ]

The above is equivalent to:

 stateful: {
     width: true,
     height: true,
     collapsed: true
 }

Note: To be truly stateful, an id or stateId must also be assigned.

A stateful object will save its state when any of these config properties change value.

Defaults to:

false

style : String / Object

<ext-lockedgrid style="value" />

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

tabIndex : Number

<ext-lockedgrid tabIndex="10" />

let element = document.body.querySelector('ext-lockedgrid');
element.tabIndex = 10;
let tabIndex = element.tabIndex;

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

tbar : Object / Object[]

<ext-lockedgrid tbar="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.tbar = { };
let tbar = element.tbar;

Convenience config. Short for 'Top Bar'.

is equivalent to

Defaults to:

null

Available since: 6.5.0

template : Array

readonly ro

<ext-lockedgrid template="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.template = 'value';
let template = element.template;

An array of child elements to use as the children of the main element in the element template. Only used if "children" are not specified explicitly in the element template.

Defaults to:

[
    {
        reference: 'bodyWrapElement',
        cls: Ext.baseCSSPrefix + 'body-wrap-el',
        uiCls: 'body-wrap-el',
        children: [
            {
                reference: 'bodyElement',
                cls: Ext.baseCSSPrefix + 'body-el',
                uiCls: 'body-el'
            }
        ]
    }
]

title : String / <ext-paneltitle/>

<ext-lockedgrid title="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.title = 'value';
let title = element.title;

The title text or config object for the <ext-paneltitle/> component.

Defaults to:

null

titleAlign : 'left' / 'center' / 'right'

<ext-lockedgrid titleAlign="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.titleAlign = 'value';
let titleAlign = element.titleAlign;

The alignment of the title text within the available space between the icon and the tools.

Defaults to:

'left'

titleCollapse : Boolean

<ext-lockedgrid titleCollapse="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.titleCollapse = true;
let titleCollapse = element.titleCollapse;

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

Defaults to:

null

Available since: 7.0

toFrontOnShow : Boolean

<ext-lockedgrid toFrontOnShow="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.toFrontOnShow = true;
let toFrontOnShow = element.toFrontOnShow;

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

Defaults to:

true

toolDefaults : Object

<ext-lockedgrid toolDefaults="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.toolDefaults = { };
let toolDefaults = element.toolDefaults;

The properties of this object are shallow copied (via applyIf() as opposed to Ext.merge() to each tool declared in the tools config.

Defaults to:

{
    xtype: 'tool',
    zone: 'end'
}

tools : Ext.Tool[] / Object / Object[]

<ext-lockedgrid tools="{ }" />

let element = document.body.querySelector('ext-lockedgrid');
element.tools = { };
let tools = element.tools;

An array of <ext-tool/> <ext-paneltool/> configs or an object keyed by itemId.

Defaults to:

null

tooltip : String / Object

<ext-lockedgrid tooltip="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.tooltip = 'value';
let tooltip = element.tooltip;

The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or <ext-tooltip/> config object.

The default behavior is to use a shared tip instance. The tooltip configuration is registered with the Ext.tip.Manager. To enable this, your application can set the Ext.app.Application#quickTips config, or an instance of the Ext.tip.Manager may be created manually.

To force a unique tooltip instance to be created, specify autoCreate: true on this configuration.

Configuring this with autoHide: false implies autoCreate: true so that the desired persistent behavior can be obtained with other targets still showing the singleton instance.

Defaults to:

null

top : Number / String

<ext-lockedgrid top="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.top = 'value';
let top = element.top;

The absolute top position of this Component; must be a valid CSS length value, e.g: 300, 100px, 30%, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to:

null

touchAction : Object

<ext-lockedgrid touchAction="{ }" />

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

Ext.create('Ext.Widget', {
    touchAction: {
        panX: false
    },
    listeners: {
        drag: function(e) {
            // implement drag logic
        }
    }
});

Defaults to:

null

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

<ext-lockedgrid tpl="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.tpl = 'value';
let tpl = element.tpl;

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

Note The data configuration must be set for any content to be shown in the component when using this configuration.

Defaults to:

null

tplWriteMode : String

<ext-lockedgrid tplWriteMode="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.tplWriteMode = 'value';
let tplWriteMode = element.tplWriteMode;

The Ext.(X)Template method to use when updating the content area of the Component.

Valid modes are:

• append
• insertAfter
• insertBefore
• insertFirst
• overwrite

Defaults to:

'overwrite'

twoWayBindable : String / String[] / Object

<ext-lockedgrid twoWayBindable="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.twoWayBindable = 'value';
let twoWayBindable = element.twoWayBindable;

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

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

Defaults to:

null

ui : String / String[]

<ext-lockedgrid ui="value" />

let element = document.body.querySelector('ext-lockedgrid');
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[]

<ext-lockedgrid userCls="value" />

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

For example:

 items: [{
     xtype: 'button',
     userCls: 'my-button'
 ...
 }]

Defaults to:

null

userSelectable : Boolean / String / Object

<ext-lockedgrid userSelectable="true" />

let element = document.body.querySelector('ext-lockedgrid');
element.userSelectable = true;
let userSelectable = element.userSelectable;

Set to true to allow users to select text within this component.

Can also be any valid value for the CSS3 user-select property.

A value of true implies auto, while false implies none.

May also be an object keyed by child element name.

By default, the user cannot click+drag+select text/elements of the UI. Applications may want to enable user selection for specific DOM elements, such as the bodyElement of a component used as a tab panel. The tab and tab text would not be user selectable in this example, but the content area when the tab is selected would.

 userSelectable: {
     element: true,       // allow the element to be user selectable
     bodyElement: true    // allow the component's body element to be user selectable
 }

Defaults to:

false

Available since: 6.5.1

viewModel : String / Object / Ext.app.ViewModel

<ext-lockedgrid viewModel="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.viewModel = 'value';
let viewModel = element.viewModel;

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

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

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

Defaults to:

null

weight : Number

<ext-lockedgrid weight="10" />

let element = document.body.querySelector('ext-lockedgrid');
element.weight = 10;
let weight = element.weight;

This value controls this item's order in a weighted <ext-container/> (see parent).

Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.

Defaults to:

0

width : Number / String

<ext-lockedgrid width="value" />

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

<ext-lockedgrid x="10" />

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

xtype : String

immutable imm

<ext-lockedgrid xtype="value" />

let element = document.body.querySelector('ext-lockedgrid');
element.xtype = 'value';
let xtype = element.xtype;

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

You can define your own xtype on a custom <ext-component/> like so:

Ext.define('PressMeButton', {
    extend: 'Ext.button.Button',
    xtype: '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.

y : Number

<ext-lockedgrid y="10" />

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

zIndex : Number

<ext-lockedgrid zIndex="10" />

let element = document.body.querySelector('ext-lockedgrid');
element.zIndex = 10;
let zIndex = element.zIndex;

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

Not valid for cfg-floated Components. The Z ordering of cfg-floated Components is managed by ordering of the DOM elements.

Defaults to:

null

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

let element = document.body.querySelector('ext-lockedgrid');
let add = element.add(newItems);

Adds one or more Components to this Container. Example:

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

var items = myContainer.add([myPanel]); // Array returned
var item  = myContainer.add(myPanel);   // One item is returned

Parameters

Returns

addAfterListener

let element = document.body.querySelector('ext-lockedgrid');
element.addAfterListener();

Alias for onAfter.

addBeforeListener

let element = document.body.querySelector('ext-lockedgrid');
element.addBeforeListener();

Alias for onBefore.

addBodyCls ( cls ) : Ext.Panel

chainable ch

let element = document.body.querySelector('ext-lockedgrid');
let addBodyCls = element.addBodyCls(cls);

Adds a CSS class to the body element. If not rendered, the class will be added when the panel is rendered.

Parameters

Returns

addCls ( cls, [prefix], [suffix] )

let element = document.body.querySelector('ext-lockedgrid');
element.addCls(cls, prefix, suffix);

Adds a CSS class (or classes) to this Component's rendered element.

Parameters

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

chainable ch

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

 handler('foo', 42, <actual event arguments>...);

false

'current'

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('ext-lockedgrid');
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.SomeSharedMenu, '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('ext-lockedgrid');
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

addTool ( tool )

let element = document.body.querySelector('ext-lockedgrid');
element.addTool(tool);

Add tools to this panel <ext-panelheader/>

panel.addTool({
    type: 'gear',
    handler: function () {
        // ....
    }
});

panel.addTool([{
    type: 'gear',
    handler: 'viewControllerGearMethod'
}, {
    type: 'save',
    handler: 'viewControllerSaveMethod'
}]);

By default the tools will be accessible via keyboard, with the exception of automatically added collapse/expand and close tools.

If you implement keyboard equivalents of your tools' actions elsewhere and do not want the tools to participate in keyboard navigation, you can make them presentational instead:

panel.addTool({
    type: 'mytool',
    focusable: false,
    ariaRole: 'presentation'
    // ...
});

Parameters

afterRender

template tpl

let element = document.body.querySelector('ext-lockedgrid');
element.afterRender();

This method is called after the component is initially added to the DOM. If this component <ext-container/> other components, the afterRender method for child components is called before the parent's afterRender.

Implementations of this method should avoid reading from the DOM but are free to write to the DOM as needed. To read the DOM, consider implementing onRender instead.

This method is not generally needed because components always have their own DOM element and these are maintained by config property updaters prior to insertion in the DOM. In general, it is always best to manipulate the component's elements outside the DOM where there is no associated reflow or layout cost. This method is useful for situations where the component's elements must be in the DOM in order to be manipulated correctly.

Available since: 6.5.0

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

animateActiveItem ( activeItem, animation )

let element = document.body.querySelector('ext-lockedgrid');
element.animateActiveItem(activeItem, animation);

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

Parameters

applyMasked ( masked ) : Object

let element = document.body.querySelector('ext-lockedgrid');
let applyMasked = element.applyMasked(masked);

Changes the masked configuration when its setter is called, which will convert the value into a proper object/instance of <ext-mask/>/<ext-loadmask/>. If a mask already exists, it will use that instead.

Parameters

Returns

bubble ( fn, [scope], [args] )

let element = document.body.querySelector('ext-lockedgrid');
element.bubble(fn, scope, args);

Bubbles up the getRefOwner hierarchy, 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 bubble is stopped.

Parameters