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

Ext.panel.Date xtype: datepanel

Summary

Ext.panel.Date is a date picker. This class is used to allow browsing and selection of valid dates in a popup, but may also be used with other components.

No members found using the current filters

configs

Optional Configs

activeChildTabIndex : Number

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

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

getActiveItem : Object / String / Number

Returns the value of activeItem

Returns

Object / String / Number

setActiveItem (activeItem)

Sets the value of activeItem

Parameters

activeItem :  Object / String / Number

allowFocusingDisabledChildren : Boolean

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

Defaults to:

false

alwaysOnTop : Boolean / Number
bindable bind

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

getAlwaysOnTop : Boolean / Number

Returns the value of alwaysOnTop

Returns

Boolean / Number

setAlwaysOnTop (alwaysOnTop)

Sets the value of alwaysOnTop

Parameters

alwaysOnTop :  Boolean / Number

anchor : Boolean

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

Defaults to:

false

animation : Boolean
bindable bind

Set to false to disable animations.

Defaults to:

true

getAnimation : Boolean

Returns the value of animation

Returns

Boolean

setAnimation (animation)

Sets the value of animation

Parameters

animation :  Boolean

ariaAttributes : Object
bindable bind

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.

getAriaAttributes : Object

Returns the value of ariaAttributes

Returns

Object

setAriaAttributes (ariaAttributes)

Sets the value of ariaAttributes

Parameters

ariaAttributes :  Object

ariaDescribedBy : String

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

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

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.

autoConfirm : Boolean
bindable bind

When set to true, clicking or tapping on a date cell in the calendar will confirm selection and dismiss the picker. When set to false, user will have to click OK button after selecting the date.

Defaults to:

false

getAutoConfirm : Boolean

Returns the value of autoConfirm

Returns

Boolean

setAutoConfirm (autoConfirm)

Sets the value of autoConfirm

Parameters

autoConfirm :  Boolean

autoDestroy : Boolean
bindable bind

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

Defaults to:

true

getAutoDestroy : Boolean

Returns the value of autoDestroy

Returns

Boolean

setAutoDestroy (autoDestroy)

Sets the value of autoDestroy

Parameters

autoDestroy :  Boolean

autoSize : Boolean
bindable bind

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

getAutoSize : Boolean

Returns the value of autoSize

Returns

Boolean

setAutoSize (autoSize)

Sets the value of autoSize

Parameters

autoSize :  Boolean

axisLock : Boolean
bindable bind

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

getAxisLock : Boolean

Returns the value of axisLock

Returns

Boolean

setAxisLock (axisLock)

Sets the value of axisLock

Parameters

axisLock :  Boolean

bodyBorder : Boolean

  • 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

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

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

setBodyStyle (bodyStyle)

Sets the value of bodyStyle

Parameters

bodyStyle :  String / Object

border : Boolean
bindable bind

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

getBorder : Boolean

Returns the value of border

Returns

Boolean

setBorder (border)

Sets the value of border

Parameters

border :  Boolean

bottom : Number / String
bindable bind

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

getBottom : Number / String

Returns the value of bottom

Returns

Number / String

setBottom (bottom)

Sets the value of bottom

Parameters

bottom :  Number / String

buttons : Object / Ext.Button[]

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

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

getCentered : Boolean

Returns the value of centered

Returns

Boolean

setCentered (centered)

Sets the value of centered

Parameters

centered :  Boolean

closable : Boolean

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

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

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[]
bindable bind

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

getCls : String / String[]

Returns the value of cls

Returns

String / String[]

setCls (cls)

Sets the value of cls

Parameters

cls :  String / String[]

collapsed : Boolean
bindable bind

true to start collapsed.

getCollapsed : Boolean

Returns the value of collapsed

Returns

Boolean

setCollapsed (collapsed)

Sets the value of collapsed

Parameters

collapsed :  Boolean

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

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

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

Returns the value of collapsible

Returns

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

setCollapsible (collapsible)

Sets the value of collapsible

Parameters

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

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

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

setConstrainAlign (constrainAlign)

Sets the value of constrainAlign

Parameters

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

contentEl : Ext.dom.Element / HTMLElement / String
bindable bind

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

getContentEl : Ext.dom.Element / HTMLElement / String

Returns the value of contentEl

Returns

Ext.dom.Element / HTMLElement / String

setContentEl (contentEl)

Sets the value of contentEl

Parameters

contentEl :  Ext.dom.Element / HTMLElement / String

control : Object
bindable bind

Enables you to easily control Components inside this Container by listening to their events and taking some action. For example, if we had a container with a nested Disable button, and we wanted to hide the Container when the Disable button is tapped, we could do this:

We used a Ext.ComponentQuery selector to listen to the tap event on any Button anywhere inside the Container that has the text 'Disable'. Whenever a Component matching that selector fires the tap event our hideMe function is called. hideMe is called with scope: this (e.g. this is the Container instance).

Defaults to:

null

getControl : Object

Returns the value of control

Returns

Object

setControl (control)

Sets the value of control

Parameters

control :  Object

data : Object
bindable bind

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

Defaults to:

null

getData : Object

Returns the value of data

Returns

Object

setData (data)

Sets the value of data

Parameters

data :  Object

dateCellFormat : String
bindable bind

The date format to use for date cells, compatible with Ext.Date#format method. This format usually includes only day of month information.

getDateCellFormat : String

Returns the value of dateCellFormat

Returns

String

setDateCellFormat (dateCellFormat)

Sets the value of dateCellFormat

Parameters

dateCellFormat :  String

defaultFocus : String
bindable bind

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

getDefaultFocus : String

Returns the value of defaultFocus

Returns

String

setDefaultFocus (defaultFocus)

Sets the value of defaultFocus

Parameters

defaultFocus :  String

defaults : Object
bindable bind

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

getDefaults : Object

Returns the value of defaults

Returns

Object

setDefaults (defaults)

Sets the value of defaults

Parameters

defaults :  Object

defaultType : String
bindable bind

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

Defaults to:

'container'

getDefaultType : String

Returns the value of defaultType

Returns

String

setDefaultType (defaultType)

Sets the value of defaultType

Parameters

defaultType :  String

disabled : Boolean
bindable bind

Whether or not this component is disabled

Defaults to:

null

getDisabled : Boolean

Returns the value of disabled

Returns

Boolean

setDisabled (disabled)

Sets the value of disabled

Parameters

disabled :  Boolean

disabledDates : Date[] / String[] / RegExp
bindable bind

An array of dates to disable. This array can contain Date objects, stringified dates in format, or RegExp patterns that would match strings in format. Date objects can be used to disable specific dates, while strings will be used to build a regular expression to match dates against. Some examples:

  • ['03/08/2003', new Date(2003, 8, 16)] would disable those exact dates
  • ['03/08', '09/16'] would disable those days for every year
  • ['^03/08'] would only match the beginning (useful if you are using short years)
  • [/03\/..\/2006/] would disable every day in March 2006
  • /^03/ would disable every day in every March

Note that the format of the dates included in the array should exactly match the format config.

getDisabledDates : Date[] / String[] / RegExp

Returns the value of disabledDates

Returns

Date[] / String[] / RegExp

setDisabledDates (disabledDates)

Sets the value of disabledDates

Parameters

disabledDates :  Date[] / String[] / RegExp

disabledDays : Number[]
bindable bind

An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday.

getDisabledDays : Number[]

Returns the value of disabledDays

Returns

Number[]

setDisabledDays (disabledDays)

Sets the value of disabledDays

Parameters

disabledDays :  Number[]

displayed : Boolean
bindable bind

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

getDisplayed : Boolean

Returns the value of displayed

Returns

Boolean

setDisplayed (displayed)

Sets the value of displayed

Parameters

displayed :  Boolean

docked : String
bindable bind

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

getDocked : String

Returns the value of docked

Returns

String

setDocked (docked)

Sets the value of docked

Parameters

docked :  String

draggable : Boolean / Object / Ext.drag.Source
bindable bind

Configuration options to make this Component draggable

Defaults to:

null

getDraggable : Boolean / Object / Ext.drag.Source

Returns the value of draggable

Returns

Boolean / Object / Ext.drag.Source

setDraggable (draggable)

Sets the value of draggable

Parameters

draggable :  Boolean / Object / Ext.drag.Source

flex : Number / String / Object
bindable bind

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
}

getFlex : Number / String / Object

Returns the value of flex

Returns

Number / String / Object

setFlex (flex)

Sets the value of flex

Parameters

flex :  Number / String / Object

floated : Boolean
bindable bind

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

getFloated : Boolean

Returns the value of floated

Returns

Boolean

setFloated (floated)

Sets the value of floated

Parameters

floated :  Boolean

focusableContainer : Boolean

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

focusCls : String

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

Defaults to:

'x-focused'

focusedDate : Date
bindable bind

Date to receive focus when the picker is focused for the first time. Subsequent navigation via keyboard will update this value.

This config cannot be null. Default is today.

getFocusedDate : Date

Returns the value of focusedDate

Returns

Date

setFocusedDate (focusedDate)

Sets the value of focusedDate

Parameters

focusedDate :  Date

format : String
bindable bind

The default date format string which can be overriden for localization support. The format must be valid according to Ext.Date#parse (defaults to Ext.Date#defaultFormat).

getFormat : String

Returns the value of format

Returns

String

setFormat (format)

Sets the value of format

Parameters

format :  String

fullscreen : Boolean

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

handler : Function

A function that will handle the select event of this picker. The function will receive the following parameters:

header : Boolean / Object

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'

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

Defaults to:

'top'

Available since: 6.5.0

height : Number / String
bindable bind

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

getHeight : Number / String

Returns the value of height

Returns

Number / String

setHeight (height)

Sets the value of height

Parameters

height :  Number / String

hidden : Boolean
bindable bind

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

Defaults to true for floated Components.

Defaults to:

null

getHidden : Boolean

Returns the value of hidden

Returns

Boolean

setHidden (hidden)

Sets the value of hidden

Parameters

hidden :  Boolean

hideAnimation : String / Mixed
bindable bind

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

getHideAnimation : String / Mixed

Returns the value of hideAnimation

Returns

String / Mixed

setHideAnimation (hideAnimation)

Sets the value of hideAnimation

Parameters

hideAnimation :  String / Mixed

hideCaptions : Boolean
bindable bind

Set to true to hide calendar pane captions displaying the month and year shown in each pane.

getHideCaptions : Boolean

Returns the value of hideCaptions

Returns

Boolean

setHideCaptions (hideCaptions)

Sets the value of hideCaptions

Parameters

hideCaptions :  Boolean

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

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

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

Returns the value of hideMode

Returns

'clip' / 'display' / 'offsets' / 'opacity' / 'visibility'

setHideMode (hideMode)

Sets the value of hideMode

Parameters

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

hideOnMaskTap : Boolean
bindable bind

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

getHideOnMaskTap : Boolean

Returns the value of hideOnMaskTap

Returns

Boolean

setHideOnMaskTap (hideOnMaskTap)

Sets the value of hideOnMaskTap

Parameters

hideOnMaskTap :  Boolean

html : String / Ext.dom.Element / HTMLElement
bindable bind

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

Defaults to:

null

getHtml : String / Ext.dom.Element / HTMLElement

Returns the value of html

Returns

String / Ext.dom.Element / HTMLElement

setHtml (html)

Sets the value of html

Parameters

html :  String / Ext.dom.Element / HTMLElement

icon : String

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

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

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.

getId String

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

Returns

:String

id

inactiveChildTabIndex : Number

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

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

getInnerCls : String

Returns the value of innerCls

Returns

String

setInnerCls (innerCls)

Sets the value of innerCls

Parameters

innerCls :  String

itemId : String
bindable bind

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.

getItemId : String

Returns the value of itemId

Returns

String

setItemId (itemId)

Sets the value of itemId

Parameters

itemId :  String

items : Array / Object
bindable bind

The child items to add to this Container. This is usually an array of Component configurations or instances, for example:

This may also be specified as an object, the property names of which are itemIds, and the property values are child Component config objects, for example:

Defaults to:

null

getItems : Array / Object

Returns the value of items

Returns

Array / Object

setItems (items)

Sets the value of items

Parameters

items :  Array / Object

keyMap : Object
bindable bind

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.

getKeyMap : Object

Returns the value of keyMap

Returns

Object

setKeyMap (keyMap)

Sets the value of keyMap

Parameters

keyMap :  Object

keyMapEnabled : Boolean
bindable bind

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

getKeyMapEnabled : Boolean

Returns the value of keyMapEnabled

Returns

Boolean

setKeyMapEnabled (keyMapEnabled)

Sets the value of keyMapEnabled

Parameters

keyMapEnabled :  Boolean

layout : Object / String
bindable bind

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'

getLayout : Object / String

Returns the value of layout

Returns

Object / String

setLayout (layout)

Sets the value of layout

Parameters

layout :  Object / String

left : Number / String
bindable bind

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

getLeft : Number / String

Returns the value of left

Returns

Number / String

setLeft (left)

Sets the value of left

Parameters

left :  Number / String

listeners : Object
bindable bind

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

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

manageBorders : Boolean
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
bindable bind

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

getMargin : Number / String

Returns the value of margin

Returns

Number / String

setMargin (margin)

Sets the value of margin

Parameters

margin :  Number / String

masked : Boolean / Object / Ext.Mask / Ext.LoadMask
bindable bind

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

getMasked : Boolean / Object / Ext.Mask / Ext.LoadMask

Returns the value of masked

Returns

Boolean / Object / Ext.Mask / Ext.LoadMask

setMasked (masked)

Sets the value of masked

Parameters

masked :  Boolean / Object / Ext.Mask / Ext.LoadMask

maxDate : Date / String
bindable bind

Maximum allowable date as Date object or a string in format.

getMaxDate : Date / String

Returns the value of maxDate

Returns

Date / String

setMaxDate (maxDate)

Sets the value of maxDate

Parameters

maxDate :  Date / String

maxHeight : Number / String
bindable bind

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

getMaxHeight : Number / String

Returns the value of maxHeight

Returns

Number / String

setMaxHeight (maxHeight)

Sets the value of maxHeight

Parameters

maxHeight :  Number / String

maxWidth : Number / String
bindable bind

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

getMaxWidth : Number / String

Returns the value of maxWidth

Returns

Number / String

setMaxWidth (maxWidth)

Sets the value of maxWidth

Parameters

maxWidth :  Number / String

minDate : Date / String
bindable bind

Minimum allowable date as Date object or a string in format.

getMinDate : Date / String

Returns the value of minDate

Returns

Date / String

setMinDate (minDate)

Sets the value of minDate

Parameters

minDate :  Date / String

minHeight : Number / String
bindable bind

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

getMinHeight : Number / String

Returns the value of minHeight

Returns

Number / String

setMinHeight (minHeight)

Sets the value of minHeight

Parameters

minHeight :  Number / String

minWidth : Number / String
bindable bind

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

getMinWidth : Number / String

Returns the value of minWidth

Returns

Number / String

setMinWidth (minWidth)

Sets the value of minWidth

Parameters

minWidth :  Number / String

modal : Boolean
bindable bind

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

getModal : Boolean

Returns the value of modal

Returns

Boolean

setModal (modal)

Sets the value of modal

Parameters

modal :  Boolean

modelValidation : Boolean

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

monthYearFormat : String
bindable bind

The date format for the header month.

getMonthYearFormat : String

Returns the value of monthYearFormat

Returns

String

setMonthYearFormat (monthYearFormat)

Sets the value of monthYearFormat

Parameters

monthYearFormat :  String

name : String

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

Defaults to:

null

nameHolder : Boolean

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

Defaults to:

false

nextText : String

The next month navigation button tooltip.

Defaults to:

"Next Month (Control+Right)"

padding : Number / String
bindable bind

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

getPadding : Number / String

Returns the value of padding

Returns

Number / String

setPadding (padding)

Sets the value of padding

Parameters

padding :  Number / String

paneCaptionFormat : String
bindable bind

Date format for calendar pane captions.

Defaults to:

"F Y"

getPaneCaptionFormat : String

Returns the value of paneCaptionFormat

Returns

String

setPaneCaptionFormat (paneCaptionFormat)

Sets the value of paneCaptionFormat

Parameters

paneCaptionFormat :  String

panes : Number
bindable bind

Number of calendar panes to display in the picker.

Defaults to:

1

getPanes : Number

Returns the value of panes

Returns

Number

setPanes (panes)

Sets the value of panes

Parameters

panes :  Number

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

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

getPlugins : Object / String / Object[] / String[]

Returns the value of plugins

Returns

Object / String / Object[] / String[]

setPlugins (plugins)

Sets the value of plugins

Parameters

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

prevText : String
bindable bind

The previous month navigation button tooltip.

Defaults to:

"Previous Month (Control+Left)"

getPrevText : String

Returns the value of prevText

Returns

String

setPrevText (prevText)

Sets the value of prevText

Parameters

prevText :  String

record : Ext.data.Model
bindable bind

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

getRecord : Ext.data.Model

Returns the value of record

Returns

Ext.data.Model

setRecord (record)

Sets the value of record

Parameters

record :  Ext.data.Model

referenceHolder : Boolean

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

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

Defaults to:

false

relative : Boolean
bindable bind

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

getRelative : Boolean

Returns the value of relative

Returns

Boolean

setRelative (relative)

Sets the value of relative

Parameters

relative :  Boolean

renderTo : Ext.dom.Element

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

Defaults to:

true

resetFocusPosition : Boolean

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

A configuration for a Ext.panel.Resizer.

Available since: 6.5.0

getResizable : Object

Returns the value of resizable

Returns

Object

setResizable (resizable)

Sets the value of resizable

Parameters

resizable :  Object

right : Number / String
bindable bind

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

getRight : Number / String

Returns the value of right

Returns

Number / String

setRight (right)

Sets the value of right

Parameters

right :  Number / String

ripple : Boolean / Object / String
bindable bind

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.

getRipple : Boolean / Object / String

Returns the value of ripple

Returns

Boolean / Object / String

setRipple (ripple)

Sets the value of ripple

Parameters

ripple :  Boolean / Object / String

scope : Object

The scope in which handler function will be called.

scrollable : Boolean / String / Object
bindable bind

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

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

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

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

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

Defaults to:

null

getScrollable : Boolean / String / Object

Returns the value of scrollable

Returns

Boolean / String / Object

setScrollable (scrollable)

Sets the value of scrollable

Parameters

scrollable :  Boolean / String / Object

selfAlign : String
bindable bind

Specifies the self alignment of this widget in a box layout

getSelfAlign : String

Returns the value of selfAlign

Returns

String

setSelfAlign (selfAlign)

Sets the value of selfAlign

Parameters

selfAlign :  String

shadow : Boolean
bindable bind

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

getShadow : Boolean

Returns the value of shadow

Returns

Boolean

setShadow (shadow)

Sets the value of shadow

Parameters

shadow :  Boolean

shim : Boolean
bindable bind

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

getShim : Boolean

Returns the value of shim

Returns

Boolean

setShim (shim)

Sets the value of shim

Parameters

shim :  Boolean

showAfterMaxDate : Boolean
bindable bind

Set to true to allow navigating to months coming after maxDate. This has no effect when maxDate is not set.

Defaults to:

false

getShowAfterMaxDate : Boolean

Returns the value of showAfterMaxDate

Returns

Boolean

setShowAfterMaxDate (showAfterMaxDate)

Sets the value of showAfterMaxDate

Parameters

showAfterMaxDate :  Boolean

showAnimation : String / Mixed
bindable bind

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

getShowAnimation : String / Mixed

Returns the value of showAnimation

Returns

String / Mixed

setShowAnimation (showAnimation)

Sets the value of showAnimation

Parameters

showAnimation :  String / Mixed

showBeforeMinDate : Boolean
bindable bind

Set to true to allow navigating to months preceding minDate. This has no effect when minDate is not set.

Defaults to:

false

getShowBeforeMinDate : Boolean

Returns the value of showBeforeMinDate

Returns

Boolean

setShowBeforeMinDate (showBeforeMinDate)

Sets the value of showBeforeMinDate

Parameters

showBeforeMinDate :  Boolean

showFooter : Boolean
bindable bind

Set to true to always show footer bar with OK, Cancel, and Today buttons. If this config is not provided, footer will be shown or hidden automatically depending on autoConfirm.

getShowFooter : Boolean

Returns the value of showFooter

Returns

Boolean

setShowFooter (showFooter)

Sets the value of showFooter

Parameters

showFooter :  Boolean

showTodayButton : Boolean
bindable bind

Set to true to show the Today button. Location will depend on showFooter config: if the footer is shown, Today button will be placed in the footer; otherwise the button will be placed in picker header.

getShowTodayButton : Boolean

Returns the value of showTodayButton

Returns

Boolean

setShowTodayButton (showTodayButton)

Sets the value of showTodayButton

Parameters

showTodayButton :  Boolean

specialDates : Date[] / String[] / RegExp[]
bindable bind

An array of Date objects, strings, or RegExp patterns designating special dates like holidays. These dates will have 'x-special-day' CSS class added to their cells, allowing for visually distinct styling.

If you want to disallow selecting these dates you would need to include them in disabledDates config as well.

getSpecialDates : Date[] / String[] / RegExp[]

Returns the value of specialDates

Returns

Date[] / String[] / RegExp[]

setSpecialDates (specialDates)

Sets the value of specialDates

Parameters

specialDates :  Date[] / String[] / RegExp[]

startDay : Number
bindable bind

Day index at which the week should begin, 0-based.

Defaults to the value of Ext.Date.firstDayOfWeek.

getStartDay : Number

Returns the value of startDay

Returns

Number

setStartDay (startDay)

Sets the value of startDay

Parameters

startDay :  Number

style : String / Object
bindable bind

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

setStyle (style)

Sets the value of style

Parameters

style :  String / Object

tabIndex : Number
bindable bind

DOM tabIndex attribute for this component's focusEl.

Defaults to:

null

getTabIndex Number

Return the actual tabIndex for this Focusable.

Returns

:Number

tabIndex attribute value

setTabIndex ( newTabIndex )

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

Parameters

newTabIndex :  Number

new tabIndex to set

title : String / Ext.panel.Title

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

Defaults to:

null

toFrontOnShow : Boolean
bindable bind

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

Defaults to:

true

getToFrontOnShow : Boolean

Returns the value of toFrontOnShow

Returns

Boolean

setToFrontOnShow (toFrontOnShow)

Sets the value of toFrontOnShow

Parameters

toFrontOnShow :  Boolean

tools : Object[] / Ext.Tool[]

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

tooltip : String / Object
bindable bind

The ToolTip for this component.

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

Defaults to:

null

getTooltip : String / Object

Returns the value of tooltip

Returns

String / Object

setTooltip (tooltip)

Sets the value of tooltip

Parameters

tooltip :  String / Object

top : Number / String
bindable bind

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

getTop : Number / String

Returns the value of top

Returns

Number / String

setTop (top)

Sets the value of top

Parameters

top :  Number / String

touchAction : Object

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[]
bindable bind

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

setTpl (tpl)

Sets the value of tpl

Parameters

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

tplWriteMode : String
bindable bind

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'

getTplWriteMode : String

Returns the value of tplWriteMode

Returns

String

setTplWriteMode (tplWriteMode)

Sets the value of tplWriteMode

Parameters

tplWriteMode :  String

transformCellCls : Function

A function that will be called during cell rendering to allow modifying CSS classes applied to the cell.

Parameters

transformCellCls :  Object

date :  Date

Date for which a cell is being rendered.

classes :  String[]

Array of standard CSS classes for this cell, including class names for specialDates, disabledDates, etc. You can add custom classes or remove some standard class names as desired.

ui : String / String[]

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

userCls : String / String[]

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

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

getUserSelectable : Boolean / String / Object

Returns the value of userSelectable

Returns

Boolean / String / Object

setUserSelectable (userSelectable)

Sets the value of userSelectable

Parameters

userSelectable :  Boolean / String / Object

value : Date
bindable bind

Initial value of this picker. Defaults to today.

Defaults to:

false

getValue : Date

Returns the value of value

Returns

Date

setValue (value)

Sets the value of value

Parameters

value :  Date

weekendDays : Number[]
bindable bind

Array of weekend day indices, 0-based.

Defaults to the value of Ext.Date.weekendDays

getWeekendDays : Number[]

Returns the value of weekendDays

Returns

Number[]

setWeekendDays (weekendDays)

Sets the value of weekendDays

Parameters

weekendDays :  Number[]

weight : Number
bindable bind

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

getWeight : Number

Returns the value of weight

Returns

Number

setWeight (weight)

Sets the value of weight

Parameters

weight :  Number

weighted : Boolean

If set to true, then child items may be specified as a object, with each property name specifying an itemId, and the property value being the child item configuration object.

When using this scheme, each child item may contain a weight configuration value which affects its order in this container. Lower weights are towards the start, higher weights towards the end.

Defaults to:

false

width : Number / String
bindable bind

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

getWidth : Number / String

Returns the value of width

Returns

Number / String

setWidth (width)

Sets the value of width

Parameters

width :  Number / String

x : Number
bindable bind

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

getX : Number

Returns the value of x

Returns

Number

setX (x)

Sets the value of x

Parameters

x :  Number

xtype : String

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

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

getY : Number

Returns the value of y

Returns

Number

setY (y)

Sets the value of y

Parameters

y :  Number

zIndex : Number
bindable bind

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

getZIndex : Number

Returns the value of zIndex

Returns

Number

setZIndex (zIndex)

Sets the value of zIndex

Parameters

zIndex :  Number

properties

Instance Properties

factoryConfig : Object

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

focusableContainerEl : String / Ext.dom.Element

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"

focusClsEl : Ext.dom.Element

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

focusEl : Ext.dom.Element

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'

hasCollapsible : Boolean

true if this panel has the collapsible override added.

Defaults to:

true

Available since: 6.5.0

hasResizable : Boolean

true if this panel has the resizable override added.

Defaults to:

true

Available since: 6.5.0

isContainer : Boolean

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

Defaults to:

true

isObservable : Boolean

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

Defaults to:

true

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

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.

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.

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

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.

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

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

activate ( 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.

activeItemchange ( 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.

add ( 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.

added ( 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.

beforeactiveItemchange ( 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.

beforebottomchange ( 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.

beforecenteredchange ( 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.

beforeclose ( 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.

beforecollapse ( 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.

beforedisabledchange ( 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.

beforedockedchange ( 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.

beforeexpand ( 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.

beforeflexchange ( 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.

beforeheightchange ( 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.

beforehiddenchange ( 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.

beforehide ( 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.

beforeleftchange ( 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.

beforemaxHeightchange ( 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.

beforemaxWidthchange ( 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.

beforeminHeightchange ( 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.

beforeminWidthchange ( 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.

beforeresizedragstart ( 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.

beforerightchange ( 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.

beforescrollablechange ( 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.

beforeshow ( 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.

beforetopchange ( 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.

beforewidthchange ( 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.

blur ( 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.

bottomchange ( 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.

centeredchange ( 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.

close ( 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.

collapse ( 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.

deactivate ( 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.

destroy

Fires when the component is destroyed

disabledchange ( 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.

dockedchange ( 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.

drawerhide ( 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.

drawershow ( 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.

erased ( 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.

expand ( 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.

flexchange ( 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.

focus ( 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.

focusenter ( 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.

focusleave ( 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.

fullscreen ( 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.

heightchange ( 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.

hiddenchange ( 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.

hide ( 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.

initialize ( 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.

leftchange ( 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.

maxHeightchange ( 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.

maxWidthchange ( 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.

minHeightchange ( 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.

minWidthchange ( 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.

move ( 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.

moved ( 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.

painted ( 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.

positionedchange ( 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.

remove ( 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.

removed ( 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.

resize ( 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.

resizedrag ( 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.

resizedragcancel ( 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.

resizedragend ( 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.

resizedragstart ( 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.

rightchange ( 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.

scrollablechange ( 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.

show ( 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.

topchange ( 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.

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

$datepanel-anchor-background-color : color

DatePanel anchor background-color

Defaults to:

null

$datepanel-anchor-border-color : color

DatePanel anchor border-color

Defaults to:

null

$datepanel-anchor-height : Number

The height (in all orientations) of the anchor arrow

Defaults to:

null

$datepanel-anchor-margin : Number

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

Defaults to:

null

$datepanel-anchor-width : Number

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

Defaults to:

null

$datepanel-body-background-color : color

DatePanel body background-color

Defaults to:

null

$datepanel-body-border-color : color

DatePanel body border-color

Defaults to:

$datepanel-border-color

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

DatePanel body border-style

Defaults to:

null

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

DatePanel body border-width

Defaults to:

null

$datepanel-body-color : color

DatePanel body text color

Defaults to:

null

$datepanel-body-font-family : String

DatePanel body font-family

Defaults to:

null

$datepanel-body-font-size : Number

DatePanel body font-size

Defaults to:

null

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

DatePanel body font-size in the big sizing scheme

Defaults to:

null

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

DatePanel body font-weight

Defaults to:

null

$datepanel-body-line-height : Number

DatePanel body line-height

Defaults to:

null

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

DatePanel body line-height in the big sizing scheme

Defaults to:

null

$datepanel-body-padding : Number / list

DatePanel body padding

Defaults to:

null

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

DatePanel body padding in the big sizing scheme

Defaults to:

null

$datepanel-border-color : color / list

DatePanel border-color

Defaults to:

null

$datepanel-border-radius : Number / list

DatePanel border-radius

Defaults to:

null

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

DatePanel border-radius in the big sizing scheme

Defaults to:

$datepanel-border-radius

$datepanel-border-style : String / list

DatePanel border-style

Defaults to:

null

$datepanel-border-width : Number / list

DatePanel border-width

Defaults to:

null

$datepanel-caption-background-color : color

DatePanel caption background color.

Defaults to:

null

$datepanel-caption-color : color

DatePanel caption color.

Defaults to:

null

$datepanel-caption-font-family : String

DatePanel caption font family.

Defaults to:

null

$datepanel-caption-font-size : Number

DatePanel caption font size.

Defaults to:

null

$datepanel-caption-font-size-big : Number

DatePanel caption font size in the big sizing scheme.

Defaults to:

null

$datepanel-caption-font-weight : Number / String

DatePanel caption font weight.

Defaults to:

null

$datepanel-caption-padding : Number / list

DatePanel caption padding.

Defaults to:

null

$datepanel-caption-padding-big : Number / list

DatePanel caption padding in the big sizing scheme.

Defaults to:

null

$datepanel-caption-text-align : String

DatePanel caption text-align.

Defaults to:

center

$datepanel-cell-background-color : color

DatePanel cell background color.

Defaults to:

null

$datepanel-cell-border-radius : Number / list

DatePanel cell border radius.

Defaults to:

null

$datepanel-cell-border-radius-big : Number / list

DatePanel cell border radius in the big sizing scheme.

Defaults to:

null

$datepanel-cell-color : color

DatePanel cell color.

Defaults to:

null

$datepanel-cell-font-family : String

DatePanel cell font family.

Defaults to:

null

$datepanel-cell-font-size : Number

DatePanel cell font size.

Defaults to:

null

$datepanel-cell-font-size-big : Number

DatePanel cell font size in the big sizing scheme.

Defaults to:

null

$datepanel-cell-font-weight : Number / String

DatePanel cell font weight.

Defaults to:

null

$datepanel-cell-height : Number

DatePanel cell height.

Defaults to:

28px

$datepanel-cell-height-big : Number

DatePanel cell height in the big sizing scheme.

Defaults to:

null

$datepanel-cell-spacing : Number

DatePanel spacing between cells.

Defaults to:

4px

$datepanel-cell-spacing-big : Number

DatePanel spacing between cells in the big sizing scheme.

Defaults to:

null

$datepanel-cell-width : Number

DatePanel cell width.

Defaults to:

28px

$datepanel-cell-width-big : Number

DatePanel cell width in the big sizing scheme.

Defaults to:

null

$datepanel-date-cell-background-color : color

DatePanel date body cell background color.

Defaults to:

null

$datepanel-date-cell-border-color : color / list

DatePanel date body cell border color.

Defaults to:

null

$datepanel-date-cell-border-style : String / list

DatePanel date body cell border style.

Defaults to:

null

$datepanel-date-cell-border-width : Number / list

DatePanel date body cell border width.

Defaults to:

null

$datepanel-date-cell-color : color

DatePanel date body cell color.

Defaults to:

null

$datepanel-date-cell-font-family : String

DatePanel date body cell font family.

Defaults to:

null

$datepanel-date-cell-font-size : Number

DatePanel date body cell font size.

Defaults to:

null

$datepanel-date-cell-font-size-big : Number

DatePanel date body cell font size in the big sizing scheme.

Defaults to:

null

$datepanel-date-cell-font-weight : Number / String

DatePanel date body cell font weight.

Defaults to:

null

$datepanel-date-cell-height : Number

DatePanel date body cell height.

Defaults to:

null

$datepanel-date-cell-height-big : Number

DatePanel date body cell height in the big sizing scheme.

Defaults to:

null

$datepanel-day-cell-background-color : color

DatePanel day header cell background color.

Defaults to:

#F5F5F5

$datepanel-day-cell-color : color

DatePanel day header cell color.

Defaults to:

null

$datepanel-day-cell-font-family : String

DatePanel day header cell font size.

Defaults to:

null

$datepanel-day-cell-font-size : Number

DatePanel day header font size.

Defaults to:

null

$datepanel-day-cell-font-size-big : Number

DatePanel day header font size in the big sizing scheme.

Defaults to:

null

$datepanel-day-cell-font-weight : Number / String

DatePanel day header font weight.

Defaults to:

bold

$datepanel-day-cell-height : Number

DatePanel day header cell height.

Defaults to:

null

$datepanel-day-cell-height-big : Number

DatePanel day header cell height in the big sizing scheme.

Defaults to:

null

$datepanel-disabled-cell-background-color : color

DatePanel disabled cell background color.

Defaults to:

#aaa

$datepanel-disabled-cell-color : color

DatePanel disabled cell color.

Defaults to:

null

$datepanel-disabled-cell-font-weight : String / Number

DatePanel disabled cell font weight.

Defaults to:

null

$datepanel-focused-cell-outline-color : color

DatePanel focused cell outline color.

Defaults to:

darken($base-color, 35%)

$datepanel-focused-cell-outline-offset : Number

DatePanel focused cell outline offset.

Defaults to:

-1px

$datepanel-focused-cell-outline-style : String

DatePanel focused cell outline style.

Defaults to:

solid

$datepanel-focused-cell-outline-width : Number

DatePanel focused cell outline width.

Defaults to:

1px

$datepanel-header-background-color : color

DatePanel Header background-color

Defaults to:

null

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

DatePanel 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

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

DatePanel Header border-color

Defaults to:

$datepanel-border-color

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

DatePanel Header border-style

Defaults to:

null

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

DatePanel Header border-width

Defaults to:

null

$datepanel-header-color : color

DatePanel Header text color

Defaults to:

null

$datepanel-header-font-family : String

DatePanel Header font-family

Defaults to:

null

$datepanel-header-font-size : Number

DatePanel Header font-size

Defaults to:

null

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

DatePanel Header font-size in the big sizing scheme

Defaults to:

null

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

DatePanel Header font-weight

Defaults to:

null

$datepanel-header-icon-color : color

DatePanel Header icon color.

Defaults to:

null

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

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

Defaults to:

null

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

DatePanel Header icon font-size in the big sizing scheme

Defaults to:

null

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

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

Defaults to:

null

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

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

Defaults to:

null

$datepanel-header-icon-opacity : Number

DatePanel Header icon opacity

Defaults to:

null

$datepanel-header-icon-size : Number

DatePanel Header icon size

Defaults to:

null

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

DatePanel Header icon size in the big sizing scheme

Defaults to:

null

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

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

Defaults to:

null

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

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

Defaults to:

null

$datepanel-header-inactive-transition : list

DatePanel title (with split titles) inactive transition.

Defaults to:

null

$datepanel-header-line-height : Number

DatePanel Header line-height

Defaults to:

null

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

DatePanel Header line-height in the big sizing scheme

Defaults to:

null

$datepanel-header-min-height : Number

DatePanel Header min-height

Defaults to:

null

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

DatePanel Header min-height in the big sizing scheme

Defaults to:

null

$datepanel-header-padding : Number / list

DatePanel Header padding

Defaults to:

null

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

DatePanel Header padding in the big sizing scheme

Defaults to:

null

$datepanel-header-shadow : shadow

DatePanel Header Shadow

Defaults to:

null

$datepanel-header-title-inactive-color : color

DatePanel title (with split titles) inactive color.

Defaults to:

null

$datepanel-header-title-inactive-font-size : Number

DatePanel title (with split titles) inactive font size.

Defaults to:

null

$datepanel-header-title-inactive-font-size-big : Number

DatePanel title (with split titles) inactive font size in the big sizing scheme.

Defaults to:

null

$datepanel-header-title-inactive-opacity : Number

DatePanel title (with split titles) inactive opacity.

Defaults to:

null

$datepanel-header-title-opacity : Number

DatePanel Header Title opacity

Defaults to:

null

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

DatePanel Header Title padding

Defaults to:

null

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

DatePanel Header Title padding in the big sizing scheme

Defaults to:

null

$datepanel-header-year-color : color

DatePanel year (with split titles) color.

Defaults to:

null

$datepanel-header-year-font-family : String

DatePanel year (with split titles) font family.

Defaults to:

null

$datepanel-header-year-font-size : Number

DatePanel year (with split titles) font size.

Defaults to:

null

$datepanel-header-year-font-size-big : Number

DatePanel year (with split titles) font size in the big sizing scheme.

Defaults to:

null

$datepanel-header-year-font-weight : String / Number

DatePanel year (with split titles) font weight.

Defaults to:

500

$datepanel-header-year-inactive-color : color

DatePanel year (with split titles) inactive year color.

Defaults to:

null

$datepanel-header-year-inactive-font-size : Number

DatePanel year (with split titles) inactive year font size.

Defaults to:

null

$datepanel-header-year-inactive-font-size-big : Number

DatePanel year (with split titles) inactive year font size in the big sizing scheme.

Defaults to:

null

$datepanel-header-year-inactive-opacity : color

DatePanel year (with split titles) inactive year opacity.

Defaults to:

null

$datepanel-header-year-line-height : Number

DatePanel year (with split titles) line height.

Defaults to:

null

$datepanel-header-year-line-height-big : Number

DatePanel year (with split titles) line height in the big sizing scheme.

Defaults to:

null

$datepanel-header-year-opacity : Number

DatePanel year (with split titles) opacity.

Defaults to:

null

$datepanel-header-z-index : Number

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

Defaults to:

null

$datepanel-manage-borders : String

true to include border management rules

Defaults to:

$panel-manage-borders

$datepanel-outside-cell-background-color : color

DatePanel outside the current month cell background color.

Defaults to:

null

$datepanel-outside-cell-color : color

DatePanel outside the current month cell color.

Defaults to:

#d0d0d0

$datepanel-outside-cell-font-weight : Number / String

DatePanel outside the current month cell font weight.

Defaults to:

null

$datepanel-pane-margin : Number / list

DatePanel pane margin.

Defaults to:

null

$datepanel-selected-cell-background-color : color

DatePanel selected cell background color.

Defaults to:

$base-color

$datepanel-selected-cell-color : color

DatePanel selected cell color.

Defaults to:

$light-color

$datepanel-selected-cell-font-weight : Number / String

DatePanel selected cell font weight.

Defaults to:

null

$datepanel-selected-focused-cell-outline-color : color

DatePanel selected focused cell outline color.

Defaults to:

#fff

$datepanel-special-cell-background-color : color

DatePanel special cell background color.

Defaults to:

null

$datepanel-special-cell-color : color

DatePanel special cell color.

Defaults to:

$base-light-color

$datepanel-special-cell-font-weight : Number / String

DatePanel special cell font weight.

Defaults to:

null

$datepanel-split-title-header-padding : Number / list

DatePanel split title header padding.

Defaults to:

null

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

DatePanel split title header padding in the big sizing scheme.

Defaults to:

null

$datepanel-today-cell-background-color : color

DatePanel today cell background color.

Defaults to:

$base-highlight-color

$datepanel-today-cell-color : color

DatePanel today cell color.

Defaults to:

null

$datepanel-today-cell-font-weight : Number / String

DatePanel today cell font weight.

Defaults to:

null

$datepanel-tool-background-color : color

DatePanel Tool background-color

Defaults to:

null

$datepanel-tool-border-radius : Number

DatePanel Tool border radius

Defaults to:

null

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

DatePanel Tool border radius in the big sizing scheme

Defaults to:

null

$datepanel-tool-color : color

DatePanel Tool color

Defaults to:

null

$datepanel-tool-cursor : String

DatePanel Tool cursor

Defaults to:

null

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

DatePanel Tool background-color when disabled

Defaults to:

null

$datepanel-tool-disabled-color : Number

DatePanel Tool color when disabled

Defaults to:

null

$datepanel-tool-disabled-cursor : String

DatePanel Tool cursor when disabled

Defaults to:

null

$datepanel-tool-disabled-opacity : Number

DatePanel Tool opacity when disabled

Defaults to:

null

$datepanel-tool-focused-outline-color : color

DatePanel Tool outline color when focused

Defaults to:

null

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

DatePanel Tool outline offset when focused

Defaults to:

null

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

DatePanel Tool outline style when focused

Defaults to:

null

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

DatePanel Tool outline width when focused

Defaults to:

null

$datepanel-tool-font-size : Number

DatePanel Tool font-size

Defaults to:

null

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

DatePanel Tool font-size in the big sizing scheme

Defaults to:

null

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

DatePanel Tool background-color when hovered

Defaults to:

null

$datepanel-tool-hovered-color : Number

DatePanel Tool color when hovered

Defaults to:

null

$datepanel-tool-hovered-opacity : Number

DatePanel Tool opacity when hovered

Defaults to:

null

$datepanel-tool-opacity : Number

DatePanel Tool opacity

Defaults to:

null

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

DatePanel Tool background-color when pressed

Defaults to:

null

$datepanel-tool-pressed-color : Number

DatePanel Tool color when pressed

Defaults to:

null

$datepanel-tool-pressed-opacity : Number

DatePanel Tool opacity when pressed

Defaults to:

null

$datepanel-tool-size : Number

DatePanel Tool size

Defaults to:

null

$datepanel-tool-size-big : Number

DatePanel Tool size in the big sizing scheme

Defaults to:

null

$datepanel-tool-spacing : Number

The space between DatePanel Tools

Defaults to:

null

$datepanel-tool-spacing-big : Number

The space between DatePanel Tools in the big sizing scheme

Defaults to:

null

$datepanel-weekend-cell-background-color : color

DatePanel weekend cell background color.

Defaults to:

null

$datepanel-weekend-cell-color : color

DatePanel weekend cell color.

Defaults to:

null

$datepanel-weekend-cell-font-weight : Number / String

DatePanel weekend cell font weight.

Defaults to:

null

$datepanel-weekend-column-background-color : Number

DatePanel weekend column background color.

Defaults to:

null

$datepanel-weekend-column-border-color : color / list

DatePanel weekend column border color.

Defaults to:

$datepanel-weekend-column-background-color

$datepanel-weekend-column-border-radius : Number / list

DatePanel weekend column border radius.

Defaults to:

null

$datepanel-weekend-column-border-style : String / list

DatePanel weekend column border style.

Defaults to:

solid

$datepanel-weekend-column-border-width : Number / list

DatePanel weekend column border width.

Defaults to:

1px

$datepanel-weekend-column-spacing : Number

DatePanel weekend column vertical spacing.

Defaults to:

6px

$datepanel-weekend-column-width : Number

DatePanel weekend column width.

Defaults to:

80%

$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

datepanel-ui ( ...list... )

Creates a visual theme for a DatePanel.

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

$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: dateheader

$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: datetitle

$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: datepaneltool

$pane-margin :  Number/list

DatePanel pane margin.

$caption-padding :  Number/list

DatePanel caption padding.

$caption-padding-big :  Number/list

DatePanel caption padding in the big sizing scheme.

$caption-color :  color

DatePanel caption color.

$caption-background-color :  color

DatePanel caption background color.

$caption-text-align :  String

DatePanel caption text-align.

$caption-font-family :  String

DatePanel caption font family.

$caption-font-size :  Number

DatePanel caption font size.

$caption-font-size-big :  Number

DatePanel caption font size in the big sizing scheme.

$caption-font-weight :  Number/String

DatePanel caption font weight.

$cell-width :  Number

DatePanel cell width.

$cell-width-big :  Number

DatePanel cell width in the big sizing scheme.

$cell-height :  Number

DatePanel cell height.

$cell-height-big :  Number

DatePanel cell height in the big sizing scheme.

$cell-spacing :  Number

DatePanel spacing between cells.

$cell-spacing-big :  Number

DatePanel spacing between cells in the big sizing scheme.

$cell-border-radius :  Number/list

DatePanel cell border radius.

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

DatePanel cell border radius in the big sizing scheme.

$cell-color :  color

DatePanel cell color.

$cell-background-color :  color

DatePanel cell background color.

$cell-font-family :  String

DatePanel cell font family.

$cell-font-size :  Number

DatePanel cell font size.

$cell-font-size-big :  Number

DatePanel cell font size in the big sizing scheme.

$cell-font-weight :  Number/String

DatePanel cell font weight.

$day-cell-height :  Number

DatePanel day header cell height.

$day-cell-height-big :  Number

DatePanel day header cell height in the big sizing scheme.

$day-cell-color :  color

DatePanel day header cell color.

$day-cell-background-color :  color

DatePanel day header cell background color.

$day-cell-font-family :  String

DatePanel day header cell font size.

$day-cell-font-size :  Number

DatePanel day header font size.

$day-cell-font-size-big :  Number

DatePanel day header font size in the big sizing scheme.

$day-cell-font-weight :  Number/String

DatePanel day header font weight.

$date-cell-height :  Number

DatePanel date body cell height.

$date-cell-height-big :  Number

DatePanel date body cell height in the big sizing scheme.

$date-cell-color :  color

DatePanel date body cell color.

$date-cell-background-color :  color

DatePanel date body cell background color.

$date-cell-font-family :  String

DatePanel date body cell font family.

$date-cell-font-size :  Number

DatePanel date body cell font size.

$date-cell-font-size-big :  Number

DatePanel date body cell font size in the big sizing scheme.

$date-cell-font-weight :  Number/String

DatePanel date body cell font weight.

$date-cell-border-color :  color/list

DatePanel date body cell border color.

$date-cell-border-style :  String/list

DatePanel date body cell border style.

$date-cell-border-width :  Number/list

DatePanel date body cell border width.

$outside-cell-color :  color

DatePanel outside the current month cell color.

$outside-cell-background-color :  color

DatePanel outside the current month cell background color.

$outside-cell-font-weight :  Number/String

DatePanel outside the current month cell font weight.

$today-cell-color :  color

DatePanel today cell color.

$today-cell-background-color :  color

DatePanel today cell background color.

$today-cell-font-weight :  Number/String

DatePanel today cell font weight.

$special-cell-color :  color

DatePanel special cell color.

$special-cell-background-color :  color

DatePanel special cell background color.

$special-cell-font-weight :  Number/String

DatePanel special cell font weight.

$weekend-cell-color :  color

DatePanel weekend cell color.

$weekend-cell-background-color :  color

DatePanel weekend cell background color.

$weekend-cell-font-weight :  Number/String

DatePanel weekend cell font weight.

$weekend-column-width :  Number

DatePanel weekend column width.

$weekend-column-background-color :  Number

DatePanel weekend column background color.

$weekend-column-spacing :  Number

DatePanel weekend column vertical spacing.

$weekend-column-border-color :  color/list

DatePanel weekend column border color.

$weekend-column-border-style :  String/list

DatePanel weekend column border style.

$weekend-column-border-width :  Number/list

DatePanel weekend column border width.

$weekend-column-border-radius :  Number/list

DatePanel weekend column border radius.

$disabled-cell-color :  color

DatePanel disabled cell color.

$disabled-cell-background-color :  color

DatePanel disabled cell background color.

$disabled-cell-font-weight :  String/Number

DatePanel disabled cell font weight.

$selected-cell-color :  color

DatePanel selected cell color.

$selected-cell-background-color :  color

DatePanel selected cell background color.

$selected-cell-font-weight :  Number/String

DatePanel selected cell font weight.

$focused-cell-outline-color :  color

DatePanel focused cell outline color.

$focused-cell-outline-style :  String

DatePanel focused cell outline style.

$focused-cell-outline-width :  Number

DatePanel focused cell outline width.

$focused-cell-outline-offset :  Number

DatePanel focused cell outline offset.

$selected-focused-cell-outline-color :  color

DatePanel selected focused cell outline color.

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

DatePanel split title header padding.

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

DatePanel split title header padding in the big sizing scheme.

$header-year-color :  color

DatePanel year (with split titles) color.

$header-year-opacity :  Number

DatePanel year (with split titles) opacity.

$header-year-font-size :  Number

DatePanel year (with split titles) font size.

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

DatePanel year (with split titles) font size in the big sizing scheme.

$header-year-font-family :  String

DatePanel year (with split titles) font family.

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

DatePanel year (with split titles) font weight.

$header-year-line-height :  Number

DatePanel year (with split titles) line height.

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

DatePanel year (with split titles) line height in the big sizing scheme.

$header-year-inactive-color :  color

DatePanel year (with split titles) inactive year color.

$header-year-inactive-opacity :  color

DatePanel year (with split titles) inactive year opacity.

$header-year-inactive-font-size :  Number

DatePanel year (with split titles) inactive year font size.

$header-year-inactive-font-size-big :  Number

DatePanel year (with split titles) inactive year font size in the big sizing scheme.

$header-title-inactive-color :  color

DatePanel title (with split titles) inactive color.

$header-title-inactive-opacity :  Number

DatePanel title (with split titles) inactive opacity.

$header-title-inactive-font-size :  Number

DatePanel title (with split titles) inactive font size.

$header-title-inactive-font-size-big :  Number

DatePanel title (with split titles) inactive font size in the big sizing scheme.

$header-inactive-transition :  list

DatePanel title (with split titles) inactive transition.

$background-color :  color

DatePanel background-color

$border-color :  color/list

DatePanel border-color

$border-width :  Number/list

DatePanel border-width

$border-style :  String/list

DatePanel border-style

$border-radius :  Number/list

DatePanel border-radius

$border-radius-big :  Number/list

DatePanel border-radius in the big sizing scheme

$body-background-color :  color

DatePanel body background-color

$body-color :  color

DatePanel body text color

$body-border-color :  color

DatePanel body border-color

$body-border-width :  Number/list

DatePanel body border-width

$body-border-style :  Number/list

DatePanel body border-style

$body-font-weight :  String/Number

DatePanel body font-weight

$body-font-size :  Number

DatePanel body font-size

$body-font-size-big :  Number

DatePanel body font-size in the big sizing scheme

$body-line-height :  Number

DatePanel body line-height

$body-line-height-big :  Number

DatePanel body line-height in the big sizing scheme

$body-font-family :  String

DatePanel body font-family

$body-padding :  Number/list

DatePanel body padding

$body-padding-big :  Number/list

DatePanel body padding in the big sizing scheme

$header-background-color :  color

DatePanel Header background-color

$header-background-gradient :  String/list

DatePanel 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

DatePanel Header text color

$header-border-color :  color/list

DatePanel Header border-color

$header-border-width :  Number/list

DatePanel Header border-width

$header-border-style :  String/list

DatePanel Header border-style

$header-font-weight :  String/Number

DatePanel Header font-weight

$header-font-size :  Number

DatePanel Header font-size

$header-font-size-big :  Number

DatePanel Header font-size in the big sizing scheme

$header-line-height :  Number

DatePanel Header line-height

$header-line-height-big :  Number

DatePanel Header line-height in the big sizing scheme

$header-font-family :  String

DatePanel Header font-family

$header-padding :  Number/list

DatePanel Header padding

$header-padding-big :  Number/list

DatePanel Header padding in the big sizing scheme

$header-title-padding :  Number/list

DatePanel Header Title padding

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

DatePanel Header Title padding in the big sizing scheme

$header-title-opacity :  Number

DatePanel Header Title opacity

$header-shadow :  shadow

DatePanel Header Shadow

$header-z-index :  Number

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

$header-min-height :  Number

DatePanel Header min-height

$header-min-height-big :  Number

DatePanel Header min-height in the big sizing scheme

$header-icon-color :  color

DatePanel Header icon color.

$header-icon-size :  Number

DatePanel Header icon size

$header-icon-size-big :  Number

DatePanel Header icon size in the big sizing scheme

$header-icon-font-size :  Number

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

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

DatePanel Header icon font-size in the big sizing scheme

$header-icon-horizontal-spacing :  Number

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

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

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

$header-icon-vertical-spacing :  Number

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

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

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

$header-icon-opacity :  Number

DatePanel Header icon opacity

$tool-color :  color

DatePanel Tool color

$tool-hovered-color :  Number

DatePanel Tool color when hovered

$tool-pressed-color :  Number

DatePanel Tool color when pressed

$tool-disabled-color :  Number

DatePanel Tool color when disabled

$tool-background-color :  color

DatePanel Tool background-color

$tool-hovered-background-color :  Number

DatePanel Tool background-color when hovered

$tool-pressed-background-color :  Number

DatePanel Tool background-color when pressed

$tool-disabled-background-color :  Number

DatePanel Tool background-color when disabled

$tool-opacity :  Number

DatePanel Tool opacity

$tool-hovered-opacity :  Number

DatePanel Tool opacity when hovered

$tool-pressed-opacity :  Number

DatePanel Tool opacity when pressed

$tool-disabled-opacity :  Number

DatePanel Tool opacity when disabled

$tool-border-radius :  Number

DatePanel Tool border radius

$tool-border-radius-big :  Number

DatePanel Tool border radius in the big sizing scheme

$tool-size :  Number

DatePanel Tool size

$tool-size-big :  Number

DatePanel Tool size in the big sizing scheme

$tool-font-size :  Number

DatePanel Tool font-size

$tool-font-size-big :  Number

DatePanel Tool font-size in the big sizing scheme

$tool-spacing :  Number

The space between DatePanel Tools

$tool-spacing-big :  Number

The space between DatePanel Tools in the big sizing scheme

$tool-cursor :  String

DatePanel Tool cursor

$tool-disabled-cursor :  String

DatePanel Tool cursor when disabled

$tool-focused-outline-width :  Number

DatePanel Tool outline width when focused

$tool-focused-outline-style :  String

DatePanel Tool outline style when focused

$tool-focused-outline-color :  color

DatePanel Tool outline color when focused

$tool-focused-outline-offset :  Number

DatePanel Tool outline offset when focused

$anchor-border-color :  color

DatePanel anchor border-color

$anchor-background-color :  color

DatePanel 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

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