ExtReact Docs Help

Introduction

The documentation for the ExtReact product diverges somewhat from the documentation of other Sencha products. The sections below describe documentation for all products except where indicated as unique to ExtReact.

Terms, Icons, and Labels

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

ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.

Access Levels

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

Member Types

Member Syntax

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

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

Member Flags

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

Class Icons

- Indicates a framework class

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

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

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

Member Icons

- Indicates a class member of type config

Or in the case of an ExtReact component class this indicates a member of type prop

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

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

Class Member Quick-Nav Menu

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

Getter and Setter Methods

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

ExtReact component classes do not hoist the getter / setter methods into the prop. All methods will be described in the Methods section

History Bar

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

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

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

Search and Filters

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

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

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

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

API Doc Class Metadata

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

Expanding and Collapsing Examples and Class Members

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

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

Desktop -vs- Mobile View

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

Viewing the Class Source

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

ExtReact 6.5.1


top

FormPanel Ext.form.Panel

Summary

The Form panel presents a set of form fields and provides convenient ways to load and save data. Usually a form panel just contains the set of fields you want to display.

Loading data

You can load data into forms in a few different ways, the easiest is to use setValues:

form.setValues({
    name: 'Peter',
    email: 'peter.venkman@gb.com',
    password: 'secret'
});

It's also easy to load Ext.data.Model instances into a form.

Retrieving form data

Getting data out of the form panel is simple and is usually achieve via the getValues method:

var values = form.getValues();

//values now looks like this:
{
    name: 'Peter',
    email: 'peter.venkman@gb.com',
    password: 'secret'
}

It's also possible to listen to the change events on individual fields to get more timely notification of changes that the user is making. Here we expand on the example above with the User model, updating the model as soon as any of the fields are changed:

Setting multiple errors on fields

While you can call Ext.field.Field#markInvalid and Ext.field.Field#clearInvalid on each field, in your form, FormPanel provides a setErrors method that will apply an Object of error states to multiple fields with one call:

 formpanel.setErrors({
     field1: 'field1 is in error',               // markInvalid on the field
     name2: 'field2 is in error',                // markInvalid on the field
     fieldname3: null,                           // clearInvalid on the field
     fieldname4: [ 'one', 'two', 'three' },      // multiple errors on one field
     ...
 });

While you can call Ext.field.Field#getActiveErrors on each field in the form to query the form for errors, you can call getErrors on the form to get an array of error states, suitable to pass into setErrors.

NOTE: these methods will only work on fields that are named.

Submitting forms

There are a few ways to submit form data. In our example above we have a Model instance that we have updated, giving us the option to use the Model's save method to persist the changes back to our server, without using a traditional form submission. Alternatively, we can send a normal browser form submit using the method method:

form.submit({
    url: 'url/to/submit/to',
    method: 'POST',
    success: function() {
        alert('form submitted successfully!');
    }
});

In this case we provided the url to submit the form to inside the submit call - alternatively you can just set the url configuration when you create the form. We can specify other parameters (see method for a full list), including callback functions for success and failure, which are called depending on whether or not the form submission was successful. These functions are usually used to take some action in your app after your data has been saved to the server side.

Children

The following Components (and their sub-components) may be included as children of FormPanel:
String
Object
No members found using the current filters

props

Optional Props

activeChildTabIndex : Number
immutable imm

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

Defaults to:

0

activeItem : Object / String / Number

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 passes a string, it will be assumed to be a Ext.ComponentQuery selector.

Defaults to:

0

allowFocusingDisabledChildren : Boolean
immutable imm

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

Defaults to:

false

alwaysOnTop : Boolean / Number

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
immutable imm

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

Defaults to:

false

api : Object

If specified, load and submit (see formpanel) actions will be loaded and submitted via Ext Direct. Methods which have been imported by Ext.direct.Manager can be specified here to load and submit forms.

API methods may also be specified as strings and will be parsed into the actual functions when the first submit or load has occurred.

For example, instead of the following:

 api: {
     load: App.ss.MyProfile.load,
     submit: App.ss.MyProfile.submit
 }

You can use strings:

 api: {
     load: 'App.ss.MyProfile.load',
     submit: 'App.ss.MyProfile.submit'
 }

You can also use a prefix instead of fully qualified function names:

 api: {
     prefix: 'App.ss.MyProfile',
     load: 'load',
     submit: 'submit'
 }

Load actions can use paramOrder or paramsAsHash to customize how the load method is invoked.

For formpanel, submit actions will always use a standard form submit. The formHandler configuration (see Ext.direct.RemotingProvider#action) must be set on the associated server-side method which has been imported by Ext.direct.Manager.

Defaults to:

null

ariaAttributes : Object

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

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

ariaDescribedBy : String
immutable imm

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

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

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.

autoDestroy : Boolean

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

Defaults to:

true

autoSize : Boolean

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

<Container
    height={200}
    width={200}
    style="background: green"
>
    <Component
        style="background: yellow"
        height="50%"
        width="50%"
    />
</Container>

All browsers except for Safari render the previous example correctly, but Safari does not assign a height to the component. To make percentage-sized children 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

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

baseParams : Object

Optional set of params to be sent.

For formpanel this only applies when standardSubmit is set to false.

Defaults to:

null

bodyBorder : Boolean
immutable imm

  • 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

bodyPadding : Number / Boolean / String
immutable imm

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.

Defaults to:

null

bodyStyle : String / Object

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

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

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

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

Defaults to:

false

bottom : Number / String

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

buttons : Object / Ext.Button[]
immutable imm

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

<Panel
    html="hello world"
    padding={20}
    buttons={{
        ok: {
            text: "OK",
            handler: this.onOK
        }
    }}
/>

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

<Panel
    html="hello world"
    padding={20}
    buttons={{
        ok: this.onOk,
        cancel: this.onCancel
    }}
/>

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

Defaults to:

null

Available since: 6.5.0

centered : Boolean

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

closable : Boolean
immutable imm

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

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

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

Defaults to:

null

closeAction : String
immutable imm

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

  • 'destroy' :

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

  • 'hide' :

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

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

Defaults to:

'destroy'

closeToolText : String
immutable imm

Text to be announced by screen readers when the close tool 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[]

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

Defaults to:

null

collapsed : Boolean

true to start collapsed.

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

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.

Available since: 6.5.0

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

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

contentEl : Ext.dom.Element / HTMLElement / String

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

data : Object

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

Defaults to:

null

defaultFocus : String

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

defaults : Object

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 children with similar configurations. For example here we can specify that each child has a height of 20px and avoid repeating the declaration for each one:

<Container
    fullscreen
    defaults={{
        height: 20
    }}
>
    <Panel>Panel 1</Panel>
    <Panel>Panel 2</Panel>
</Container>

Defaults to:

null

disabled : Boolean

Whether or not this component is disabled

Defaults to:

null

displayed : Boolean

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

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

Configuration options to make this Component draggable

Defaults to:

null

enableSubmissionForm : Boolean

The submission form is generated but never added to the dom. It is a submittable version of your form panel, allowing for fields that are not simple text-fields to be properly submitted to servers. It will also send values that are easier to parse with server side code.

If this is false we will attempt to subject the raw form inside the form panel.

Defaults to:

true

enctype : String

The enctype attribute for the form, specifies how the form should be encoded when submitting

Defaults to:

null

factoryConfig : Object
readonly ro

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

fieldSeparators : Boolean

Set to true to show separators between the fields in this form. Typically used together with inputBorders to create iOS-like forms

Defaults to true in the iOS theme

Defaults to:

false

flex : Number / String / Object

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
}

floated : Boolean

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

focusCls : String
immutable imm

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

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

focusEl : Ext.dom.Element
readonly ro

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'

focusableContainer : Boolean
immutable imm

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

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

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

hasCollapsible : Boolean
readonly ro

true if this panel has the collapsible override added.

Defaults to:

true

Available since: 6.5.0

hasResizable : Boolean
readonly ro

true if this panel has the resizable override added.

Defaults to:

true

Available since: 6.5.0

header : Boolean / Object
immutable imm

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.panel.Header for all the options that may be specified here.

Defaults to:

null

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

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

Defaults to:

'top'

Available since: 6.5.0

height : Number / String

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

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

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'

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

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

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

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

Defaults to:

null

icon : String
immutable imm

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

iconCls : String
immutable imm

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:

Defaults to:

null

id : String
immutable imm

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

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

innerCls : String

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

inputBorders : Boolean

false to suppress borders on the input elements of fields in this form. Typically used together with fieldSeparators to create iOS-like forms.

Defaults to false in the iOS theme

Defaults to:

true

isContainer : Boolean
readonly ro

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

Defaults to:

true

isObservable : Boolean
readonly ro

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

Defaults to:

true

itemId : String

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

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

keyMap : Object

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

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

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

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

Properties

scope : String

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

keyMapEnabled : Boolean

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

layout : Object / String

Configuration for this Container's layout. Example:

<Container
    layout={{
        type: "hbox",
        align: "middle"
    }}
>
    <Panel
        html="hello"
        flex={1}
        bodyStyle={{
            background: "#000",
            color: "#fff"
        }}
    />
    <Panel
        html="world"
        flex={2}
        bodyStyle={{
            background: "#f00",
            color: "#fff"
        }}
    />
</Container>

Defaults to:

'auto'

left : Number / String

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

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 protected pro

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:

false

margin : Number / String

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 / Object / Ext.Mask / Ext.LoadMask

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

<Container
    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, mask and unmask, to allow you to mask and unmask this container at any time.

Defaults to:

null

maxHeight : Number / String

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

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

method : String

The method which this form will be submitted. post or get.

Defaults to:

'post'

minHeight : Number / String

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

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

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

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

multipartDetection : Boolean

If this is enabled the form will automatically detect the need to use 'multipart/form-data' during submission.

Defaults to:

true

name : String
immutable imm

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

Defaults to:

null

nameHolder : Boolean
immutable imm

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

Defaults to:

true

nameable : Boolean
immutable imm

Forms can be assigned names to be used in parent forms.

Defaults to:

true

padding : Number / String

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

paramOrder : String / String[]

A list of params to be executed server side. Only used for the api config.

Specify the params in the order in which they must be executed on the server-side as either (1) a String[], or (2) a String of params delimited by either whitespace, comma, or pipe.

For example, any of the following would be acceptable:

paramOrder: ['param1','param2','param3']
paramOrder: 'param1 param2 param3'
paramOrder: 'param1,param2,param3'
paramOrder: 'param1|param2|param'

Defaults to:

null

paramsAsHash : Boolean

If true, parameters will be sent as a single hash collection of named arguments. Providing a paramOrder nullifies this configuration.

Only used for the api config.

Defaults to:

null

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

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

Plugins should derive from Ext.plugin.Abstract but this is not required. The only requirement for a valid plugin is that it contain an init() method that accepts a reference to the owning component.

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

Example code

A plugin by alias:

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

     plugins: 'listpaging'
 });

Multiple plugins by alias:

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

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

Single plugin by class name with config options:

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

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

Multiple plugins by type and class name with config options:

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

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

record : Ext.data.Model

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

referenceHolder : Boolean
immutable imm

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

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

resetFocusPosition : Boolean
immutable imm

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

A configuration for a Ext.panel.Resizer.

Available since: 6.5.0

right : Number / String

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

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

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

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:

true

selfAlign : String

Specifies the self alignment of this widget in a box layout

shadow : Boolean

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.

Available since: 6.2.0

shareableName : Boolean
immutable imm

Forms can be assigned the same name as other forms in their parent form. This means that if a form is assigned a name it will be returned as an array from lookupName in its parent form.

Defaults to:

true

shim : Boolean

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

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

standardSubmit : Boolean

Whether or not we want to perform a standard form submit.

Defaults to:

false

style : String / Object

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

submitOnAction : Object

When this is set to true, the form will automatically submit itself whenever the action event fires on a field in this form. The action event usually fires whenever you press go or enter inside a textfield.

Defaults to:

false

tabIndex : Number

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

timeout : Number

Timeout for server actions (in seconds).

Defaults to:

30

title : String / Ext.panel.Title
immutable imm

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

Defaults to:

null

toFrontOnShow : Boolean

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

Defaults to:

true

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

An array of Ext.panel.Tool configs/instances to be added to the header tool area. The tools are stored as child components of the header container.

Defaults to:

null

top : Number / String

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
immutable imm

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:

true

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

A string, array of strings, or a function that returns JSX.

tpl = data =>

{data.first_name} {data.last_name}

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

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'

trackResetOnLoad : Boolean

If set to true, reset() resets to the last loaded or setValues() data instead of when the form was first created.

Defaults to:

false

ui : String / String[]
immutable imm

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:

true

url : String

The default URL for server actions (load and submit in formpanel).

Defaults to:

null

userCls : String / String[]
immutable imm

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:

true

userSelectable : Boolean / String / Object

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,       // optionally allow the element to be user selectable
     bodyElement: true    // optionally allow the component's body element to be user selectable
 }

Defaults to:

false

Available since: 6.5.1

weight : Number

This value controls this item's order in a weighted 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

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

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

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 by specifying the alias config option with a prefix of widget. For example:

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

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

Defaults to:

"component"

y : Number

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

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

children

tooltip : String / Object

The ToolTip for this component.

<Button text="Basic Tip">
    <ToolTip>A simple tooltip</ToolTip>
</Button>

Defaults to:

null

methods

Instance Methods

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

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

eventName :  String/Object

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

fn :  Function/String (optional)

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

scope :  Object (optional)

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

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

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

delay :  Number

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

single :  Boolean

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

buffer :  Number

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

onFrame :  Number

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

target :  Ext.util.Observable

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

element :  String

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

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

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

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

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

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Combining Options

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

A delayed, one-time listener.

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

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

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

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

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

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

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

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

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

Example:

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

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

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

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

Parameters

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

The item to which to add a listener/listeners.

ename :  Object/String

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

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

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

options :  Object (optional)

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

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

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

plugin :  Object/String/Ext.plugin.Abstract

The plugin or config object or alias to add.

child ( [selector] ) : Ext.Component

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

Parameters

selector :  String/Ext.Component (optional)

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

Returns

:Ext.Component

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

clearErrors Ext.field.Manager

Marks all named fields as valid by calling setError() on each.

Returns

:Ext.field.Manager

this

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

destroyPlugin ( plugin ) : Ext.plugin.Abstract

Removes and destroys a plugin.

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

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

down ( [selector] ) : Ext.Component

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

Parameters

selector :  String/Ext.Component (optional)

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

Returns

:Ext.Component

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

enableBubble ( eventNames )

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

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

Example:

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

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

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

Parameters

eventNames :  String/String[]

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

findPlugin ( type ) : Ext.plugin.Abstract

Retrieves plugin by its type alias. For example:

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

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

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

Note: See also getPlugin.

Available since: 6.2.0

Parameters

type :  String

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

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

fireEvent ( eventName, args ) : Boolean

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

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

Parameters

eventName :  String

The name of the event to fire.

args :  Object...

Variable number of parameters are passed to handlers.

Returns

:Boolean

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

fireEventArgs ( eventName, args ) : Boolean

Fires the specified event with the passed parameter list.

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

Parameters

eventName :  String

The name of the event to fire.

args :  Object[]

An array of parameters which are passed to handlers.

Returns

:Boolean

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

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

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

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

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function/String

The action function.

scope :  Object (optional)

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

fnArgs :  Array/Boolean (optional)

Optional arguments for the action fn. If not given, the normal args will be used to call fn. If false is passed, the args are used but if the first argument is this instance it will be removed from the args passed to the action function.

focus ( [selectText] ) : Boolean

Try to focus this component.

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

Parameters

selectText :  Boolean/Number[] (optional)

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

Returns

:Boolean

true if focus target was found and focusing was attempted, false if no focusing attempt was made.

getBorder : Boolean

Sets the value of border

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

Sets the value of collapsible

getErrors

Gets error state for all named fields of the form.

The Object returned is exactly the same as one that can be passed to setErrors.

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

Sets the value of hideMode

getHtml : String / Ext.dom.Element / HTMLElement

Sets the value of html

getId String

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

Returns

:String

id

getInherited ( [inner] ) : Object

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

Available since: 5.0.0

Parameters

inner :  Boolean (optional)

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

Defaults to: false

Returns

:Object

The inheritedState object containing inherited properties.

getInheritedConfig ( property, [skipThis] ) : Mixed

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

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

Available since: 5.0.0

Parameters

property :  String

The name of the config property to return.

skipThis :  Boolean (optional)

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

Defaults to: false

Returns

:Mixed

The value of the requested property.

getNamedItems Object

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

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

 onClick: function () {
     var items = this.getNamedItems();

     // using "items" we can access any descendant by its "name"

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

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

Available since: 6.5.0

Returns

:Object

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

getPlugin ( id ) : Ext.plugin.Abstract

Retrieves a plugin by its id.

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

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

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

Note: See also findPlugin.

Available since: 6.2.0

Parameters

id :  String

The id of the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

getReferences Object

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

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

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

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

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

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

Available since: 5.0.0

Returns

:Object

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

getShim : Boolean

Sets the value of shim

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

getValues ( [enabled], [all] ) : Object

Returns an object containing the value of each field in the form, keyed to the field's name. For groups of checkbox fields with the same name, it will be arrays of values. For example:

{
    name: "Jacky Nguyen", // From a TextField
    favorites: [
        'pizza',
        'noodle',
        'cake'
    ]
}

Parameters

enabled :  Boolean (optional)

true to return only enabled fields.

all :  Boolean (optional)

true to return all fields even if they don't have a name configured.

Returns

:Object

Object mapping field name to its value.

getX : Number

Sets the value of x

getY : Number

Sets the value of y

hasListener ( eventName ) : Boolean

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

Parameters

eventName :  String

The name of the event to check for

Returns

:Boolean

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

isAncestor ( possibleDescendant )

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

Parameters

possibleDescendant :  Ext.Component

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

isDescendantOf ( ancestor ) : Boolean

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

Parameters

ancestor :  Ext.Component

A Component which may contain this Component.

Returns

:Boolean

true if the component is the descendant of the passed component, otherwise false.

isFocusable ( [deep] ) : Boolean

Determine if this Focusable can receive focus at this time.

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

Parameters

deep :  Boolean (optional)

Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.

Defaults to: false

Returns

:Boolean

True if component is focusable, false if not.

isSuspended ( [event] ) : Boolean

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

Parameters

event :  String (optional)

The name of the specific event to check

Returns

:Boolean

true if events are suspended

isValid Boolean

Test to see if the form has any invalid fields.

NOTE This method does not validate the fields, it only returns true if any field is already marked invalid using the field's isValid. If field values need to be validated, validate should be used instead.

Returns

:Boolean

true if all fields are currently valid.

lookup ( ref ) : Ext.Component

Gets a reference to the component with the specified reference value.

The method is a short-hand for the lookupReference method.

Available since: 6.0.1

Parameters

ref :  String

The value of the reference to lookup.

Returns

:Ext.Component

The referenced component or null if it is not found.

lookupName ( name ) : Ext.Component

Gets a reference to the component with the specified name property.

Available since: 6.5.0

Parameters

name :  String

The name of the descendant to lookup.

Returns

:Ext.Component

The component or null if it is not found.

lookupReferences ( ref ) : Ext.Component

Gets a reference to the component with the specified reference value.

The lookup method is a short-hand version of this method.

Available since: 5.0

Parameters

ref :  String

The name of the reference to lookup.

Returns

:Ext.Component

The referenced component or null if it is not found.

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

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

Example:

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

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

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

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

Parameters

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

The item to which to add a listener/listeners.

ename :  Object/String

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

fn :  Function/String (optional)

If the ename parameter was an event name, this is the handler function or the name of a method on the specified scope.

scope :  Object (optional)

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

options :  Object (optional)

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

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

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

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

Parameters

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

The item from which to remove a listener/listeners.

ename :  Object/String

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

fn :  Function (optional)

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

scope :  Object (optional)

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

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

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

eventName :  String/Object

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

fn :  Function/String (optional)

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

scope :  Object (optional)

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

options :  Object (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope :  Object

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

delay :  Number

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

single :  Boolean

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

buffer :  Number

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

onFrame :  Number

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

target :  Ext.util.Observable

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

element :  String

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

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

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

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

 panel.body.un(...)

delegate :  String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture :  Boolean (optional)

When set to true, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopPropagation on the event object before firing the handler.

preventDefault :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call preventDefault on the event object before firing the handler.

stopEvent :  Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. true to call stopEvent on the event object before firing the handler.

args :  Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable :  Boolean (optional)

When specified as true, the function returns a destroyable object. An object which implements the destroy method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to:

false

priority :  Number (optional)

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

order :  String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the priority option instead. Available options are:

  • 'before': equal to a priority of 100
  • 'current': equal to a priority of 0 or default priority
  • 'after': equal to a priority of -100

Defaults to:

'current'

order :  String (optional)

A shortcut for the order event option. Provided for backward compatibility. Please use the priority event option instead.

Combining Options

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

A delayed, one-time listener.

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

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

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

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

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

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

Defaults to: 'current'

Returns

:Object

Only when the destroyable option is specified.

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

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

And when those listeners need to be removed:

Ext.destroy(this.btnListeners);

or

this.btnListeners.destroy();

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

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

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

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

Same as addListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event to listen for.

fn :  Function/String

The method the event invokes.

scope :  Object (optional)

The scope for fn.

options :  Object (optional)

An object containing handler configuration.

query ( [selector] ) : Ext.Component[]

Retrieves all descendant components which match the passed selector. Executes an Ext.ComponentQuery.query using this container as its root.

Parameters

selector :  String (optional)

Selector complying to an Ext.ComponentQuery selector. If no selector is specified all items will be returned.

Returns

:Ext.Component[]

Components which matched the selector

queryBy ( fn, [scope] ) : Ext.Component[]

Retrieves all descendant components which match the passed function. The function should return false for components that are to be excluded from the selection.

Parameters

fn :  Function

The matcher function. It will be called with a single argument, the component being tested.

scope :  Object (optional)

The scope in which to run the function. If not specified, it will default to the active component.

Returns

:Ext.Component[]

Components matched by the passed function

queryById ( id ) : Ext.Component

Finds a component at any level under this container matching the id/itemId. This is a shorthand for calling ct.down('#' + id);

Parameters

id :  String

The id to find

Returns

:Ext.Component

The matching id, null if not found

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

Relays selected events from the specified Observable as if the events were fired by this.

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

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

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

Parameters

origin :  Object

The Observable whose events this object is to relay.

events :  String[]/Object

Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});

Would now redispatch the add event of this as a push event and the remove event as a pop event.

prefix :  String (optional)

A common prefix to prepend to the event names. For example:

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

Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

:Object

A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

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

Can be undone by calling

Ext.destroy(this.storeRelayers);

or this.store.relayers.destroy();

removeListener ( eventName, fn, [scope] )

Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

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

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

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

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

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

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

Removes listeners that were added by the mon method.

Parameters

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

The item from which to remove a listener/listeners.

ename :  Object/String

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

fn :  Function (optional)

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

scope :  Object (optional)

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

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

Removes and (optionally) destroys a plugin.

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

Available since: 6.2.0

Parameters

plugin :  String/Ext.plugin.Abstract

The plugin or its id to remove.

destroy :  Boolean (optional)

Pass true to not call destroy() on the plugin.

Returns

:Ext.plugin.Abstract

plugin instance or null if not found.

resumeEvent ( eventName )

Resumes firing of the named event(s).

After calling this method to resume events, the events will fire when requested to fire.

Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to resume.

resumeEvents ( [discardQueue] )

Resumes firing events (see suspendEvents).

If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

Parameters

discardQueue :  Boolean (optional)

true to prevent any previously queued events from firing while we were suspended. See suspendEvents.

setActiveItem ( activeItem )

Returns the value of activeItem

setAlwaysOnTop ( alwaysOnTop )

Returns the value of alwaysOnTop

setApi ( api )

Returns the value of api

setAriaAttributes ( ariaAttributes )

Returns the value of ariaAttributes

setAutoDestroy ( autoDestroy )

Returns the value of autoDestroy

setAutoSize ( autoSize )

Returns the value of autoSize

setAxisLock ( axisLock )

Returns the value of axisLock

setBaseParams ( baseParams )

Returns the value of baseParams

setBodyStyle ( bodyStyle )

Returns the value of bodyStyle

setBorder ( border )

Returns the value of border

setBottom ( bottom )

Returns the value of bottom

setCentered ( centered )

Returns the value of centered

setCls ( cls )

Returns the value of cls

setCollapsed ( collapsed )

Returns the value of collapsed

setCollapsible ( collapsible )

Returns the value of collapsible

setConstrainAlign ( constrainAlign )

Returns the value of constrainAlign

setContentEl ( contentEl )

Returns the value of contentEl

setControl ( control )

Returns the value of control

setData ( data )

Returns the value of data

setDefaultFocus ( defaultFocus )

Returns the value of defaultFocus

setDefaultType ( defaultType )

Returns the value of defaultType

setDefaults ( defaults )

Returns the value of defaults

setDisabled ( disabled )

Returns the value of disabled

setDisplayed ( displayed )

Returns the value of displayed

setDocked ( docked )

Returns the value of docked

setDraggable ( draggable )

Returns the value of draggable

setEnableSubmissionForm ( enableSubmissionForm )

Returns the value of enableSubmissionForm

setEnctype ( enctype )

Returns the value of enctype

setErrors ( errors ) : Ext.field.Manager

Marks multiple fields valid or invalid based upon an Object of error states

Each key of the error states Object is the name of the field whose validity status is to be affected. Each value of the error states Object is either a string or array of strings to set as the field's invalid message(s). If the value is null or an empty array, the field is marked valid instead of invalid.

Parameters

errors :  Object

The errors to set child fields with.

Returns

:Ext.field.Manager

this

setFieldSeparators ( fieldSeparators )

Returns the value of fieldSeparators

setFlex ( flex )

Returns the value of flex

setFloated ( floated )

Returns the value of floated

setHeight ( height )

Returns the value of height

setHidden ( hidden )

Returns the value of hidden

setHideAnimation ( hideAnimation )

Returns the value of hideAnimation

setHideMode ( hideMode )

Returns the value of hideMode

setHideOnMaskTap ( hideOnMaskTap )

Returns the value of hideOnMaskTap

setHtml ( html )

Returns the value of html

setInnerCls ( innerCls )

Returns the value of innerCls

setInputBorders ( inputBorders )

Returns the value of inputBorders

setItemId ( itemId )

Returns the value of itemId

setItems ( items )

Returns the value of items

setKeyMap ( keyMap )

Returns the value of keyMap

setKeyMapEnabled ( keyMapEnabled )

Returns the value of keyMapEnabled

setLayout ( layout )

Returns the value of layout

setLeft ( left )

Returns the value of left

setListeners ( listeners )

An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.

Parameters

listeners :  Object

The listeners

setMargin ( margin )

Returns the value of margin

setMasked ( masked )

Returns the value of masked

setMaxHeight ( maxHeight )

Returns the value of maxHeight

setMaxWidth ( maxWidth )

Returns the value of maxWidth

setMethod ( method )

Returns the value of method

setMinHeight ( minHeight )

Returns the value of minHeight

setMinWidth ( minWidth )

Returns the value of minWidth

setModal ( modal )

Returns the value of modal

setMultipartDetection ( multipartDetection )

Returns the value of multipartDetection

setPadding ( padding )

Returns the value of padding

setParamOrder ( paramOrder )

Returns the value of paramOrder

setParamsAsHash ( paramsAsHash )

Returns the value of paramsAsHash

setPlugins ( plugins )

Returns the value of plugins

setRecord ( record )

Returns the value of record

setRelative ( relative )

Returns the value of relative

setResizable ( resizable )

Returns the value of resizable

setRight ( right )

Returns the value of right

setRipple ( ripple )

Returns the value of ripple

setScrollable ( scrollable )

Returns the value of scrollable

setSelfAlign ( selfAlign )

Returns the value of selfAlign

setShadow ( shadow )

Returns the value of shadow

setShim ( shim )

Returns the value of shim

setShowAnimation ( showAnimation )

Returns the value of showAnimation

setStandardSubmit ( standardSubmit )

Returns the value of standardSubmit

setStyle ( style )

Returns the value of style

setSubmitOnAction ( submitOnAction )

Returns the value of submitOnAction

setTabIndex ( newTabIndex )

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

Parameters

newTabIndex :  Number

new tabIndex to set

setTimeout ( timeout )

Returns the value of timeout

setToFrontOnShow ( toFrontOnShow )

Returns the value of toFrontOnShow

setTooltip ( tooltip )

Returns the value of tooltip

setTop ( top )

Returns the value of top

setTpl ( tpl )

Returns the value of tpl

setTplWriteMode ( tplWriteMode )

Returns the value of tplWriteMode

setTrackResetOnLoad ( trackResetOnLoad )

Returns the value of trackResetOnLoad

setUrl ( url )

Returns the value of url

setUserSelectable ( userSelectable )

Returns the value of userSelectable

setValues ( values ) : Ext.form.Panel

Sets the values of form fields in bulk. Example usage:

myForm.setValues({
    name: 'Ed',
    crazy: true,
    username: 'edspencer'
});

If there groups of checkbox fields with the same name, pass their values in an array. For example:

myForm.setValues({
    name: 'Jacky',
    crazy: false,
    hobbies: [
        'reading',
        'cooking',
        'gaming'
    ]
});

Parameters

values :  Object

field name => value mapping object.

Returns

:Ext.form.Panel

This form.

setWeight ( weight )

Returns the value of weight

setWidth ( width )

Returns the value of width

setX ( x )

Returns the value of x

setY ( y )

Returns the value of y

setZIndex ( zIndex )

Returns the value of zIndex

submit ( options ) : Ext.data.Connection

Performs a Ajax-based submission of form values (if standardSubmit is false) or otherwise executes a standard HTML Form submit action.

Notes

  1. Only the first parameter is implemented. Put all other parameters inside the first parameter:

    submit({params: "" ,headers: "" etc.})

  2. Submit example:

    myForm.submit({ url: 'PostMyData/To', method: 'Post', success: function() { Ext.Msg.alert("success"); }, failure: function() { Ext.Msg.alert("error"); } });

  3. Parameters and values only submit for a POST and not for a GET.

Parameters

options :  Object

The configuration when submitting this form.

The following are the configurations when submitting via Ajax only:

url :  String

The url for the action (defaults to the form's url).

method :  String

The form method to use (defaults to the form's method, or POST if not defined).

headers :  Object

Request headers to set for the action.

autoAbort :  Boolean (optional)

true to abort any pending Ajax request prior to submission. Note: Has no effect when standardSubmit is enabled.

Defaults to:

false

timeout :  Number

The number is seconds the loading will timeout in.

The following are the configurations when loading via Ajax or Direct:

params :  String / Object

The params to pass when submitting this form (defaults to this forms baseParams). Parameters are encoded as standard HTTP parameters using Ext#urlEncode.

submitDisabled :  Boolean (optional)

true to submit all fields regardless of disabled state. Note: Has no effect when standardSubmit is enabled.

Defaults to:

false

waitMsg :  String / Object (optional)

If specified, the value which is passed to the loading mask. See masked for more information.

success :  Function

The callback that will be invoked after a successful response. A response is successful if a response is received from the server and is a JSON object where the success property is set to true, {"success": true}.

The function is passed the following parameters and can be used for submitting via Ajax or Direct:

form :  Ext.form.Panel

The FormPanel that requested the action.

result :  Object/Ext.direct.Event

The result object returned by the server as a result of the submit request. If the submit is sent using Ext Direct, this will return the Ext.direct.Event instance, otherwise will return an Object.

data :  Object

The parsed data returned by the server.

failure :  Function

The callback that will be invoked after a failed transaction attempt.

The function is passed the following parameters and can be used for submitting via Ajax or Direct:

form :  Ext.form.Panel

The FormPanel that requested the submit.

result :  Ext.form.Panel

The failed response or result object returned by the server which performed the operation.

scope :  Object

The scope in which to call the callback functions (The this reference for the callback functions).

Returns

:Ext.data.Connection

The request object if the standardSubmit config is false. If the standardSubmit config is true, then the return value is undefined.

suspendEvent ( eventName )

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

Parameters

eventName :  String...

Multiple event names to suspend.

suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended :  Boolean

true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

un ( eventName, fn, [scope] )

Shorthand for removeListener. Removes an event handler.

Parameters

eventName :  String

The type of event the handler was associated with.

fn :  Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope :  Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener destroyable: true config option in place of calling un(). For example:

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

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

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

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

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

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

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

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

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Parameters

eventName :  String/String[]/Object

The name of the event the handler was associated with.

fn :  Function/String

The handler to remove.

scope :  Object (optional)

The scope originally specified for fn.

options :  Object (optional)

Extra options object.

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

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

Example:

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

Parameters

selector :  String (optional)

The simple selector to test.

limit :  String/Number/Ext.Component (optional)

This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

Returns

:Ext.Container

The matching ancestor Container (or undefined if no match was found).

validate Boolean

Calls validate on each field in the form.

Note This will validate the field's current value. If you want to check if all the fields are currently valid without validating the fields value, isValid should be used instead.

Returns

:Boolean

true if all fields in the form are valid, false if any one (or more) of the fields is invalid.

visitPostOrder ( selector, fn, [scope], [extraArgs] )

Traverses the tree rooted at this node in post-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node after being called on its children).

This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.

If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.

Parameters

selector :  Object

A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.

fn :  Function

The function to call. Return false to aborl the traverse.

node :  Object

The node being visited.

scope :  Object (optional)

The context (this reference) in which the function is executed.

extraArgs :  Array (optional)

A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.

visitPreOrder ( selector, fn, [scope], [extraArgs] )

Traverses the tree rooted at this node in pre-order mode, calling the passed function on the nodes at each level. That is the function is called upon each node before being called on its children).

This method is used at each level down the cascade. Currently Ext.Components and Ext.data.TreeModels are queryable.

If you have tree-structured data, you can make your nodes queryable, and use ComponentQuery on them.

Parameters

selector :  Object

A ComponentQuery selector used to filter candidate nodes before calling the function. An empty string matches any node.

fn :  Function

The function to call. Return false to aborl the traverse.

node :  Object

The node being visited.

scope :  Object (optional)

The context (this reference) in which the function is executed.

extraArgs :  Array (optional)

A set of arguments to be appended to the function's argument list to pass down extra data known to the caller after the node being visited.

Static Methods

override ( members ) : Ext.Base
static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

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

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

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

Direct use of this method should be rare. Use Ext.define instead:

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

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base

this class

events

onActivate : function ( newActiveItem, this, oldActiveItem, eOpts )

Fires whenever item within the Container is activated.

Parameters

newActiveItem :  Object

The new active item within the container.

this :  Ext.Container

The Container instance.

oldActiveItem :  Object

The old active item within the container.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onActiveItemChange : function ( sender, value, oldValue, eOpts )

This event fires when activeItem changes.

Parameters

sender :  Ext.Container

The instance firing this event.

value :  Object/String/Number

The current value of activeItem.

oldValue :  Object/String/Number

The previous value of activeItem.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onAdd : function ( this, item, index, eOpts )

Fires whenever item added to the Container.

Parameters

this :  Ext.Container

The Container instance.

item :  Object

The item added to the Container.

index :  Number

The index of the item within the Container.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onAdded : function ( this, container, index, eOpts )

Fires after a Component had been added to a Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Parent Container

index :  Number

The index of the item within the Container.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeActiveItemChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when activeItem changes.

Parameters

sender :  Ext.Container

The instance firing this event.

value :  Object/String/Number

The current value of activeItem.

oldValue :  Object/String/Number

The previous value of activeItem.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeBottomChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeCenteredChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeClose : function ( panel, eOpts )

Fires before the user closes the panel. Return false from any listener to stop the panel from closing.

Parameters

panel :  Ext.Panel

The Panel object

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeCollapse : function ( this, eOpts )

Fires before collapse starts. Return false to cancel collapse.

Available since: 6.5.0

Parameters

this :  Ext.panel.Panel

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeDisabledChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeDockedChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeExpand : function ( this, eOpts )

Fires before expand starts. Return false to cancel expand.

Available since: 6.5.0

Parameters

this :  Ext.panel.Panel

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeflexChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when flex changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String/Object

The current value of flex.

oldValue :  Number/String/Object

The previous value of flex.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeHiddenChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeHide : function ( this, eOpts )

Fires before the Component is hidden. Hide may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeLeftChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMaxHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMaxWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMinHeightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeMinWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeResizeDragStart : function ( this, context, eOpts )

Fires before resize starts. Return false to cancel dragging.

Available since: 6.5.0

Parameters

this :  Ext.Panel

context :  Object

edge :  String

The edge being resized.

event :  Ext.event.Event

The event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeRightChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeScrollableChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeShow : function ( this, eOpts )

Fires before the Component is shown. Show may be vetoed by returning false from a handler.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBeforeSubmit : function ( this, values, options, e, eOpts )
preventable prev

Fires immediately preceding any Form submit action. Implementations may adjust submitted form values or options prior to execution. A return value of false from this listener will abort the submission attempt (regardless of standardSubmit configuration).

Parameters

this :  Ext.form.Panel

This FormPanel.

values :  Object

A hash collection of the qualified form values about to be submitted.

options :  Object

Submission options hash (only available when standardSubmit is false).

e :  Ext.event.Event

The event object if the form was submitted via a HTML5 form submit event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

onBeforeTopChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBeforeWidthChange : function ( sender, value, oldValue, eOpts ) => Boolean

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

Returns

:Boolean

Return false to cancel the change.

onBlur : function ( this, event, eOpts )

Fires when this Component's focusEl loses focus.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The blur event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onBottomChange : function ( sender, value, oldValue, eOpts )

This event fires when bottom changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of bottom.

oldValue :  Number/String

The previous value of bottom.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onCenteredChange : function ( sender, value, oldValue, eOpts )

This event fires when centered changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean

The current value of centered.

oldValue :  Boolean

The previous value of centered.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onClose : function ( panel, eOpts )

Fires when the user closes the panel.

Parameters

panel :  Ext.Panel

The Panel object

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onCollapse : function ( this, eOpts )

Fires when the collapse starts.

Available since: 6.5.0

Parameters

this :  Ext.panel.Panel

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onDeactivate : function ( oldActiveItem, this, newActiveItem, eOpts )

Fires whenever item within the Container is deactivated.

Parameters

oldActiveItem :  Object

The old active item within the container.

this :  Ext.Container

The Container instance.

newActiveItem :  Object

The new active item within the container.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onDestroy

Fires when the component is destroyed

onDisabledChange : function ( sender, value, oldValue, eOpts )

This event fires when disabled changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of disabled.

oldValue :  Boolean

The previous value of disabled.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onDockedChange : function ( sender, value, oldValue, eOpts )

This event fires when docked changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  String

The current value of docked.

oldValue :  String

The previous value of docked.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onDrawerHide : function ( this, eOpts )

Fires then the drawer hides.

Available since: 6.5.0

Parameters

this :  Ext.panel.Panel

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onDrawerShow : function ( this, eOpts )

Fires then the drawer shows.

Available since: 6.5.0

Parameters

this :  Ext.panel.Panel

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onErased : function ( this, eOpts )

Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onException : function ( this, result, eOpts )

Fires when either the Ajax HTTP request reports a failure OR the server returns a success:false response in the result payload.

Parameters

this :  Ext.form.Panel

This FormPanel.

result :  Object

Either a failed Ext.data.Connection request object or a failed (logical) server. response payload.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onExpand : function ( this, eOpts )

Fires when the expand starts.

Available since: 6.5.0

Parameters

this :  Ext.panel.Panel

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFlexChange : function ( sender, value, oldValue, eOpts )

This event fires when flex changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String/Object

The current value of flex.

oldValue :  Number/String/Object

The previous value of flex.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFocus : function ( this, event, eOpts )

Fires when this Component's focusEl receives focus.

Parameters

this :  Ext.Component/Ext.Widget

event :  Ext.event.Event

The focus event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFocusEnter : function ( this, event, eOpts )

Fires when focus enters this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusenter event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFocusLeave : function ( this, event, eOpts )

Fires when focus leaves this Component's hierarchy.

Parameters

this :  Ext.Component

event :  Ext.event.Event

The focusleave event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onFullscreen : function ( this, eOpts )

Fires whenever a Component with the fullscreen config is instantiated

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onHeightChange : function ( sender, value, oldValue, eOpts )

This event fires when height changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of height.

oldValue :  Number/String

The previous value of height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onHiddenChange : function ( sender, value, oldValue, eOpts )

This event fires when hidden changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Boolean

The current value of hidden.

oldValue :  Boolean

The previous value of hidden.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onHide : function ( this, eOpts )

Fires whenever the Component is hidden

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onInitialize : function ( this, eOpts )

Fires when the component has been initialized

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onLeftChange : function ( sender, value, oldValue, eOpts )

This event fires when left changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of left.

oldValue :  Number/String

The previous value of left.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMaxHeightChange : function ( sender, value, oldValue, eOpts )

This event fires when maxHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxHeight.

oldValue :  Number/String

The previous value of maxHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMaxWidthChange : function ( sender, value, oldValue, eOpts )

This event fires when maxWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of maxWidth.

oldValue :  Number/String

The previous value of maxWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMinHeightChange : function ( sender, value, oldValue, eOpts )

This event fires when minHeight changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minHeight.

oldValue :  Number/String

The previous value of minHeight.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMinWidthChange : function ( sender, value, oldValue, eOpts )

This event fires when minWidth changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of minWidth.

oldValue :  Number/String

The previous value of minWidth.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMove : function ( this, item, toIndex, fromIndex, eOpts )

Fires whenever item moved within the Container.

Parameters

this :  Ext.Container

The Container instance.

item :  Object

The item moved within the Container.

toIndex :  Number

The new index of the item.

fromIndex :  Number

The old index of the item.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onMoved : function ( this, container, toIndex, fromIndex, eOpts )

Fires when a component si moved within its Container.

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

toIndex :  Number

The new index of the item.

fromIndex :  Number

The old index of the item.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onPainted : function ( element, eOpts )

Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.

Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly add at least one listener to it, for performance reasons.

Parameters

element :  Ext.dom.Element

The component's outer element (this.element)

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onPositionedChange : function ( this, positioned, eOpts )

Fires whenever there is a change in the positioned status of a component

Parameters

this :  Ext.Component

The component instance

positioned :  Boolean

The component's new positioned state. This becomes true is a component is positioned using the cfg-top, cfg-right, cfg-bottom or cfg-left configs.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onRemove : function ( this, item, index, eOpts )

Fires whenever item removed from the Container.

Parameters

this :  Ext.Container

The Container instance.

item :  Object

The item removed from the Container.

index :  Number

The index of the item that was removed.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onRemoved : function ( this, container, index, eOpts )

Fires when a component is removed from a Container

Parameters

this :  Ext.Component

container :  Ext.Container

Container which holds the component

index :  Number

The index of the item that was removed.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onResize : function ( component, width, height, oldWidth, oldHeight, eOpts )

Fires asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:

Parameters

component :  Ext.Component

This Component.

width :  String/Number

The new width.

height :  String/Number

The new height.

oldWidth :  String/Number

The previous width.

oldHeight :  String/Number

The previous height.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onResizeDrag : function ( this, context, eOpts )

Fires for each tick while a drag is active.

Available since: 6.5.0

Parameters

this :  Ext.Panel

context :  Object

edge :  String

The edge being resized.

event :  Ext.event.Event

The event.

width :  Number

The current resized width in pixels.

height :  Number

The current resized height in pixels.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onResizeDragCancel : function ( this, context, eOpts )

Fires when the drag resize is cancelled.

Available since: 6.5.0

Parameters

this :  Ext.Panel

context :  Object

edge :  String

The edge being resized.

event :  Ext.event.Event

The event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onResizeDragEnd : function ( this, context, eOpts )

Fires when the drag resize is complete.

Available since: 6.5.0

Parameters

this :  Ext.Panel

context :  Object

edge :  String

The edge being resized.

event :  Ext.event.Event

The event.

width :  Number

The final resized width in pixels.

height :  Number

The final resized height in pixels.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onResizeDragStart : function ( this, context, eOpts )

Fires when the resize starts.

Available since: 6.5.0

Parameters

this :  Ext.Panel

context :  Object

edge :  String

The edge being resized.

event :  Ext.event.Event

The event.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onRightChange : function ( sender, value, oldValue, eOpts )

This event fires when right changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of right.

oldValue :  Number/String

The previous value of right.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onScrollableChange : function ( sender, value, oldValue, eOpts )

This event fires when scrollable changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Boolean/String/Object

The current value of scrollable.

oldValue :  Boolean/String/Object

The previous value of scrollable.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onShow : function ( this, eOpts )

Fires whenever the Component is shown

Parameters

this :  Ext.Component

The component instance

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onSubmit : function ( this, result, e, eOpts )
preventable prev

Fires upon successful (Ajax-based) form submission.

Parameters

this :  Ext.form.Panel

This FormPanel.

result :  Object

The result object as returned by the server.

e :  Ext.event.Event

The event object.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

This action following this event is preventable. When any of the listeners returns false, the action is cancelled.

onTopChange : function ( sender, value, oldValue, eOpts )

This event fires when top changes.

Parameters

sender :  Ext.Component

The instance firing this event.

value :  Number/String

The current value of top.

oldValue :  Number/String

The previous value of top.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

onWidthChange : function ( sender, value, oldValue, eOpts )

This event fires when width changes.

Parameters

sender :  Ext.Widget

The instance firing this event.

value :  Number/String

The current value of width.

oldValue :  Number/String

The previous value of width.

eOpts : Object

The options object passed to Ext.util.Observable.addListener.

theme variables

$formpanel-body-background-color : color

FormPanel body background-color

Defaults to:

$background-color

$panel-anchor-background-color : color

Panel anchor background-color

Defaults to:

$panel-body-background-color

$panel-anchor-border-color : color

Panel anchor border-color

Defaults to:

$panel-border-color

$panel-anchor-height : Number

The height (in all orientations) of the anchor arrow

Defaults to:

10px

$panel-anchor-margin : Number

The extra spacing beyond the tip of the anchor arrow to prevent the pointer touching the target;

Defaults to:

1px

$panel-anchor-width : Number

The width (in all orientations) of the anchor arrow.

Defaults to:

20px

$panel-background-color : color

Panel background-color

Defaults to:

$background-color

$panel-body-background-color : color

Panel body background-color

Defaults to:

$panel-background-color

$panel-body-border-color : color

Panel body border-color

Defaults to:

$neutral-medium-dark-color

$panel-body-border-style : Number / list

Panel body border-style

Defaults to:

solid

$panel-body-border-width : Number / list

Panel body border-width

Defaults to:

1px

$panel-body-color : color

Panel body text color

Defaults to:

$color

$panel-body-font-family : String

Panel body font-family

Defaults to:

$font-family

$panel-body-font-size : Number

Panel body font-size

Defaults to:

$font-size

$panel-body-font-size-big : Number

Panel body font-size in the big sizing scheme

Defaults to:

$font-size-big

$panel-body-font-weight : String / Number

Panel body font-weight

Defaults to:

$font-weight-normal

$panel-body-line-height : Number

Panel body line-height

Defaults to:

$line-height

$panel-body-line-height-big : Number

Panel body line-height in the big sizing scheme

Defaults to:

$panel-body-line-height

$panel-body-padding : Number / list

Panel body padding

Defaults to:

null

$panel-body-padding-big : Number / list

Panel body padding in the big sizing scheme

Defaults to:

null

$panel-border-color : color / list

Panel border-color

Defaults to:

$base-color

$panel-border-radius : Number / list

Panel border-radius

Defaults to:

null

$panel-border-radius-big : Number / list

Panel border-radius in the big sizing scheme

Defaults to:

$panel-border-radius

$panel-border-style : String / list

Panel border-style

Defaults to:

solid

$panel-border-width : Number / list

Panel border-width

Defaults to:

1px

$panel-header-background-color : color

Panel Header background-color

Defaults to:

$base-color

$panel-header-background-gradient : String / list

Panel Header background-gradient. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

Defaults to:

null

$panel-header-border-color : color / list

Panel Header border-color

Defaults to:

$panel-border-color

$panel-header-border-style : String / list

Panel Header border-style

Defaults to:

solid

$panel-header-border-width : Number / list

Panel Header border-width

Defaults to:

$panel-border-width

$panel-header-color : color

Panel Header text color

Defaults to:

#fff

$panel-header-font-family : String

Panel Header font-family

Defaults to:

$font-family

$panel-header-font-size : Number

Panel Header font-size

Defaults to:

$font-size

$panel-header-font-size-big : Number

Panel Header font-size in the big sizing scheme

Defaults to:

$font-size-big

$panel-header-font-weight : String / Number

Panel Header font-weight

Defaults to:

$font-weight-bold

$panel-header-icon-color : color

Panel Header icon color.

Defaults to:

rgba($panel-header-color, .5)

$panel-header-icon-font-size : Number

Panel Header icon font-size. Used for configuring the size of font icons

Defaults to:

null

$panel-header-icon-font-size-big : Number

Panel Header icon font-size in the big sizing scheme

Defaults to:

null

$panel-header-icon-horizontal-spacing : Number

The space between the Panel Header icon and text when the icon is horizontally aligned

Defaults to:

6px

$panel-header-icon-horizontal-spacing-big : Number

The space between the Panel Header icon and text when the icon is horizontally aligned in the big sizing scheme

Defaults to:

8px

$panel-header-icon-opacity : Number

Panel Header icon opacity

Defaults to:

null

$panel-header-icon-size : Number

Panel Header icon size

Defaults to:

$panel-header-line-height

$panel-header-icon-size-big : Number

Panel Header icon size in the big sizing scheme

Defaults to:

$panel-header-line-height-big

$panel-header-icon-vertical-spacing : Number

The space between the Panel Header icon and text when the icon is vertically aligned

Defaults to:

2px

$panel-header-icon-vertical-spacing-big : Number

The space between the Panel Header icon and text when the icon is vertically aligned in the big sizing scheme

Defaults to:

2px

$panel-header-line-height : Number

Panel Header line-height

Defaults to:

16px

$panel-header-line-height-big : Number

Panel Header line-height in the big sizing scheme

Defaults to:

24px

$panel-header-min-height : Number

Panel Header min-height

Defaults to:

36px

$panel-header-min-height-big : Number

Panel Header min-height in the big sizing scheme

Defaults to:

44px

$panel-header-padding : Number / list

Panel Header padding

Defaults to:

0 10px

$panel-header-padding-big : Number / list

Panel Header padding in the big sizing scheme

Defaults to:

0 15px

$panel-header-shadow : shadow

Panel Header Shadow

Defaults to:

null

$panel-header-title-opacity : Number

Panel Header Title opacity.

Defaults to:

null

$panel-header-title-padding : Number / list

Panel Header Title padding

Defaults to:

7px 0

$panel-header-title-padding-big : Number / list

Panel Header Title padding in the big sizing scheme

Defaults to:

9px 0

$panel-header-z-index : Number

Z-Index for the Panel Header, should be used with shadows to raise header above content

Defaults to:

null

$panel-light-ui : map

Parameters for the "light" panel UI. Set to null to eliminate the UI from the CSS output.

$panel-manage-borders : String

true to include border management rules

Defaults to:

true

$panel-tool-background-color : color

Panel Tool background-color

Defaults to:

null

$panel-tool-border-radius : Number

Panel Tool border radius

Defaults to:

null

$panel-tool-border-radius-big : Number

Panel Tool border radius in the big sizing scheme

Defaults to:

null

$panel-tool-color : color

Panel Tool color

Defaults to:

$panel-header-color

$panel-tool-cursor : String

Panel Tool cursor

Defaults to:

null

$panel-tool-disabled-background-color : Number

Panel Tool background-color when disabled

Defaults to:

null

$panel-tool-disabled-color : Number

Panel Tool color when disabled

Defaults to:

null

$panel-tool-disabled-cursor : String

Panel Tool cursor when disabled

Defaults to:

null

$panel-tool-disabled-opacity : Number

Panel Tool opacity when disabled

Defaults to:

null

$panel-tool-focused-outline-color : color

Panel Tool outline color when focused

Defaults to:

$panel-header-color

$panel-tool-focused-outline-offset : Number

Panel Tool outline offset when focused

Defaults to:

null

$panel-tool-focused-outline-style : String

Panel Tool outline style when focused

Defaults to:

null

$panel-tool-focused-outline-width : Number

Panel Tool outline width when focused

Defaults to:

null

$panel-tool-font-size : Number

Panel Tool font-size

Defaults to:

$panel-tool-size

$panel-tool-font-size-big : Number

Panel Tool font-size in the big sizing scheme

Defaults to:

$panel-tool-size-big

$panel-tool-hovered-background-color : Number

Panel Tool background-color when hovered

Defaults to:

null

$panel-tool-hovered-color : Number

Panel Tool color when hovered

Defaults to:

null

$panel-tool-hovered-opacity : Number

Panel Tool opacity when hovered

Defaults to:

.6

$panel-tool-opacity : Number

Panel Tool opacity

Defaults to:

.5

$panel-tool-pressed-background-color : Number

Panel Tool background-color when pressed

Defaults to:

null

$panel-tool-pressed-color : Number

Panel Tool color when pressed

Defaults to:

null

$panel-tool-pressed-opacity : Number

Panel Tool opacity when pressed

Defaults to:

.7

$panel-tool-size : Number

Panel Tool size

Defaults to:

null

$panel-tool-size-big : Number

Panel Tool size in the big sizing scheme

Defaults to:

null

$panel-tool-spacing : Number

The space between Panel Tools

Defaults to:

null

$panel-tool-spacing-big : Number

The space between Panel Tools in the big sizing scheme

Defaults to:

null

theme mixins

panel-ui ( ...list... )

Creates a visual theme for a Panel.

Parameters

$ui :  String

The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).

$xtype :  String (optional)

The Ext.Class#xtype to use in CSS selectors. For use by UI mixins of derived classes.

Defaults to: panel

$header-xtype :  String (optional)

The Ext.Class#xtype to use in CSS selectors for the header component. For use by UI mixins of derived classes.

Defaults to: panelheader

$title-xtype :  String (optional)

The Ext.Class#xtype to use in CSS selectors for the title component. For use by UI mixins of derived classes.

Defaults to: paneltitle

$tool-xtype :  String (optional)

The Ext.Class#xtype to use in CSS selectors for tools. For use by UI mixins of derived classes.

Defaults to: paneltool

$background-color :  color

Panel background-color

$border-color :  color/list

Panel border-color

$border-width :  Number/list

Panel border-width

$border-style :  String/list

Panel border-style

$border-radius :  Number/list

Panel border-radius

$border-radius-big :  Number/list

Panel border-radius in the big sizing scheme

$body-background-color :  color

Panel body background-color

$body-color :  color

Panel body text color

$body-border-color :  color

Panel body border-color

$body-border-width :  Number/list

Panel body border-width

$body-border-style :  Number/list

Panel body border-style

$body-font-weight :  String/Number

Panel body font-weight

$body-font-size :  Number

Panel body font-size

$body-font-size-big :  Number

Panel body font-size in the big sizing scheme

$body-line-height :  Number

Panel body line-height

$body-line-height-big :  Number

Panel body line-height in the big sizing scheme

$body-font-family :  String

Panel body font-family

$body-padding :  Number/list

Panel body padding

$body-padding-big :  Number/list

Panel body padding in the big sizing scheme

$header-background-color :  color

Panel Header background-color

$header-background-gradient :  String/list

Panel Header background-gradient. Can be either the name of a gradient defined by Global_CSS#background-gradient or a list of color stops.

$header-color :  color

Panel Header text color

$header-border-color :  color/list

Panel Header border-color

$header-border-width :  Number/list

Panel Header border-width

$header-border-style :  String/list

Panel Header border-style

$header-font-weight :  String/Number

Panel Header font-weight

$header-font-size :  Number

Panel Header font-size

$header-font-size-big :  Number

Panel Header font-size in the big sizing scheme

$header-line-height :  Number

Panel Header line-height

$header-line-height-big :  Number

Panel Header line-height in the big sizing scheme

$header-font-family :  String

Panel Header font-family

$header-padding :  Number/list

Panel Header padding

$header-padding-big :  Number/list

Panel Header padding in the big sizing scheme

$header-title-padding :  Number/list

Panel Header Title padding

$header-title-padding-big :  Number/list

Panel Header Title padding in the big sizing scheme

$header-title-opacity :  Number

Panel Header Title opacity

$header-shadow :  shadow

Panel Header Shadow

$header-z-index :  Number

Z-Index for the Panel Header, should be used with shadows to raise header above content

$header-min-height :  Number

Panel Header min-height

$header-min-height-big :  Number

Panel Header min-height in the big sizing scheme

$header-icon-color :  color

Panel Header icon color.

$header-icon-size :  Number

Panel Header icon size

$header-icon-size-big :  Number

Panel Header icon size in the big sizing scheme

$header-icon-font-size :  Number

Panel Header icon font-size. Used for configuring the size of font icons

$header-icon-font-size-big :  Number

Panel Header icon font-size in the big sizing scheme

$header-icon-horizontal-spacing :  Number

The space between the Panel Header icon and text when the icon is horizontally aligned

$header-icon-horizontal-spacing-big :  Number

The space between the Panel Header icon and text when the icon is horizontally aligned in the big sizing scheme

$header-icon-vertical-spacing :  Number

The space between the Panel Header icon and text when the icon is vertically aligned

$header-icon-vertical-spacing-big :  Number

The space between the Panel Header icon and text when the icon is vertically aligned in the big sizing scheme

$header-icon-opacity :  Number

Panel Header icon opacity

$tool-color :  color

Panel Tool color

$tool-hovered-color :  Number

Panel Tool color when hovered

$tool-pressed-color :  Number

Panel Tool color when pressed

$tool-disabled-color :  Number

Panel Tool color when disabled

$tool-background-color :  color

Panel Tool background-color

$tool-hovered-background-color :  Number

Panel Tool background-color when hovered

$tool-pressed-background-color :  Number

Panel Tool background-color when pressed

$tool-disabled-background-color :  Number

Panel Tool background-color when disabled

$tool-opacity :  Number

Panel Tool opacity

$tool-hovered-opacity :  Number

Panel Tool opacity when hovered

$tool-pressed-opacity :  Number

Panel Tool opacity when pressed

$tool-disabled-opacity :  Number

Panel Tool opacity when disabled

$tool-border-radius :  Number

Panel Tool border radius

$tool-border-radius-big :  Number

Panel Tool border radius in the big sizing scheme

$tool-size :  Number

Panel Tool size

$tool-size-big :  Number

Panel Tool size in the big sizing scheme

$tool-font-size :  Number

Panel Tool font-size

$tool-font-size-big :  Number

Panel Tool font-size in the big sizing scheme

$tool-spacing :  Number

The space between Panel Tools

$tool-spacing-big :  Number

The space between Panel Tools in the big sizing scheme

$tool-cursor :  String

Panel Tool cursor

$tool-disabled-cursor :  String

Panel Tool cursor when disabled

$tool-focused-outline-width :  Number

Panel Tool outline width when focused

$tool-focused-outline-style :  String

Panel Tool outline style when focused

$tool-focused-outline-color :  color

Panel Tool outline color when focused

$tool-focused-outline-offset :  Number

Panel Tool outline offset when focused

$anchor-border-color :  color

Panel anchor border-color

$anchor-background-color :  color

Panel anchor background-color

$anchor-height :  Number

The height (in all orientations) of the anchor arrow

$anchor-width :  Number

The width (in all orientations) of the anchor arrow.

$anchor-margin :  Number

The extra spacing beyond the tip of the anchor arrow to prevent the pointer touching the target;

$manage-borders :  String

true to include border management rules

ExtReact 6.5.1