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.
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.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.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).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)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.
classInstance.method1().method2().etc();false is returned from
an event handler- 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
- 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
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.
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.
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.
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.
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:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.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.
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:
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.
For an overview of calendar views see Ext.calendar.view.Base
The Month view shows events over an entire month. The view shows a summary of the events that occur on each day. The month view uses the current date (or the date set on the cfg-value config) to determine the month to show.
The Month view displays (as needed) days from trailing/leading months as required to fill the space in the view based on the cfg-value and the cfg-firstDayOfWeek. In the following example, the view will start on Sun Dec 27 and conclude on Sat Feb 6 because we require 6 rows to display the month of January.
{
value: new Date(2010, 0, 1) // Fri
firstDayOfWeek: 0 // Sunday
}
The cfg-visibleWeeks can be specified as null to allow the view to
calculate the appropriate number of rows to show in the view, as this varies
from month to month. This defaults to the largest possible value (6 weeks) so that
the view size is consistent across months.
In addition to navigate, movePrevious, and moveNext the Month view let you quickly navigate between months and years. The previousMonth and nextMonth methods allow for programmatic month-to-month navigation while previousYear and nextYear navigate the view across years.
If your view requires a header showing the days of the week consider using Ext.calendar.panel.Weeks instead. For a multi-week view refer to Ext.calendar.view.Weeks.
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'
}
true to show the cfg-addForm when a selection is made on the body.
Use cfg-addOnSelect to control view selection itself.
Defaults to:
true
true to allow days to be selected via the UI.
Defaults to:
true
Sets the value of allowSelection
allowSelection : 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
A series of config options for this class to set when this class is in cfg-compact mode.
Defaults to:
null
Sets the value of compactOptions
compactOptions : Object
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
Sets the value of controlStoreRange
controlStoreRange : Boolean
The format for displaying the day in the cell. See Ext.Date for options.
Defaults to:
'j'
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'
}
The default configuration for Ext.calendar.Event widgets
Defaults to:
{
xtype: 'calendar-event'
}
The day on which the calendar week begins. 0 (Sunday) through 6 (Saturday).
Defaults to Ext.Date#firstDayOfWeek
Defaults to:
undefined
Sets the value of firstDayOfWeek
firstDayOfWeek : Number
A Ext.calendar.header.Base object to link to this view
Defaults to:
null
Text to show when events overflow on a particular day to allow the user to view the rest. This string is evaluated as a formatted string where the argument is the number of overflowing events. Depends on cfg-showOverflow.
Defaults to:
'+{0} more'
Show an overflow label that will display an overlay when there are too many events to render in the view. Valid configurations are:
topbottomPass null or '' to not show overflow.
The overflow text may be formatted using cfg-overflowText.
Defaults to:
'bottom'
A Ext.calendar.store.Calendars instance or configuration
Defaults to:
null
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
Sets the value of timezoneOffset
timezoneOffset : Number
The current month to show. The value will default to the first date of the configured month. For example:
calendar.setValue(new Date(2010, 0, 13));
console.log(calendar.getValue()); // -> 2010-01-01
Defaults to:
new Date()
The number of days to show in a week, starting from the firstDayOfWeek.
For example, to show the view with days Mon - Fri, use:
{
visibleDays: 5,
firstDayOfWeek: 1 // Monday
}
Defaults to:
7
The number of weeks to show in this view. If specified as null, the view will generate the appropriate
number of rows to display a full month based on the passed cfg-value. In a majority of cases,
this will be 5, however some months will only require 4, while others will need 6. Defaults to the
largest value to keep the view size consistent.
Defaults to:
6
The days of the week that are the weekend. 0 (Sunday) through 6 (Saturday).
Defaults to Ext.Date#weekendDays.
Defaults to:
undefined
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
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
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
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
This property is set to true after the destroy method is called.
Defaults to:
false
Get the period to move when using moveNext and movePrevious.
Defaults to:
Ext.privateFn
The period to move
This property is set to true during the call to initConfig.
Defaults to:
false
Available since: 5.0.0
This property is set to true if this instance is the first of its class.
Defaults to:
false
Available since: 5.0.0
This value is true and is used to identify plain objects from instances of
a defined class.
Defaults to:
true
The row classes for the view when they are to be displayed as
Defaults to:
[
Ext.baseCSSPrefix + 'calendar-month-4weeks',
Ext.baseCSSPrefix + 'calendar-month-5weeks',
Ext.baseCSSPrefix + 'calendar-month-6weeks'
]
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
A date where the month starts on a Sunday. Used to generate day names.
Defaults to:
new Date(2000, 9, 1)
true to track the date ranges in the view to add past/future date classes.
Defaults to:
false
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
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"
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callOverridden(arguments)
Returns the result of calling the overridden method
Deprecated since version 4.1.0
Use method-callParent instead.
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.
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callParent(arguments)
Returns the result of calling the parent method
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".
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)
Returns the result of calling the superclass method
Create the add form configuration. Can be hooked to provide any runtime customization.
A configuration for the form instance.
Create the edit form configuration. Can be hooked to provide any runtime customization.
event : Object
A configuration for the form instance.
Create an event widget.
event : Ext.calendar.model.EventBase
The event record.
cfg : Object
dummy : Object
The event widget.
Create a number of event widgets.
events : Ext.calendar.model.EventBase[]
The events.
cfg : Object (optional)
A config for each event.
The event widgets.
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.
Calculate the relevant date ranges given the current value.
start : Date (optional)
The start to recalculate from. Defaults to the current value.
The active values.
visible : Ext.calendar.date.Range
The visible date range.
active : Ext.calendar.date.Range
The active range for the view.
month : Ext.calendar.date.Range
The month range for the view.
requireWeeks : Number
The number of weeks in the current view.
Show a form for this calendar.
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.
Find the index of a cell via position.
sizes : Number[]
The sizes of each cell in the row/column.
offset : Number
The offset from the start edge.
The index.
Generate the cells for the view.
numRows : Number
The number of rows.
setHeights : Boolean (optional)
true to set the percentage heights on the rows.
Defaults to: false
An array of row DOM configs.
Get the body element of this view.
The body.
Get a calendar by id.
id : Object
The id of the calendar.
The calendar
Get a cell by date.
date : Date
The date.
The cell, null if not found.
Get a cell by page position.
pageX : Number
The page x position.
pageY : Number
The page y position.
The cell.
Get a cell from a DOM event.
e : Ext.event.Event
The event.
inferFromWidget : Boolean (optional)
true to find the cell if the event
occurred on an event widget,
Defaults to: false
The cell.
Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.
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
The config property value.
Get the date from a cell.
cell : HTMLElement
The cell.
The date.
Calculate the width/height of each day cell. This is cached and should be invalidated on resize. The reason we need to do this is that the table layout algorithm may assign some rows/cells to be 1px larger than others to achieve full width, so dividing can give slightly inaccurate results.
Day size info.
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.
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.
The number of days spanned.
The the default range when creating a event.
The range.
Get the default color palette for this view. Defaults to the color of the first calendar, otherwise the first color in the palette.
The color palette.
Get the display range for this view.
The display range.
Get all calendars that are editable.
The editable calendars.
Get an event record via element/DOM event.
el : Ext.dom.Element/HTMLElement/Ext.event.Event
The element target,
The event record.
See getDaysSpanned.
event : Ext.calendar.model.EventBase
The event.
The number of days spanned.
Get the palette for an event record.
event : Ext.calendar.model.EventBase
The event record.
The palette.
Get the Ext.calendar.store.EventSource for this view.
The event source.
Get styles regarding events. Creates a fake event and measures pieces of the componentry.
Size info.
Gets an event widget via an element/DOM event.
el : HTMLElement/Ext.event.Event
The element/event.
The widget.
Get the active cfg-editForm or cfg-addForm if it exists.
The active form. null if not active.
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'.
name : String (optional)
Name of the config option to return.
The full config object or a single config value
when name parameter specified.
Get the value to use as the base for moving when using moveNext and movePrevious.
The value.
Get listeners to add to the event source.
A listeners config.
Get listeners to add to the calendar store..
A listeners config.
Get the visible range for this view.
The visible range.
Handle drop on the view.
type : Object
event : Ext.calendar.model.EventBase
The event.
newRange : Ext.calendar.date.Range
The new range.
callback : Function (optional)
A callback to execute.
Handle drag/resize start for an event.
type : String
The event type.
event : Ext.calendar.model.EventBase
The event.
false to veto the event.
Handle taps on event widgets in the view.
e : Ext.event.Event
The event.
Checks if the store has editable calendars.
true if any calendars are editable.
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'
instanceConfig : Object
this
Checks if an event is hidden, by virtue of the calendar being hidden.
event : Ext.calendar.model.EventBase
The event.
true if the event should be hidden.
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy).
name : String
value : Object
The value passed.
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.
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.
Move forward by a number of months.
months : Number (optional)
The number of months to move.
Defaults to: 1
Move forward by a number of years.
years : Number (optional)
The number of years to move.
Defaults to: 1
Handle a tap on an event model.
event : Ext.calendar.model.EventBase
The event model.
Handle the form being cancelled.
form : Ext.calendar.form.Base
The form.
Handle create form being saved.
form : Ext.calendar.form.Base
The form.
data : Object
The data from the form.
Handle edit form being saved.
form : Ext.calendar.form.Base
The form.
event : Ext.calendar.model.EventBase
The event being edited.
data : Object
The data from the form.
Handle click on the "show more" overflow element.
e : Ext.event.Event
The DOM event.
Handle records being added to the source.
source : Ext.calendar.store.EventSource
The event source.
events : Ext.calendar.model.EventBase[]
The events.
Handles a source being refreshed.
source : Ext.calendar.store.EventSource
The source.
Handle records being removed from the source.
source : Ext.calendar.store.EventSource
The event source.
events : Ext.calendar.model.EventBase[]
The events.
Handles a record being updated in the source.
source : Ext.calendar.store.EventSource
The event source.
event : Ext.calendar.model.EventBase
The event.
Handles an update on the calendar store.
store : Ext.calendar.store.Calendars
The store.
calendar : Ext.calendar.model.CalendarBase
The calendar.
Handle touchstart on the view.
event : Ext.event.Event
The event.
t : Object
Sets the position in the DOM for an event widget.
el : Ext.dom.Element
The element.
item : Object
The event meta object with position info.
Calculates the position based on a set of sizes. See getDaySizes on why we can't just use multiplication.
start : Number
The start index.
len : Number
The number of cells to span.
sizes : Number[]
The cell sizes.
The sum for the specified range.
Move backward by a number of months.
months : Number (optional)
The number of months to move.
Defaults to: 1
Move backward by a number of years.
years : Number (optional)
The number of years to move.
Defaults to: 1
Position events for a week.
week : Ext.calendar.view.WeekRenderer
The week.
frag : DocumentFragment
A fragment to append events to.
Resume the ability to refresh events on the view. The number of calls to resume must match suspendEventRefresh.
Select a date range of cells.
from : Date
The start date.
to : Date
The end date.
Sets a single/multiple configuration options.
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.
this
Set the range on the event source if it exists.
range : Ext.calendar.date.Range
The range.
Show the cfg-addForm for this calendar. Has no behavior if
cfg-addForm is null.
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.
Show the cfg-editForm for this calendar. Has no behavior if
cfg-editForm is null.
event : Ext.calendar.model.EventBase
The event to be passed to the form.
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
Suspend the ability to refresh events on the view. The number of calls to suspend must match resumeEventRefresh.
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.
date : Date
The date
The offset date
Destroys a given set of linked objects. This is only needed if
the linked object is being destroyed before this instance.
names : String[]
The names of the linked objects to destroy.
this
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.
d : Date
The date
The offset
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.
config : Object
mixinClass : Ext.Class (optional)
The mixin class if the configs are from a mixin.
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();
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
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() { ... };
});
members : Object
this
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 '$$$$$$$'
fromClass : Ext.Base
The class to borrow members from
members : Array/String
The names of the members to borrow
this
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.
the created instance.
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()
alias : String/Object
The new method name, or an object to set multiple aliases. See flexSetter
origin : String/Object
The original method name
Returns the Ext.Configurator for this class.
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'
className
Used internally by the mixins pre-processor
name : Object
mixinClass : Object
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).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
Fired before an event addForm is shown.
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.
Fired before an event drag begins. Depends on the cfg-draggable config.
this : Ext.calendar.view.Weeks
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.
Fired before an event editForm is shown.
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.
Fired when an event has been added via the addForm.
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.
Fired when an event drop is complete. Depends on the droppable config.
this : Ext.calendar.view.Weeks
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.
Fired when an event has been edited via the editForm.
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.
Fired when an event is tapped.
this : Ext.calendar.view.Base
This view.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when a single date is selected.
this : Ext.calendar.view.Weeks
The view.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired when a date range is selected.
this : Ext.calendar.view.Weeks
The view.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Fired after the addForm has been completed, but before the event is added. Allows the add to be validated.
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.
Fired when an event is dropped on this view, allows the drop to be validated. Depends on the droppable config.
this : Ext.calendar.view.Weeks
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.
Fired after the editForm has been completed, but before the event is saved. Allows the edit to be validated.
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.
Fired when the cfg-value changes.
this : Ext.calendar.view.Base
This view.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
The background color.
Defaults to:
$calendar-background-color
The font size for the day number when in compact mode.
Defaults to:
$calendar-weeks-day-number-font-size
The font size for the "show more" text when in compact mode.
Defaults to:
$calendar-weeks-overflow-font-size
The border color for the day cells.
Defaults to:
$calendar-border-color
The font family for the day number.
Defaults to:
$calendar-font-family
The font size for the day number.
Defaults to:
$calendar-font-size
The color for the day number when the day is outside the current month. This style is only applied when using the month view.
Defaults to:
#aaa
The padding for the day number.
Defaults to:
2px 0 4px 4px
The horizontal alignment for the day number.
Defaults to:
left
The color for the day number when the day is a weekend.
Defaults to:
null
The background color for day cells when the day is outside the current month. This style is only applied when using the month view.
Defaults to:
null
The background color for day cells when the day is a weekend.
Defaults to:
null
The font family for the "show more" text.
Defaults to:
$calendar-font-family
The font size for the "show more" text.
Defaults to:
$calendar-small-font-size
The background color for a selection.
Defaults to:
$calendar-selection-color
Creates a visual theme for the calendar weeks view.
$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.
$selection-background-color : color (optional)
The background color for a selection.
$selection-opacity : Number (optional)
The opacity for a selection.
$day-border-width : Number (optional)
The border width for the day cells.
$day-border-color : Number (optional)
The border color for the day cells.
$day-border-style : Number (optional)
The border style for the day cells.
$day-number-padding : Number/list (optional)
The padding for the day number.
$day-number-text-align : String (optional)
The horizontal alignment for the day number.
$day-number-font-size : Number (optional)
The font size for the day number.
$day-number-font-family : String (optional)
The font family for the day number.
$day-number-color : color (optional)
The color for the day number.
$day-background-color : color (optional)
The background color for day cells.
$day-number-outside-color : color (optional)
The color for the day number when the day is outside the current month range. This style is only applied when using the month view.
$day-outside-background-color : color (optional)
The background color for day cells when the day is outside the current month range. This style is only applied when using the month view.
$day-number-weekend-color : color (optional)
The color for the day number when the day is a weekend.
$day-weekend-background-color : color (optional)
The background color for day cells when the day is a weekend.
$day-vertical-align : color (optional)
The vertical alignment for the day number.
$overflow-color : color (optional)
The color for the "show more" text when a cell overflows.
$overflow-font-size : Number (optional)
The font size for the "show more" text when a cell overflows.
$overflow-font-family : Number (optional)
The font family for the "show more" text when a cell overflows.
Ext JS | Terms of Use