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.0 - Classic Toolkit


top

Ext.calendar.view.Week xtype: calendar-weekview premium

Hierarchy

Ext.calendar.view.Days
Ext.calendar.view.Week

Summary

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

The Week view displays the week containing the current date (or the date set on the cfg-value config). The number of days configured on the cfg-visibleDays config (defaults to 7) are displayed starting with the value set on the cfg-firstDayOfWeek.

By default the first day is Sunday. If you want to create a "work week" type view where the weekend days are omitted you can modify the visibleDays and firstDayOfWeek to show only Monday - Friday.

Ext.create({
    xtype: 'calendar-weekview',
    renderTo: Ext.getBody(),
    height: 400,
    width: 400,
    firstDayOfWeek: 1,  // starts the view on Monday
    visibleDays: 5,     // and displays it and the 4 days after
    store: {
        autoLoad: true,
        proxy: {
            type: 'ajax',
            url: 'calendars.php'
        },
        eventStoreDefaults: {
            proxy: {
                type: 'ajax',
                url: 'events.php'
            }
        }
    }
});

Date Range Navigation

The movePrevious and moveNext methods modify the displayed date range by moving the range forward or backward one week.

i.e. view.moveNext(); called on a 7-day view 1 week. Note that a view configured with 5 visibleDays would not advance 5 days, but rather will show the next full week with only 5 visible days.

Alternative Classes

If your view requires a header showing the dates displayed consider using Ext.calendar.panel.Week instead. To display fewer days consider using the Ext.calendar.view.Day or Ext.calendar.view.Days view.

No members found using the current filters

configs

Optional Configs

addForm : Object

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

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

compact : Boolean

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

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

controlStoreRange : Boolean
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

displayOverlap : Boolean

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

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

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

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

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

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

firstDayOfWeek : Number

The day on which the calendar week begins. 0 (Sunday) through 6 (Saturday). Defaults to Ext.Date#firstDayOfWeek

Defaults to:

undefined

getFirstDayOfWeek : Number

Returns the value of firstDayOfWeek

Returns

Number

setFirstDayOfWeek (firstDayOfWeek)

Sets the value of firstDayOfWeek

Parameters

firstDayOfWeek :  Number

gestureNavigation : Boolean

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

resizeEvents : Boolean

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

showNowMarker : Boolean

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

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

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

timeFormat : String

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

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

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

value : Date

The start of the date range to show. The visible range of the view will begin at the firstDayOfWeek immediately preceding this value, or the value if it is the firstDayOfWeek. For example, using the following configuration:

 {
     firstDayOfWeek: 0, // Sunday
     value: new Date(2010, 2, 3) // Wed, 3 March 2010
 }

The visible range would begin on Sun 28th Feb.

Defaults to:

new Date()

getValue : Date

Returns the value of value

Returns

Date

setValue (value)

Sets the value of value

Parameters

value :  Date

visibleDays : Number

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

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

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

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

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

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

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

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

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

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
Use method-callParent instead.

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

clearEvents
private pri

Clear events from the view.

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.

createScroller Ext.scroll.Scroller
private pri

Create the scroller.

Returns

:Ext.scroll.Scroller

The scroller.

destroy

This method is called to cleanup an object and its resources. After calling this method, the object should not be used any further in any way, including access to its methods and properties.

To prevent potential memory leaks, all object references will be nulled at the end of destruction sequence, unless clearPropertiesOnDestroy is set to false.

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.

doRecalculate ( start ) : Object
private pri

Do range recalculation.

Parameters

start :  Date

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.

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.

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.

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.

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.

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.

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.

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.

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

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.

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.

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

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.

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 ( e )
private pri

Handle taps on event widgets in the view.

Parameters

e :  Ext.event.Event

The event.

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.

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.

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.

resumeEventRefresh
private pri

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

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

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

suspendEventRefresh
private pri

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

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

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.

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.

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.

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.0 - Classic Toolkit