Docs Help

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.

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

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

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.

Ext JS 6.2.1 - Classic Toolkit


top

Ext.calendar.view.Day xtype: calendar-dayview premium

Summary

For an overview of calendar views see Ext.calendar.view.Base

The Day view operates the same as its parent Ext.calendar.view.Days view with one notable difference: the cfg-visibleDays for the Day view is 1 resulting in only a single day displayed at a time.

Alternative Classes

If your view requires a header showing the date displayed consider using Ext.calendar.panel.Day instead. To display more than a single day consider using the Ext.calendar.view.Days or Ext.calendar.view.Week views.

No members found using the current filters

configs

Optional Configs

addForm : Object
bindable bind

The configuration for the Ext.calendar.form.Add to be used when an event is to be created. Use null to disable creation.

Defaults to:

{
    xtype: 'calendar-form-add'
}

getAddForm : Object

Returns the value of addForm

Returns

Object

setAddForm (addForm)

Sets the value of addForm

Parameters

addForm :  Object

allowSelection : Boolean
bindable bind

true to allow selection in the UI to create events. This includes being able to drag-select a range in the all day area, as well as click/tap in the day area (the dedicated space just above the start time's row) to create an event.

See method-showAddForm for adding an event when selection is disabled.

Defaults to:

true

getAllowSelection : Boolean

Returns the value of allowSelection

Returns

Boolean

setAllowSelection (allowSelection)

Sets the value of allowSelection

Parameters

allowSelection :  Boolean

baseCls : String / Boolean
bindable bind protected pro

The base CSS class to apply to this widget's element. Used as the prefix for ui-specific class names. When set to true the classCls will be used as the baseCls

Defaults to:

true

getBaseCls : String / Boolean

Returns the value of baseCls

Returns

String / Boolean

setBaseCls (baseCls)

Sets the value of baseCls

Parameters

baseCls :  String / Boolean

bind : Object / String
bindable bind

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

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

To dynamically add bindings:

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

To remove bindings:

 panel.setBind({
     title: null
 });

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

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

Defaults to:

null

getBind : Object / String

Returns the value of bind

Returns

Object / String

setBind (bind)

Sets the value of bind

Parameters

bind :  Object / String

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

Using style:

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

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

Using CSS:

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

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

And your CSS file:

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

Defaults to:

null

getBorder : Boolean

Returns the value of border

Returns

Boolean

setBorder (border)

Sets the value of border

Parameters

border :  Boolean

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 Ext.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[]

compact : Boolean
bindable bind

true to display this view in compact mode, typically used for smaller form factors. Setting to true applies any configured cfg-compactOptions.

Defaults to:

false

getCompact : Boolean

Returns the value of compact

Returns

Boolean

setCompact (compact)

Sets the value of compact

Parameters

compact :  Boolean

compactOptions : Object
bindable bind

A series of config options for this class to set when this class is in cfg-compact mode.

Defaults to:

null

getCompactOptions : Object

Returns the value of compactOptions

Returns

Object

setCompactOptions (compactOptions)

Sets the value of compactOptions

Parameters

compactOptions :  Object

controller : String / Object / Ext.app.ViewController
bindable bind

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

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

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

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

Defaults to:

null

getController Ext.app.ViewController

Returns the Ext.app.ViewController instance associated with this component via the controller config or setController method.

Returns

:Ext.app.ViewController
Returns this component's ViewController or null if one was not configured

setController (controller)

Sets the value of controller

Parameters

controller :  String / Object / Ext.app.ViewController

controlStoreRange : Boolean
bindable bind private pri

true to allow this view to set the date range on event stores in reaction to the value changing. The need to disable this surfaces when using multiple views together and allowing one view (the one with the largest range) to be the in control of loading the stores.

Defaults to:

true

getControlStoreRange : Boolean

Returns the value of controlStoreRange

Returns

Boolean

setControlStoreRange (controlStoreRange)

Sets the value of controlStoreRange

Parameters

controlStoreRange :  Boolean

defaultListenerScope : Boolean
bindable bind

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

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

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

Defaults to:

false

getDefaultListenerScope : Boolean

Returns the value of defaultListenerScope

Returns

Boolean

setDefaultListenerScope (defaultListenerScope)

Sets the value of defaultListenerScope

Parameters

defaultListenerScope :  Boolean

displayOverlap : Boolean
bindable bind

When displaying events, allow events that intersect to horizontally overlap to save on horizontal space.

Defaults to:

true

getDisplayOverlap : Boolean

Returns the value of displayOverlap

Returns

Boolean

setDisplayOverlap (displayOverlap)

Sets the value of displayOverlap

Parameters

displayOverlap :  Boolean

draggable : Boolean
bindable bind

true to allows events to be dragged from this view.

Defaults to:

true

getDraggable : Boolean

Returns the value of draggable

Returns

Boolean

setDraggable (draggable)

Sets the value of draggable

Parameters

draggable :  Boolean

droppable : Boolean
bindable bind

true to allows events to be dropped on this view.

Defaults to:

true

getDroppable : Boolean

Returns the value of droppable

Returns

Boolean

setDroppable (droppable)

Sets the value of droppable

Parameters

droppable :  Boolean

editForm : Object
bindable bind

The configuration for the Ext.calendar.form.Edit to be used when an event is to be modified. Use null to disable editing.

Defaults to:

{
    xtype: 'calendar-form-edit'
}

getEditForm : Object

Returns the value of editForm

Returns

Object

setEditForm (editForm)

Sets the value of editForm

Parameters

editForm :  Object

endTime : Number
bindable bind

The hour number to end this view. Should be a value between 1 and 24.

Defaults to:

20

getEndTime : Number

Returns the value of endTime

Returns

Number

setEndTime (endTime)

Sets the value of endTime

Parameters

endTime :  Number

eventDefaults : Object
bindable bind

The default configuration for Ext.calendar.Event widgets

Defaults to:

{
    xtype: 'calendar-event'
}

getEventDefaults : Object

Returns the value of eventDefaults

Returns

Object

setEventDefaults (eventDefaults)

Sets the value of eventDefaults

Parameters

eventDefaults :  Object

gestureNavigation : Boolean
bindable bind

Allow the view to have the value (displayed date range) changed via swipe navigation on devices that support it

Defaults to:

true

getGestureNavigation : Boolean

Returns the value of gestureNavigation

Returns

Boolean

setGestureNavigation (gestureNavigation)

Sets the value of gestureNavigation

Parameters

gestureNavigation :  Boolean

header : Ext.calendar.header.Base
bindable bind private pri

A Ext.calendar.header.Base object to link to this view

Defaults to:

null

getHeader : Ext.calendar.header.Base

Returns the value of header

Returns

Ext.calendar.header.Base

setHeader (header)

Sets the value of header

Parameters

header :  Ext.calendar.header.Base

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

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 Ext.view.View'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

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

Defaults to:

null

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

publishes : String / String[] / Object
bindable bind

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

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

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

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

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

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

Classes must provide this config as an Object:

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

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

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

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

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

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

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

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

Defaults to:

null

Available since: 5.0.0

getPublishes : String / String[] / Object

Returns the value of publishes

Returns

String / String[] / Object

setPublishes (publishes)

Sets the value of publishes

Parameters

publishes :  String / String[] / Object

reference : String
bindable bind

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

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

Defaults to:

null

getReference : String

Returns the value of reference

Returns

String

setReference (reference)

Sets the value of reference

Parameters

reference :  String

resizeEvents : Boolean
bindable bind

true to allow events in the day area to be resized.

Defaults to:

true

getResizeEvents : Boolean

Returns the value of resizeEvents

Returns

Boolean

setResizeEvents (resizeEvents)

Sets the value of resizeEvents

Parameters

resizeEvents :  Boolean

session : Boolean / Object / Ext.data.Session
bindable bind

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

To create a new session you can specify true:

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

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

Alternatively, a config object can be provided:

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

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

Defaults to:

null

getSession : Boolean / Object / Ext.data.Session

Returns the value of session

Returns

Boolean / Object / Ext.data.Session

setSession (session)

Sets the value of session

Parameters

session :  Boolean / Object / Ext.data.Session

showNowMarker : Boolean
bindable bind

true to show a marker on the view that equates to the current local time.

Defaults to:

true

getShowNowMarker : Boolean

Returns the value of showNowMarker

Returns

Boolean

setShowNowMarker (showNowMarker)

Sets the value of showNowMarker

Parameters

showNowMarker :  Boolean

startTime : Number
bindable bind

The hour number to start this view. Should be a value between 0 and 23.

Defaults to:

8

getStartTime : Number

Returns the value of startTime

Returns

Number

setStartTime (startTime)

Sets the value of startTime

Parameters

startTime :  Number

store : Object / Ext.calendar.store.Calendars
bindable bind

A Ext.calendar.store.Calendars instance or configuration

Defaults to:

null

setStore (store)

Sets the value of store

Parameters

store :  Object / Ext.calendar.store.Calendars

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

getStyle : String / Object

Returns the value of style

Returns

String / Object

setStyle (style)

Sets the value of style

Parameters

style :  String / Object

timeFormat : String
bindable bind

The format to display the time values in the time gutter.

Refer to the class description of Ext.Date for formatting options.

Example format for displaying a 12-hour time with an am/pm suffix:

timeFormat: 'h:ia' // displays 14:00 hours as 2:00pm

Defaults to:

'H:i'

getTimeFormat : String

Returns the value of timeFormat

Returns

String

setTimeFormat (timeFormat)

Sets the value of timeFormat

Parameters

timeFormat :  String

timeRenderer : Function
bindable bind

A formatting function for more complex displays of time values in the time gutter.

Defaults to:

null

Parameters

hour :  Number

The hour being shown.

formatted :  String

The formatted value as specified by the timeFormat.

firstInGroup :  Boolean

`true` if this hour is the first hour in the specified time range to be in the morning (< 12) or in the afternoon > 12.

getTimeRenderer : Function

Returns the value of timeRenderer

Returns

Function

setTimeRenderer (timeRenderer)

Sets the value of timeRenderer

Parameters

timeRenderer :  Function

timezoneOffset : Number
bindable bind

The timezone offset to display this calendar in. The value should be specified in the same way as the native Date offset. That is, the number of minutes between UTC and local time. For example the offset for UTC+10 would be -600 (10 hours * 60 minutes ahead).

Defaults to the current browser offset.

Defaults to:

undefined

getTimezoneOffset : Number

Returns the value of timezoneOffset

Returns

Number

setTimezoneOffset (timezoneOffset)

Sets the value of timezoneOffset

Parameters

timezoneOffset :  Number

touchAction : Object
bindable bind

Emulates the behavior of the CSS href="https://www.w3.org/TR/pointerevents/#the-touch-action-css-property" class="external-link" target="_blank">https://www.w3.org/TR/pointerevents/#the-touch-action-css-property touch-action property in a cross-browser compatible manner.

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

  • panX
  • panY
  • pinchZoom
  • doubleTapZoom

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

touchAction: {
    panX: false,
    pinchZoom: false
}

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

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

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

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

Defaults to:

null

getTouchAction : Object

Returns the value of touchAction

Returns

Object

setTouchAction (touchAction)

Sets the value of touchAction

Parameters

touchAction :  Object

twoWayBindable : String / String[] / Object
bindable bind

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

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

Defaults to:

null

getTwoWayBindable : String / String[] / Object

Returns the value of twoWayBindable

Returns

String / String[] / Object

setTwoWayBindable (twoWayBindable)

Sets the value of twoWayBindable

Parameters

twoWayBindable :  String / String[] / Object

ui : String / String[]
bindable bind

The ui or uis to be used on this Component

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

Defaults to:

null

getUi : String / String[]

Returns the value of ui

Returns

String / String[]

setUi (ui)

Sets the value of ui

Parameters

ui :  String / String[]

userCls : String / String[]
bindable bind

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

For example:

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

Defaults to:

null

getUserCls : String / String[]

Returns the value of userCls

Returns

String / String[]

setUserCls (userCls)

Sets the value of userCls

Parameters

userCls :  String / String[]

value : Date
bindable bind

The value to start the view from. The events displayed on this view are configured by the value and the visibleDays.

Defaults to:

new Date()

getValue : Date

Returns the value of value

Returns

Date

setValue (value)

Sets the value of value

Parameters

value :  Date

viewModel : String / Object / Ext.app.ViewModel
bindable bind

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

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

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

Defaults to:

null

getViewModel : String / Object / Ext.app.ViewModel

Returns the value of viewModel

Returns

String / Object / Ext.app.ViewModel

setViewModel (viewModel)

Sets the value of viewModel

Parameters

viewModel :  String / Object / Ext.app.ViewModel

visibleDays : Number
bindable bind

The number of days to show starting from the cfg-value.

Defaults to:

4

getVisibleDays : Number

Returns the value of visibleDays

Returns

Number

setVisibleDays (visibleDays)

Sets the value of visibleDays

Parameters

visibleDays :  Number

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

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

The value true causes config values to be stored on instances using a property name prefixed with an underscore ("_") character. A value of false stores config values as properties using their exact name (no prefix).

Defaults to:

true

Available since: 5.0.0

$configStrict : Boolean
private pri

The value true instructs the initConfig method to only honor values for properties declared in the config block of a class. When false, properties that are not declared in a config block will be placed on the instance.

Defaults to:

true

Available since: 5.0.0

$eventOptions
private pri

Matches options property names within a listeners specification object - property names which are never used as event names.

Defaults to:

{
    scope: 1,
    delay: 1,
    buffer: 1,
    onFrame: 1,
    single: 1,
    args: 1,
    destroyable: 1,
    priority: 1,
    order: 1
}

$vetoClearingPrototypeOnDestroy
private pri

We don't want the base destructor to clear the prototype because our destroyObservable handler must be called the very last. It will take care of the prototype after completing Observable destruction sequence.

Defaults to:

true

classCls
protected pro

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

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

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

var bar = new Bar();

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

Defaults to:

null

classClsRoot
protected pro

When set to true during widget class definition, that class will be the "root" for classCls inheritance. Derived classes may set this to true to avoid inheriting a classCls from their superclass.

Defaults to:

true

clearPropertiesOnDestroy : Boolean / "async"
protected pro

Setting this property to false will prevent nulling object references on a Class instance after destruction. Setting this to "async" will delay the clearing for approx 50ms.

Defaults to:

true

Available since: 6.2.0

clearPrototypeOnDestroy : Boolean
private pri

Setting this property to true will result in setting the object's prototype to null after the destruction sequence is fully completed. After that, most attempts at calling methods on the object instance will result in "method not defined" exception. This can be very helpful with tracking down otherwise hard to find bugs like runaway Ajax requests, timed functions not cleared on destruction, etc.

Note that this option can only work in browsers that support Object.setPrototypeOf method, and is only available in debugging mode.

Defaults to:

false

Available since: 6.2.0

dateInfo : Object
private pri

Contains information about the current date ranges.

Defaults to:

null

defaultBindProperty : String
protected pro

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

 bind: '{name}'

Is equivalent to this object form:

 bind: {
     value: '{name}'
 }

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

Defaults to:

null

destroyed : Boolean
protected pro

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

Defaults to:

false

doRefresh
private pri

Execute a full refresh of the view and events.

Defaults to:

Ext.privateFn

doRefreshEvents
private pri

Execute a full refresh of events.

Defaults to:

Ext.privateFn

element : Object
protected pro

A configuration object for Ext.Element.create() that is used to create the Element template. Supports all the standard options of a Ext.Element.create() config and adds 2 additional options:

  1. reference - this option specifies a name for Element references. These references names become properties of the Widget instance and refer to Ext.Element instances that were created using the template:

    element: {

     reference: 'element',
     children: [{
         reference: 'innerElement'
     }]
    

    }

After construction of a widget the reference elements are accessible as follows:

var foo = new FooWidget(),
    innerEl = foo.innerElement; // an Ext.Element that wraps the innerElement

The reference attribute is optional, but all Widgets must have a 'element' reference on some element within the template (usually the outermost one).

  1. listeners - a standard listeners object as specified by Ext.mixin.Observable.

    element: {

     reference: 'element',
     listeners: {
         click: 'onClick'
     },
     children: [{
         reference: 'innerElement',
         listeners: {
             click: 'onInnerClick'
         }
     }]
    

    }

Since listeners cannot be attached without an Ext.Element reference the reference property MUST be specified in order to use listeners.

The Widget instance is used as the scope for all listeners specified in this way, so it is invalid to use the scope option in the listeners config since it will always be overwritten using this.

Defaults to:

{
    reference: 'element'
}

eventsSuspended
private pri

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to:

0

getMoveInteral
private pri

Get the period to move when using moveNext and movePrevious.

Defaults to:

Ext.privateFn

Returns

:Object
The period to move

unit :  String

The units to move, see Ext.Date.

amount :  Number

The number of units to move.

handleResize
private pri

Handle resizing of the main view element.

Defaults to:

Ext.privateFn

hasListeners : Object
readonly ro

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

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

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

isConfiguring : Boolean
readonly ro protected pro

This property is set to true during the call to initConfig.

Defaults to:

false

Available since: 5.0.0

isFirstInstance : Boolean
readonly ro protected pro

This property is set to true if this instance is the first of its class.

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to:

true

isObservable : Boolean

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

Defaults to:

true

noBorderCls : String
readonly ro private pri

The CSS class to add to this component should not have a border.

Defaults to:

Ext.baseCSSPrefix + 'noborder-trbl'

self : Ext.Class
protected pro

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

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

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

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


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

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

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

Defaults to:

Base

template : Array
protected pro

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

Defaults to:

[]

validRefRe : RegExp
private pri

Regular expression used for validating reference values.

Defaults to:

/^[a-z_][a-z0-9_]*$/i

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

_addDeclaredListeners ( listeners ) : Boolean
private pri

Adds declarative listeners as nested arrays of listener objects.

Parameters

listeners :  Array

Returns

:Boolean
`true` if any listeners were added

activatePlugin ( type ) : Ext.plugin.Abstract
private pri

Creates a particular plugin type if defined in the plugins configuration.

Available since: 6.2.0

Parameters

type :  String

The `type` of the plugin.

Returns

:Ext.plugin.Abstract
The plugin that was created.

addBindableUpdater ( property )
private pri

Ensures that the given property (if it is a Config System config) has a proper "updater" method on this instance to sync changes to the config.

Available since: 5.0.0

Parameters

property :  String

The name of the config property.

addDelegatedListener ( eventName, fn, scope, options, order, caller, manager )
private pri

Adds a listeners with the "delegate" event option. Users should not invoke this method directly. Use the "delegate" event option of addListener instead.

Parameters

eventName :  Object

fn :  Object

scope :  Object

options :  Object

order :  Object

caller :  Object

manager :  Object

addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

Parameters

deprecations :  Object

addElementReference ( name, domNode ) : Ext.dom.Element
private pri

Adds an element reference to this Widget instance.

Parameters

name :  String

The name of the reference

domNode :  HTMLElement

Returns

:Ext.dom.Element

addElementReferenceOnDemand ( name, domNode )
private pri

Reduces instantiation time for a Widget by lazily instantiating Ext.Element references the first time they are used. This optimization only works for elements with no listeners specified.

Parameters

name :  String

The name of the reference

domNode :  HTMLElement

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

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 set of arguments to pass to the handler function before the actual fired event arguments. For example, if args is set to ['foo', 42], the event handler function will be called with an arguments list like this:

 handler('foo', 42, <actual event 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: '

BODY TITLE

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.

applyBind ( binds, currentBindings ) : Object
private pri

Available since: 5.0.0

Parameters

binds :  String/Object

currentBindings :  Object

Returns

:Object

applyPlugins ( plugins, oldPlugins )
private pri

Applier for the plugins config property.

Parameters

plugins :  String[]/Object[]/Ext.plugin.Abstract[]

The new plugins to use.

oldPlugins :  Ext.plugin.Abstract[]

The existing plugins in use.

applySession ( session ) : Ext.data.Session
private pri

Transforms a Session config to a proper instance.

Available since: 5.0.0

Parameters

session :  Object

Returns

:Ext.data.Session

applyStyle ( style, oldStyle )
protected pro

Parameters

style :  Object

oldStyle :  Object

applyViewModel ( viewModel ) : Ext.app.ViewModel
private pri

Transforms a ViewModel config to a proper instance.

Available since: 5.0.0

Parameters

viewModel :  String/Object/Ext.app.ViewModel

Returns

:Ext.app.ViewModel

calculateMoveNext Date
private pri

Calculate the value to use for moveNext

Returns

:Date
The new value.

calculateMovePrevious Date
private pri

Calculate the value to use for movePrevious

Returns

:Date
The new value.

calculateSlots
private pri

Calculate the total number of half hour slots available given the current time range.

callOverridden ( args ) : Object
deprecated dep protected pro

Call the original method that was previously overridden with Ext.Base#override

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.callOverridden();

        alert("Meeeeoooowwww");
    }
});

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

Parameters

args :  Array/Arguments

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

Returns

:Object
Returns the result of calling the overridden method

Deprecated since version 4.1.0

callParent ( args ) : Object
protected pro

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static and private methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10));     // alerts 10
 alert(My.Derived2.method(10)); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

To override a method and replace it and also call the superclass method, use method-callSuper. This is often done to patch a method to fix a bug.

Parameters

args :  Array/Arguments

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

Returns

:Object
Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     extend: 'Ext.some.Class',

     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an override:

 Ext.define('App.patches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

The patch method cannot use method-callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

Parameters

args :  Array/Arguments

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

Returns

:Object
Returns the result of calling the superclass method

checkNowMarker
private pri

Check for a position update of the now marker. This is contingent on the config to show the marker being enabled.

clearAndPopulate ( row, nodes, [clearAll] )
private pri

Clear a row element and populate it with child nodes.

Parameters

row :  Ext.dom.Element

The row

nodes :  Object[]

The configuration for the new nodes to add.

clearAll :  Boolean (optional)

`true` to clear all nodes. `false` to leave the last node (gutter).

Defaults to: false

clearDelegatedListeners
private pri

Clears all listeners that were attached using the "delegate" event option. Users should not invoke this method directly. It is called automatically as part of normal clearListeners processing.

clearEvents
private pri

Clear events from the view.

clearListeners

Removes all listeners for this object including the managed listeners

clearManagedListeners

Removes all managed listeners for this object.

clearSelected
private pri

Clear the selected range in the allday portion.

constructAllDayEvents ( events )
private pri

Construct all day events.

Parameters

events :  Ext.calendar.model.EventBase[]

The events.

constructEvents
private pri

Construct all events.

createAddForm Object
protected pro

Create the add form configuration. Can be hooked to provide any runtime customization.

Returns

:Object
A configuration for the form instance.

createEditForm ( event ) : Object
protected pro

Create the edit form configuration. Can be hooked to provide any runtime customization.

Parameters

event :  Object

Returns

:Object
A configuration for the form instance.

createEvent ( event, [cfg], [dummy] ) : Ext.calendar.EventBase
private pri

Create an event widget.

Parameters

event :  Ext.calendar.model.EventBase

The event record.

cfg :  Object (optional)

A config for the event.

dummy :  Boolean (optional)

`true` if this is a dummy event not backed by a record.

Defaults to: false

Returns

:Ext.calendar.EventBase
The event widget.

createEvents ( events, [cfg] ) : Ext.calendar.EventBase[]
private pri

Create a number of event widgets.

Parameters

events :  Ext.calendar.model.EventBase[]

The events.

cfg :  Object (optional)

A config for each event.

Returns

:Ext.calendar.EventBase[]
The event widgets.

createPlugin ( config ) : Ext.plugin.Abstract
private pri

Converts the provided type or config object into a plugin instance.

Parameters

config :  String/Object/Ext.plugin.Abstract

The plugin type, config object or instance.

Returns

:Ext.plugin.Abstract

createRelayer ( newName, [beginEnd] ) : Function
private pri

Creates an event handling function which re-fires the event from this object as the passed event name.

Parameters

newName :  String

The name under which to re-fire the passed parameters.

beginEnd :  Array (optional)

The caller can specify on which indices to slice.

Returns

:Function

createScroller Ext.scroll.Scroller
private pri

Create the scroller.

Returns

:Ext.scroll.Scroller
The scroller.

destroy

Destroys the Widget. This method should not be overridden in custom Widgets, because it sets the flags and does final cleanup that must go last. Instead, override doDestroy method to add functionality at destruction time.

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.

doAddListener ( name, fn, scope, options, order, caller, manager )
private pri

Parameters

name :  Object

fn :  Object

scope :  Object

options :  Object

order :  Object

caller :  Object

manager :  Object

doCheckNowMarker
private pri

Checks the position of the now marker, hides/shows it in the correct place as required. Does not check the existence of the config flag, assumes it's true at this point.

doDestroy

Perform the actual destruction sequence. This is the method to override in your subclasses to add steps specific to the destruction of custom Component or Widget.

As a rule of thumb, subclasses should destroy their child Components, Elements, and/or other objects before calling parent method. Any object references will be nulled after this method has finished, to prevent the possibility of memory leaks.

Available since: 6.2.0

doFireDelegatedEvent ( eventName, args )
private pri

Fires a delegated event. Users should not invoke this method directly. It is called automatically by the framework as needed (see the "delegate" event option of addListener for more details.

Parameters

eventName :  Object

args :  Object

doFireEvent ( eventName, args, bubbles )
private pri

Continue to fire event.

Parameters

eventName :  String

args :  Array

bubbles :  Boolean

doRecalculate ( [start] ) : Object
private pri

Do range recalculation.

Parameters

start :  Date (optional)

The start to recalculate from. Defaults to the current value.

Returns

:Object

full :  Ext.calendar.date.Range

The full date range (with times cleared).

visible :  Ext.calendar.date.Range

The visible date range (with times based on the cfg-startTime and cfg-endTime

start :  Date

The start date.

end :  Date

The end date.

doShowForm ( event, type, cfg, successFn, [options] )
private pri

Show a form for this calendar.

Parameters

event :  Ext.calendar.model.EventBase

The event.

type :  Object

cfg :  Object

The config for the form.

successFn :  Function

A function to call if the edit is successful.

options :  Object (optional)

Callback options for form creation.

onSave :  Function (optional)

A save callback function.

onCancel :  Function (optional)

A cancel callback function.

scope :  Object (optional)

A scope for the callback functions.

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.

fireAction ( eventName, args, fn, [scope], [options], [order] )
deprecated dep

Fires the specified event with the passed parameters and executes a function (action). By default, the action function will be executed after any "before" event handlers (as specified using the order option of addListener), but before any other handlers are fired. This gives the "before" handlers an opportunity to cancel the event by returning false, and prevent the action function from being called.

The action can also be configured to run after normal handlers, but before any "after" handlers (as specified using the order event option) by passing 'after' as the order parameter. This configuration gives any event handlers except for "after" handlers the opportunity to cancel the event and prevent the action function from being called.

Parameters

eventName :  String

The name of the event to fire.

args :  Array

Arguments to pass to handlers and to the action function.

fn :  Function

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

options :  Object (optional)

Event options for the action function. Accepts any of the options of addListener

order :  String (optional)

The order to call the action function relative too the event handlers (`'before'` or `'after'`). Note that this option is simply used to sort the action function relative to the event handlers by "priority". An order of `'before'` is equivalent to a priority of `99.5`, while an order of `'after'` is equivalent to a priority of `-99.5`. See the `priority` option of addListener for more details.

Defaults to: 'before'

Deprecated since version 5.5

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

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.

Returns

:Boolean

fixReference
private pri

Sets up a reference on our current reference holder.

generateAllDayCells ( [cls], [html] ) : Object[]
private pri

Generate cells for the all day portion of the view.

Parameters

cls :  String (optional)

The class to add to the cells.

html :  String (optional)

The markup to add to the cell.

Returns

:Object[]
The DOM configs for the cells.

generateColumns Object[]
private pri

Generate the column elements for the days.

Returns

:Object[]
The DOM configs for the column elements.

generateTimeElements Object[]
private pri

Generate the time elements for the gutter.

Returns

:Object[]
The DOM configs for the time elements.

generateTimeLabels String[]
private pri

Generate the labels for the time gutter.

Returns

:String[]
The times.

getBodyElement Ext.dom.Element
private pri

Get the body element of this view.

Returns

:Ext.dom.Element
The body.

getBubbleParent Ext.util.Observable
private pri

Gets the bubbling parent for an Observable

Returns

:Ext.util.Observable
The bubble parent. null is returned if no bubble target exists

getCalendar ( id ) : Ext.calendar.model.CalendarBase
private pri

Get a calendar by id.

Parameters

id :  Object

The id of the calendar.

Returns

:Ext.calendar.model.CalendarBase
The calendar

getColumn ( index ) : HTMLElement
private pri

Get a day column by index.

Parameters

index :  Number

The index of the column.

Returns

:HTMLElement
The column.

getColumns HTMLElement[]
private pri

Get all day columns.

Returns

:HTMLElement[]
The columns.

getConfig ( [name], [peek] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

name :  String (optional)

The name of the config property to get.

peek :  Boolean (optional)

`true` to peek at the raw value without calling the getter.

Defaults to: false

Returns

:Object
The config property value.

getDaysSpanned ( start, end, allDay ) : Number
private pri

Get the number of days covered for a range. For example, 2010-01-01 22:00, 2010-01-02 01:00 is 2 days because it has boundaries within 2 days.

Parameters

start :  Date

The start of the range.

end :  Date

The end of the range.

allDay :  Boolean

`true` if the time range should be considered as an all day event.

Returns

:Number
The number of days spanned.

getDefaultCreateRange Ext.calendar.date.Range
private pri

The the default range when creating a event.

Returns

:Ext.calendar.date.Range
The range.

getDefaultPalette Ext.calendar.theme.Palette
private pri

Get the default color palette for this view. Defaults to the color of the first calendar, otherwise the first color in the palette.

Returns

:Ext.calendar.theme.Palette
The color palette.

getDisplayRange Ext.calendar.date.Range

Get the display range for this view.

Returns

:Ext.calendar.date.Range
The display range.

getEditableCalendars Ext.calendar.model.CalendarBase[]
private pri

Get all calendars that are editable.

Returns

:Ext.calendar.model.CalendarBase[]
The editable calendars.

getElementConfig Object
protected pro

A template method for modifying the element config before it is processed. By default adds the result of this.getTemplate() as the children array of element if children were not specified in the original element config. Typically this method should not need to be implemented in subclasses. Instead the element property should be use to configure the element template for a given Widget subclass.

This method is called once when the first instance of each Widget subclass is created. The element config object that is returned is cached and used as the template for all successive instances. The scope object for this method is the class prototype, not the instance.

Returns

:Object
the element config object

getEvent ( el ) : Ext.calendar.model.EventBase
private pri

Get an event record via element/DOM event.

Parameters

el :  Ext.dom.Element/HTMLElement/Ext.event.Event

The element target,

Returns

:Ext.calendar.model.EventBase
The event record.

getEventColumn ( index ) : HTMLElement
private pri

Get the event container for a column by index.

Parameters

index :  Number

The index of the event container column.

Returns

:HTMLElement
The event container.

getEventDaysSpanned ( event ) : Number
private pri

See getDaysSpanned.

Parameters

event :  Ext.calendar.model.EventBase

The event.

Returns

:Number
The number of days spanned.

getEventPalette ( event ) : Ext.calendar.theme.Palette
private pri

Get the palette for an event record.

Parameters

event :  Ext.calendar.model.EventBase

The event record.

Returns

:Ext.calendar.theme.Palette
The palette.

getEventSource Ext.calendar.store.EventSource

Get the Ext.calendar.store.EventSource for this view.

Returns

:Ext.calendar.store.EventSource
The event source.

getEventStyle Object
private pri

Get styles regarding events. Creates a fake event and measures pieces of the componentry.

Returns

:Object
Size info.

margin :  Object

The margins for the event.

resizerWidth :  Number

The width of the resizer element.

getEventWidget ( event ) : Ext.calendar.EventBase
private pri

Find an event widget via record.

Parameters

event :  Ext.calendar.model.EventBase

The event record.

Returns

:Ext.calendar.EventBase
The event widget. `null` if not found.

getForm Ext.calendar.form.Base

Get the active cfg-editForm or cfg-addForm if it exists.

Returns

:Ext.calendar.form.Base
The active form. `null` if not active.

getId String

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

Returns

:String
id

getInherited ( [inner] ) : Object

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

Available since: 5.0.0

Parameters

inner :  Boolean (optional)

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

Defaults to: false

Returns

:Object
The `inheritedState` object containing inherited properties.

getInheritedConfig ( property, [skipThis] ) : Mixed

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

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

Available since: 5.0.0

Parameters

property :  String

The name of the config property to return.

skipThis :  Boolean (optional)

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

Defaults to: false

Returns

:Mixed
The value of the requested `property`.

getInitialConfig ( [name] ) : Object/Mixed

Returns the initial configuration passed to the constructor when instantiating this class.

Given this example Ext.button.Button definition and instance:

Ext.define('MyApp.view.Button', {
    extend: 'Ext.button.Button',
    xtype: 'mybutton',

    scale: 'large',
    enableToggle: true
});

var btn = Ext.create({
    xtype: 'mybutton',
    renderTo: Ext.getBody(),
    text: 'Test Button'
});

Calling btn.getInitialConfig() would return an object including the config options passed to the create method:

xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'

Calling btn.getInitialConfig('text')returns 'Test Button'.

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed
The full config object or a single config value when `name` parameter specified.

getMoveBaseValue Date
private pri

Get the value to use as the base for moving when using moveNext and movePrevious.

Returns

:Date
The value.

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.

getRefOwner
protected pro

Used by Ext.ComponentQuery, and the up method to find the owning Component in the linkage hierarchy.

By default this returns the Container which contains this Component.

This may be overridden by Component authors who implement ownership hierarchies which are not based upon ownerCt, such as BoundLists being owned by Fields or Menus being owned by Buttons.

getSize Object

Returns the height and width of the Component.

Returns

:Object
The current height and width of the Component.

width :  Number

height :  Number

getSlotStyle Object
private pri

Precalculates the heights of slots for sizing events. Should be invalidated when the view height resizes.

Returns

:Object
The sizes.

hourHeight :  Number

The height of 1 hour in px.

halfHeight :  Number

The height of half an hour in px.

minSlotHeight :  Number

The height of the smallest slot resolution for displayng events.

getSourceListeners Object
private pri

Get listeners to add to the event source.

Returns

:Object
A listeners config.

getStoreListeners Object
private pri

Get listeners to add to the calendar store..

Returns

:Object
A listeners config.

getTdCls
private pri

Needed for when widget is rendered into a grid cell. The class to add to the cell element.

getTdType
private pri

Partner method to getTdCls.

Returns the base type for the component. Defaults to return this.xtype, but All derived classes of Ext.form.field.Text can return the type 'textfield', and all derived classes of Ext.button.Button can return the type 'button'

getUtcNow Date
private pri

Get the current date in UTC.

Returns

:Date
The current UTC date.

getVisibleRange Ext.calendar.date.Range

Get the visible range for this view.

Returns

:Ext.calendar.date.Range
The visible range.

handleChange ( type, event, newRange, [callback] )
private pri

Handle drop on the view.

Parameters

type :  Object

event :  Ext.calendar.model.EventBase

The event.

newRange :  Ext.calendar.date.Range

The new range.

callback :  Function (optional)

A callback to execute.

handleChangeStart ( type, event ) : Boolean
private pri

Handle drag/resize start for an event.

Parameters

type :  String

The event type.

event :  Ext.calendar.model.EventBase

The event.

Returns

:Boolean
`false` to veto the event.

handleEventTap ( e )
private pri

Handle taps on event widgets in the view.

Parameters

e :  Ext.event.Event

The event.

hasConfig ( name )
private pri

Parameters

name :  String

hasEditableCalendars Boolean
private pri

Checks if the store has editable calendars.

Returns

:Boolean
`true` if any calendars are editable.

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`

initBindable
private pri

This method triggers the lazy configs and must be called when it is time to fully boot up. The configs that must be initialized are: bind, publishes, session, twoWayBindable and viewModel.

Available since: 5.0.0

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

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

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

Parameters

instanceConfig :  Object

Returns

:Ext.Base
this

initElement
protected pro

Initializes the Element for this Widget instance. If this is the first time a Widget of this type has been instantiated the element config will be processed to create an Element. This Element is then cached on the prototype (see afterCachedConfig) so that future instances can obtain their element by simply cloning the Element that was cached by the first instance.

initElementListeners ( elementConfig )
private pri

Called for the first instance of this Widget to create an object that contains the listener configs for all of the element references keyed by reference name. The object is cached on the prototype and has the following shape:

_elementListeners: {
    element: {
        click: 'onClick',
        scope: this
    },
    fooReference: {
        tap: {
            fn: someFunction,
            delay: 100
        }
    }
}

The returned object is prototype chained to the _elementListeners object of its superclass, and each key in the object is prototype chained to object with the corresponding key in the superclass _elementListeners. This allows element listeners to be inherited and overridden when subclassing widgets.

This method is invoked with the prototype object as the scope

Parameters

elementConfig :  Object

initInheritedState ( inheritedState, [inheritedStateInner] )
protected pro

This method is called to initialize the inheritedState objects for this instance. This amounts to typically copying certain properties from the instance to the given object.

Available since: 5.0.0

Parameters

inheritedState :  Object

The state object for this instance.

inheritedStateInner :  Object (optional)

This object is only provided for containers.

invalidateInheritedState
private pri

This method marks the current inherited state as invalid. The next time a call is made to getInherited the objects will be recreated and initialized.

Available since: 5.0.0

is ( selector ) : Boolean

Tests whether this Widget matches a Ext.ComponentQuery selector string.

Parameters

selector :  String

The selector string to test against.

Returns

:Boolean
`true` if this Widget matches the selector.

isEventHidden ( event ) : Boolean
private pri

Checks if an event is hidden, by virtue of the calendar being hidden.

Parameters

event :  Ext.calendar.model.EventBase

The event.

Returns

:Boolean
`true` if the event should be hidden.

isHidden ( [deep] ) : Boolean

Returns true if this Component is currently hidden.

Parameters

deep :  Boolean/Ext.Widget (optional)

`true` to check if this component is hidden because a parent container is hidden. Alternatively, a reference to the top-most parent at which to stop climbing.

Defaults to: false

Returns

:Boolean
`true` if currently hidden.

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

isSyncing ( name ) : Boolean
private pri

Checks if a particular binding is synchronizing the value.

Parameters

name :  String

The name of the property being bound to.

Returns

:Boolean
`true` if the binding is syncing.

isVisible ( [deep] ) : Boolean

Returns true if this Component is currently visible.

Parameters

deep :  Boolean (optional)

`true` to check if this component is visible and all parents are also visible.

Defaults to: false

Returns

:Boolean
`true` if currently visible.

isXType ( xtype, [shallow] ) : Boolean

Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended from the xtype (default) or whether it is directly of the xtype specified (shallow = true). **If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.__

For a list of all available xtypes, see the Ext.Component header.

Example usage:

var t = new Ext.field.Text();
var isText = t.isXType('textfield'); // true
var isBoxSubclass = t.isXType('field'); // true, descended from Ext.field.Field
var isBoxInstance = t.isXType('field', true); // false, not a direct Ext.field.Field instance

Parameters

xtype :  String

The xtype to check for this Component.

shallow :  Boolean (optional)

`false` to check whether this Component is descended from the xtype (this is the default), or `true` to check whether this Component is directly of the specified xtype.

Returns

:Boolean
`true` if this component descends from the specified xtype, `false` otherwise.

lookupController ( [skipThis] ) : Ext.app.ViewController

Gets the controller that controls this view. May be a controller that belongs to a view higher in the hierarchy.

Available since: 5.0.1

Parameters

skipThis :  Boolean (optional)

`true` to not consider the controller directly attached to this view (if it exists).

Defaults to: false

Returns

:Ext.app.ViewController
The controller. `null` if no controller is found.

lookupReferenceHolder ( [skipThis] ) : Ext.app.ViewController/Ext.container.Container
private pri

Gets the Controller or Component that is used as the reference holder for this view.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

`false` to return this as the reference holder if this instance has set `referenceHolder`. Unlike getInheritedConfig this method defaults to `true` because it is possible that a reference property set by the owner of a component that is also a `referenceHolder` itself. In this case, the reference connects not to this component but to the parent referenceHolder.

Defaults to: true

Returns

:Ext.app.ViewController/Ext.container.Container
The reference holder.

lookupSession ( [skipThis] ) : Ext.data.Session

Returns the Ext.data.Session for this instance. This property may come from this instance's session or be inherited from this object's parent.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

Pass `true` to ignore a session configured on this instance and only consider an inherited session.

Defaults to: false

Returns

:Ext.data.Session

lookupTpl ( name ) : Ext.XTemplate

Gets a named template instance for this class. See Ext.XTemplate#getTpl.

Available since: 6.2.0

Parameters

name :  String

The name of the property that holds the template.

Returns

:Ext.XTemplate
The template, `null` if not found.

lookupViewModel ( [skipThis] ) : Ext.app.ViewModel

Returns the Ext.app.ViewModel for this instance. This property may come from this this instance's viewModel or be inherited from this object's parent.

Available since: 5.0.0

Parameters

skipThis :  Boolean (optional)

Pass `true` to ignore a viewModel configured on this instance and only consider an inherited view model.

Defaults to: false

Returns

:Ext.app.ViewModel

makeBindableUpdater ( cfg ) : Function
private pri

Returns an update method for the given Config that will call publishState to ensure two-way bindings (via bind) as well as any publishes are updated. This method is cached on the cfg instance for re-use.

Available since: 5.0.0

Parameters

cfg :  Ext.Config

Returns

:Function
The updater function.

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

moveNext

Move the view forward to view the "next" portion of the view based on the current cfg-value. This amount depends on the current view.

movePrevious

Move the view forward to view the "next" portion of the view based on the current cfg-value. This amount depends on the current view.

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.

navigate ( amount, [interval] )

Move the current view by an amount based off of the current cfg-value.

Parameters

amount :  Number

The number of intervals to move

interval :  String (optional)

The interval to navigate by. See Ext.Date for valid intervals.

Defaults to: Ext.Date.DAY

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 set of arguments to pass to the handler function before the actual fired event arguments. For example, if args is set to ['foo', 42], the event handler function will be called with an arguments list like this:

 handler('foo', 42, <actual event 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: '

BODY TITLE

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.

onAllDayTouchEnd ( e )
private pri

Handle touchend on the all day portion of the view.

Parameters

e :  Ext.event.Event

The event.

onAllDayTouchMove ( e )
private pri

Handle touchmove on the all day portion of the view.

Parameters

e :  Ext.event.Event

The event.

onAllDayTouchStart ( e )
private pri

Handle touchstart on the all day portion of the view.

Parameters

e :  Ext.event.Event

The event.

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.

onBodySwipe ( e )
private pri

Handle a swipe on the view body.

Parameters

e :  Ext.event.Event

The event.

onBodyTouchEnd ( e )
private pri

Handle touchend on the body day portion of the view.

Parameters

e :  Ext.event.Event

The event.

onBodyTouchMove ( e )
private pri

Handle touchmove on the body day portion of the view.

Parameters

e :  Ext.event.Event

The event.

onBodyTouchStart ( e )
private pri

Handle touchstart on the body day portion of the view.

Parameters

e :  Ext.event.Event

The event.

onEventTap ( event )
private pri

Handle a tap on an event model.

Parameters

event :  Ext.calendar.model.EventBase

The event model.

onFormCancel ( form )
private pri

Handle the form being cancelled.

Parameters

form :  Ext.calendar.form.Base

The form.

onFormCreateSave ( form, data )
private pri

Handle create form being saved.

Parameters

form :  Ext.calendar.form.Base

The form.

data :  Object

The data from the form.

onFormEditSave ( form, event, data )
private pri

Handle edit form being saved.

Parameters

form :  Ext.calendar.form.Base

The form.

event :  Ext.calendar.model.EventBase

The event being edited.

data :  Object

The data from the form.

onInheritedAdd ( instanced )
private pri

Called when this Inheritable is added to a parent

Parameters

instanced :  Boolean

onInheritedRemove ( destroying )
private pri

Called when this inheritable is removed from a parent

Parameters

destroying :  Boolean

`true` if this item will be destroyed by it's container

onResizerDrag ( e )
private pri

Handle drag on an event resizer.

Parameters

e :  Ext.event.Event

The event.

onResizerDragEnd ( e )
private pri

Handle dragend on an event resizer.

Parameters

e :  Ext.event.Event

The event.

onResizerDragStart ( e )
private pri

Handle dragstart on an event resizer.

Parameters

e :  Ext.event.Event

The event.

onSourceAdd ( source, events )
private pri

Handle records being added to the source.

Parameters

source :  Ext.calendar.store.EventSource

The event source.

events :  Ext.calendar.model.EventBase[]

The events.

onSourceAttach
private pri

Handles a source being attached.

onSourceRefresh ( source )
private pri

Handles a source being refreshed.

Parameters

source :  Ext.calendar.store.EventSource

The source.

onSourceRemove ( source, events )
private pri

Handle records being removed from the source.

Parameters

source :  Ext.calendar.store.EventSource

The event source.

events :  Ext.calendar.model.EventBase[]

The events.

onSourceUpdate ( source, event )
private pri

Handles a record being updated in the source.

Parameters

source :  Ext.calendar.store.EventSource

The event source.

event :  Ext.calendar.model.EventBase

The event.

onStoreUpdate ( store, calendar )
private pri

Handles an update on the calendar store.

Parameters

store :  Ext.calendar.store.Calendars

The store.

calendar :  Ext.calendar.model.CalendarBase

The calendar.

processDay ( day, frag )
private pri

Position events for a day.

Parameters

day :  Ext.calendar.view.DaysRenderer

The day.

frag :  DocumentFragment

A fragment to append events to.

processElementConfig Object
private pri

Recursively processes the element templates for this class and its superclasses, ascending the hierarchy until it reaches a superclass whose element template has already been processed. This method is invoked using the prototype as the scope.

Returns

:Object

publishState ( [property], [value] )
protected pro

Publish this components state to the ViewModel. If no arguments are given (or if this is the first call), the entire state is published. This state is determined by the publishes property.

This method is called only by component authors.

Available since: 5.0.0

Parameters

property :  String (optional)

The name of the property to update.

value :  Object (optional)

The value of `property`. Only needed if `property` is given.

recalculate
private pri

Recalculate the view bounds and communicate them to the event source.

refresh
private pri

Do a full refresh of the view if not in the middle of configuration.

refreshEvents
private pri

Do a full event refresh if not configuring and event refresh is not suspended.

refreshHeaders
private pri

Refresh the header if it is attached to the view.

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

removeDelegatedListener ( eventName, fn, scope )
private pri

Removes delegated listeners for a given eventName, function, and scope. Users should not invoke this method directly. It is called automatically by the framework as part of removeListener processing.

Parameters

eventName :  Object

fn :  Object

scope :  Object

removeListener ( eventName, fn, [scope] ) :
chainable ch

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

Returns

:

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.

removeManagedListenerItem ( isClear, managedListener )
private pri

Remove a single managed listener item

Parameters

isClear :  Boolean

True if this is being called during a clear

managedListener :  Object

The managed listener item See removeManagedListener for other args

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.

resolveListenerScope ( [defaultScope] ) : Object
protected pro

Gets the default scope for firing late bound events (string names with no scope attached) at runtime.

Parameters

defaultScope :  Object (optional)

The default scope to return if none is found.

Defaults to: this

Returns

:Object
The default event scope

resolveSatelliteListenerScope ( satellite, [defaultScope] ) : Object
protected pro

Returns the default listener scope for a "satellite" of this component. Used for resolving scope for observable objects that are not part of the normal Container/Component hierarchy (for example, plugins)

Available since: 5.1.1

Parameters

satellite :  Ext.mixin.Observable

defaultScope :  Object (optional)

Returns

:Object
The listener scope

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.

resumeEventRefresh
private pri

Resume the ability to refresh events on the view. The number of calls to resume must match suspendEventRefresh.

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.

roundDate ( d ) : Date
private pri

Round a date to the nearest minimum slot.

Parameters

d :  Date

The date.

Returns

:Date
The rounded date.

selectRange ( start, end )
private pri

Select a range in the all day view.

Parameters

start :  Number

The start index.

end :  Number

The end index.

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

name :  String/Object

The name of the property to set, or a set of key value pairs to set.

value :  Object (optional)

The value to set for the name parameter.

Returns

:Ext.Base
this

setSize ( width, height )

Sets the size of the Component.

Parameters

width :  Number

The new width for the Component.

height :  Number

The new height for the Component.

setSourceRange ( range )
private pri

Set the range on the event source if it exists.

Parameters

range :  Ext.calendar.date.Range

The range.

setTimeRange ( start, end )

Sets the startTime and endTime simultaneously.

Parameters

start :  Number

The start hour between 0 and 23.

end :  Number

The end hour between 1 and 24.

showAddForm ( [event], [options] )

Show the cfg-addForm for this calendar. Has no behavior if cfg-addForm is null.

Parameters

event :  Ext.calendar.model.EventBase (optional)

A new event record containing any data to be passed to the form. If not specified, default dates from this view will be chosen.

options :  Object (optional)

Callback options for form creation.

onSave :  Function (optional)

A save callback function.

onCancel :  Function (optional)

A cancel callback function.

scope :  Object (optional)

A scope for the callback functions.

showEditForm ( event, [options] )

Show the cfg-editForm for this calendar. Has no behavior if cfg-editForm is null.

Parameters

event :  Ext.calendar.model.EventBase

The event to be passed to the form.

options :  Object (optional)

Callback options for form creation.

onSave :  Function (optional)

A save callback function.

onCancel :  Function (optional)

A cancel callback function.

scope :  Object (optional)

A scope for the callback functions.

slotFromPosition ( pageY, [local] ) : Number
private pri

Get the nearest slot based on the page position.

Parameters

pageY :  Number

The y position on the page.

local :  Boolean (optional)

`true` to calculate as a local y instead of page y.

Defaults to: false

Returns

:Number
The slot.

slotToPosition ( slot ) : Number
private pri

Gets the local y position given a slot.

Parameters

slot :  Number

The slot.

Returns

:Number
The local y position.

statics Ext.Class
protected pro

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

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

    constructor: function() {
        var statics = this.statics();

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self();   // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

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

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

alert(My.Cat.totalCreated);             // alerts 3

Returns

:Ext.Class

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.

suspendEventRefresh
private pri

Suspend the ability to refresh events on the view. The number of calls to suspend must match resumeEventRefresh.

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.

syncHeaderScroll
private pri

Ensure headers take into account a scrollbar on the view if necessary.

toUtcOffset ( date ) : Date
private pri

Creates a UTC date at the specified time, taking into account the timezone offset. For example if the timezone offset is +01:00GMT and the values are 2010-01-05:00:00, then the resulting value would be 2010-01-04:23:00.

Parameters

date :  Date

The date

Returns

:Date
The offset date

toggleCls ( className, [state] )

Toggles the specified CSS class on this element (removes it if it already exists, otherwise adds it).

Parameters

className :  String

The CSS class to toggle.

state :  Boolean (optional)

If specified as `true`, causes the class to be added. If specified as `false`, causes the class to be removed.

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

Returns

:

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.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.Container
The matching ancestor Container (or `undefined` if no match was found).

updateCls ( newCls, oldCls )
private pri

All cls methods directly report to the cls configuration, so anytime it changes, updateCls will be called

Parameters

newCls :  Object

oldCls :  Object

updateHeight ( height )
protected pro

Parameters

height :  Object

updateSession ( session )
private pri

Updates the session config.

Parameters

session :  Ext.data.Session

updateStyle ( style )
protected pro

Parameters

style :  Object

updateViewModel ( viewModel, oldViewModel )
private pri

Updates the viewModel config.

Parameters

viewModel :  Ext.app.ViewModel

oldViewModel :  Ext.app.ViewModel

updateWidth ( width )
protected pro

Parameters

width :  Object

utcToLocal ( d ) : Date
private pri

Get a UTC date as a local date, taking into account the timezoneOffset. For example, if the current date is: Thu May 05 2016 10:00:00 GMT+1000 and the timezoneOffset is -60, then the value will be Thu May 05 2016 01:00:00 GMT+1000.

Parameters

d :  Date

The date

Returns

:Date
The offset
Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

Parameters

config :  Object

mixinClass :  Ext.Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

addMember ( name, member ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

Returns

:

addMembers ( members, [isStatic], [privacy] ) :
chainable ch static sta

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat();
 kitty.meow();

Parameters

members :  Object

The members to add to this class.

isStatic :  Boolean (optional)

Pass `true` if the members are static.

Defaults to: false

privacy :  Boolean (optional)

Pass `true` if the members are private. This only has meaning in debug mode and only for methods.

Defaults to: false

Returns

:

addStatics ( members ) : Ext.Base
chainable ch static sta

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base
this

borrow ( fromClass, members ) : Ext.Base
static sta private pri

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base
this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Returns

:Object
the created instance.

createAlias ( alias, origin )
static sta

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Returns

:String
className

mixin ( name, mixinClass ) :
chainable ch static sta private pri

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

override ( members ) : Ext.Base
chainable ch 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

triggerExtended
static sta private pri

events

beforeeventadd ( this, context, eOpts )

Fired before an event addForm is shown.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The new event to be added.

Return false to cancel the form being shown.

eOpts : Object

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

beforeeventdragstart ( this, context, eOpts )

Fired before an event drag begins. Depends on the cfg-draggable config.

Parameters

this :  Ext.calendar.view.Days

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

Return false to cancel the drag.

eOpts : Object

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

beforeeventedit ( this, context, eOpts )

Fired before an event editForm is shown.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event to be edited.

Return false to cancel the form being shown.

eOpts : Object

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

beforeeventresizestart ( this, context, eOpts )

Fired before an event resize begins. Depends on the cfg-resizeEvents config.

Parameters

this :  Ext.calendar.view.Days

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

Return false to cancel the resize.

eOpts : Object

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

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.

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.

eventadd ( this, context, eOpts )

Fired when an event has been added via the addForm.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The newly added event with data.

data :  Object

The data provided by the form.

eOpts : Object

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

eventdrop ( this, context, eOpts )

Fired when an event drop is complete. Depends on the cfg-droppable config.

Parameters

this :  Ext.calendar.view.Days

The view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

newRange :  Ext.calendar.date.Range

The new date range.

eOpts : Object

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

eventedit ( this, context, eOpts )

Fired when an event has been edited via the editForm.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The edited event with data.

data :  Object

The data provided by the form.

eOpts : Object

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

eventresize ( this, context, eOpts )

Fired when an event resize is complete. Depends on the cfg-resizeEvents config.

Parameters

this :  Ext.calendar.view.Days

The view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

newRange :  Ext.calendar.date.Range

The new date range.

eOpts : Object

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

eventtap ( this, context, eOpts )

Fired when an event is tapped.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

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.

validateeventadd ( this, context, eOpts )

Fired after the addForm has been completed, but before the event is added. Allows the add to be validated.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The new event to be added, the data is not yet set on the event.

data :  Object

The data provided by the form. This will be used to set the event data using Ext.calendar.model.EventBase#setData.

validate :  Ext.Promise

A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:

{
                            listeners: {
                                validateeventadd: function(view, context) {
                                    context.validate = context.then(function() {
                                        return Ext.Ajax.request({
                                            url: '/checkAdd'
                                        }).then(function(response) {
                                            return Promise.resolve(response.responseText === 'ok');
                                        });
                                    });
                                }
                            }
                        }
                        

eOpts : Object

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

validateeventdrop ( this, context, eOpts )

Fired when an event is dropped on this view, allows the drop to be validated. Depends on the cfg-droppable config.

Parameters

this :  Ext.calendar.view.Days

The view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

newRange :  Ext.calendar.date.Range

The new date range.

validate :  Ext.Promise

A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:

{
                            listeners: {
                                validateeventdrop: function(view, context) {
                                    context.validate = context.then(function() {
                                        return Ext.Ajax.request({
                                            url: '/checkDrop'
                                        }).then(function(response) {
                                            return Promise.resolve(response.responseText === 'ok');
                                        });
                                    });
                                }
                            }
                        }
                        

eOpts : Object

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

validateeventedit ( this, context, eOpts )

Fired after the editForm has been completed, but before the event is saved. Allows the edit to be validated.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event to be edited, the data is not yet set on the event.

data :  Object

The data provided by the form. This will be used to set the event data using Ext.calendar.model.EventBase#setData.

validate :  Ext.Promise

A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:

{
                            listeners: {
                                validateeventedit: function(view, context) {
                                    context.validate = context.then(function() {
                                        return Ext.Ajax.request({
                                            url: '/checkEdit'
                                        }).then(function(response) {
                                            return Promise.resolve(response.responseText === 'ok');
                                        });
                                    });
                                }
                            }
                        }
                        

eOpts : Object

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

validateeventresize ( this, context, eOpts )

Fired when an event is resized on this view, allows the resize to be validated. Depends on the cfg-resizeEvents config.

Parameters

this :  Ext.calendar.view.Days

The view.

context :  Object

The context.

event :  Ext.calendar.model.EventBase

The event model.

newRange :  Ext.calendar.date.Range

The new date range.

validate :  Ext.Promise

A promise that allows validation to occur. The default behavior is for no validation to take place. To achieve asynchronous validation, the promise on the context object must be replaced:

{
                            listeners: {
                                validateeventresize: function(view, context) {
                                    context.validate = context.then(function() {
                                        return Ext.Ajax.request({
                                            url: '/checkResize'
                                        }).then(function(response) {
                                            return Promise.resolve(response.responseText === 'ok');
                                        });
                                    });
                                }
                            }
                        }
                        

eOpts : Object

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

valuechange ( this, context, eOpts )

Fired when the cfg-value changes.

Parameters

this :  Ext.calendar.view.Base

This view.

context :  Object

The context.

value :  Date

The new value.

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

$calendar-days-allday-empty-height : Number

The height for the empty all day row to allow creation.

Defaults to:

10px

$calendar-days-background-color : color

The background color.

Defaults to:

$calendar-background-color

$calendar-days-compact-day-gutter-width : Number

The width for the day gutter when in compact mode.

Defaults to:

0

$calendar-days-compact-day-start-margin : Number

The start margin for the day container when in compact mode.

Defaults to:

0

$calendar-days-compact-time-font-size : Number

The font size for the time display when in compact mode.

Defaults to:

$calendar-small-font-size

$calendar-days-compact-time-padding : Number / list

The padding for the time display when in compact mode.

Defaults to:

2px 2px 0 0

$calendar-days-compact-time-width : Number

The width for the time display when in compact mode.

Defaults to:

2em

$calendar-days-day-border-color : color

The border color for days.

Defaults to:

$calendar-days-marker-border-color

$calendar-days-day-border-style : String

The border style for days.

Defaults to:

$calendar-days-marker-border-style

$calendar-days-day-border-width : Number

The border width for days.

Defaults to:

$calendar-days-marker-border-width

$calendar-days-day-gutter-width : Number

The width for the day gutter.

Defaults to:

15px

$calendar-days-day-start-margin : Number

The start margin for the day container.

Defaults to:

5px

$calendar-days-hour-height : Number

The height for a single hour in the view.

Defaults to:

42px

$calendar-days-marker-alt-border-color : color

The border color for half hour markers.

Defaults to:

$calendar-border-color

$calendar-days-marker-alt-border-style : String

The border style for half hour markers.

Defaults to:

dotted

$calendar-days-marker-alt-border-width : Number

The border width for half hour markers.

Defaults to:

1px

$calendar-days-marker-border-color : color

The border color for hour markers.

Defaults to:

$calendar-border-color

$calendar-days-marker-border-style : String

The border style for hour markers.

Defaults to:

solid

$calendar-days-marker-border-width : Number

The border width for hour markers.

Defaults to:

1px

$calendar-days-now-marker-border-color : color

The color for the current time marker.

Defaults to:

#a94442

$calendar-days-now-marker-border-style : String

The style for the current time marker.

Defaults to:

solid

$calendar-days-now-marker-border-width : Number

The height for the current time marker.

Defaults to:

2px 0 0 0

$calendar-days-now-marker-margin : Number / list

The margin for the current time marker.

Defaults to:

0 5px

$calendar-days-now-marker-opacity : Number

The opacity for the current time marker.

Defaults to:

0.7

$calendar-days-selection-background-color : color

The background color for a selection.

Defaults to:

$calendar-selection-color

$calendar-days-selection-opacity : Number

The opacity for a selection.

Defaults to:

0.3

$calendar-days-time-ampm-line-height : Number

The line height for the am/pm text when used in the time gutter.

Defaults to:

1em

$calendar-days-time-background-color : String

The background color for the time display.

Defaults to:

#F7F9FD

$calendar-days-time-color : String

The color for the time display.

Defaults to:

#666

$calendar-days-time-font-family : String

The font family for the time display.

Defaults to:

$calendar-font-family

$calendar-days-time-font-size : Number

The font size for the time display.

Defaults to:

$calendar-font-size

$calendar-days-time-padding : Number / list

The padding for the time display.

Defaults to:

2px 2px 0 0

$calendar-days-time-text-align : String

The text align for the time display.

Defaults to:

right

$calendar-days-time-width : Number

The width for the time display.

Defaults to:

4em

theme mixins

calendar-days-ui ( ...list... )

Creates a visual theme for the calendar days view.

Parameters

$ui :  String

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

$background-color :  color (optional)

The background color.

$hour-height :  Number (optional)

The height for a single hour in the view.

$day-gutter-width :  Number (optional)

The width for the day gutter.

$day-start-margin :  Number (optional)

The start margin for the day container.

$marker-border-width :  Number (optional)

The border width for hour markers.

$marker-border-style :  String (optional)

The border style for hour markers.

$marker-border-color :  color (optional)

The border color for hour markers.

$marker-alt-border-width :  Number (optional)

The border width for half hour markers.

$marker-alt-border-style :  String (optional)

The border style for half hour markers.

$marker-alt-border-color :  color (optional)

The border color for half hour markers.

$day-border-width :  Number (optional)

The border width for days.

$day-border-style :  String (optional)

The border style for days.

$day-border-color :  color (optional)

The border color for days.

$now-marker-opacity :  Number (optional)

The opacity for the current time marker.

$now-marker-margin :  Number/list (optional)

The margin for the current time marker.

$now-marker-border-width :  Number/list (optional)

The border width for the current time marker.

$now-marker-border-style :  String (optional)

The border style for the current time marker.

$now-marker-border-color :  color (optional)

The border color for the current time marker.

$time-width :  Number (optional)

The width of the current time

$time-background-color :  color (optional)

The background color for the current time

$time-color :  color (optional)

The color for the current time

$time-font-family :  String (optional)

The font family for the current time

$time-font-size :  Number (optional)

The font size for the current time

$time-text-align :  String (optional)

The font alignment for the current time

$time-padding :  Number (optional)

The padding for the current time

$time-ampm-line-height :  String (optional)

The line height for the current time

$allday-empty-height :  Number (optional)

The height for the empty all day row to allow creation.

$selection-background-color :  color (optional)

The background color for a selection.

$selection-opacity :  Number (optional)

The background color for a selection.

Ext JS 6.2.1 - Classic Toolkit