ExtReact Docs Help

Introduction

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

Terms, Icons, and Labels

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

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

Access Levels

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

Member Types

Member Syntax

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

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

Member Flags

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

Class Icons

- Indicates a framework class

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

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

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

Member Icons

- Indicates a class member of type config

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

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

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

Class Member Quick-Nav Menu

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

Getter and Setter Methods

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

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

History Bar

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

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

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

Search and Filters

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

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

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

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

API Doc Class Metadata

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

Expanding and Collapsing Examples and Class Members

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

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

Desktop -vs- Mobile View

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

Viewing the Class Source

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

ExtAngular 7.3.0


top

Ext.event.Event

NPM Package

@sencha/ext-core

Hierarchy

Ext.Base
Ext.event.Event

Requires

Ext.util.Point

Summary

Just as Ext.dom.Element wraps around a native DOM node, Ext.event.Event wraps the browser's native event-object normalizing cross-browser differences such as mechanisms to stop event-propagation along with a method to prevent default actions from taking place.

Here is a simple example of how you use it:

Recognizers

Ext JS includes many default event recognizers to know when a user interacts with the application.

For a full list of default recognizers, and more information, please view the Ext.event.gesture.Recognizer documentation.

This class also provides a set of constants for use with key events. These are useful for determining if a specific key was pressed, and are available both on instances, and as static properties of the class. The following two statements are equivalent:

if (e.getKey() === Ext.event.Event.TAB) {
    // tab key was pressed
}

if (e.getKey() === e.TAB) {
    // tab key was pressed
}
No members found using the current filters

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

$configTransforms : Object / Array
private pri

A prototype-chained object storing transform method names and priorities stored on the class prototype. On first instantiation, this object is converted into an array that is sorted by priority and stored on the constructor.

Defaults to:

{}

A

Key constant @type Number

Defaults to:

65

ALT

Key constant @type Number

Defaults to:

18

altKey : Boolean

True if the alt key was down during the event.

angle : Number

The angle of the rotation.

This is only available when the event type is rotate

B

Key constant @type Number

Defaults to:

66

BACKSPACE

Key constant @type Number

Defaults to:

8

browserEvent : Event

The raw browser event which this object wraps.

button : Number

Indicates which mouse button caused the event for mouse events, for example mousedown, click, mouseup:

  • 0 for left button.
  • 1 for middle button.
  • 2 for right button.

Note: In IE8 & IE9, the click event does not provide the button.

C

Key constant @type Number

Defaults to:

67

CAPS_LOCK

Key constant @type Number

Defaults to:

20

claimed : Boolean
private pri

true if claimGesture has been called on this instance

Defaults to:

false

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

CONTEXT_MENU

Key constant @type Number

Defaults to:

93

CTRL

Key constant @type Number

Defaults to:

17

ctrlKey : Boolean

True if the control key was down during the event. In Mac this will also be true when meta key was down.

currentTarget : HTMLElement

Refers to the element the event handler was attached to, vs the target, which is the actual element that fired the event. For example, if the event bubbles, the target element may be a descendant of the currentTarget, as the event may have been triggered on the target and then bubbled up to the currentTarget where it was handled.

D

Key constant @type Number

Defaults to:

68

defaultPrevented : Boolean

Indicates whether or not preventDefault() was called on the event.

Defaults to:

false

delegatedTarget : HTMLElement
deprecated dep

Same as currentTarget

Deprecated since version 5.0.0
use currentTarget instead.

DELETE

Key constant @type Number

Defaults to:

46

deltaX : Number

Defaults to:

deltaX

deltaY : Number

Defaults to:

deltaY

destroyed : Boolean

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

Defaults to:

false

direction : Number

The direction of the swipe. Available options are:

  • up
  • down
  • left
  • right

This is only available when the event type is swipe

distance : Number

The distance of the event.

This is only available when the event type is swipe and pinch.

DOWN

Key constant @type Number

Defaults to:

40

duration : Number

The duration of the swipe.

This is only available when the event type is swipe

E

Key constant @type Number

Defaults to:

69

EIGHT

Key constant @type Number

Defaults to:

56

END

Key constant @type Number

Defaults to:

35

ENTER

Key constant @type Number

Defaults to:

13

ESC

Key constant @type Number

Defaults to:

27

F

Key constant @type Number

Defaults to:

70

F1

Key constant @type Number

Defaults to:

112

F10

Key constant @type Number

Defaults to:

121

F11

Key constant @type Number

Defaults to:

122

F12

Key constant @type Number

Defaults to:

123

F2

Key constant @type Number

Defaults to:

113

F3

Key constant @type Number

Defaults to:

114

F4

Key constant @type Number

Defaults to:

115

F5

Key constant @type Number

Defaults to:

116

F6

Key constant @type Number

Defaults to:

117

F7

Key constant @type Number

Defaults to:

118

F8

Key constant @type Number

Defaults to:

119

F9

Key constant @type Number

Defaults to:

120

FIVE

Key constant @type Number

Defaults to:

53

FOUR

Key constant @type Number

Defaults to:

52

G

Key constant @type Number

Defaults to:

71

getTrueXY
private pri

Returns the X and Y coordinates of this event without regard to any RTL direction settings.

Defaults to:

prototype.getXY

H

Key constant @type Number

Defaults to:

72

HOME

Key constant @type Number

Defaults to:

36

I

Key constant @type Number

Defaults to:

73

INSERT

Key constant @type Number

Defaults to:

45

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

J

Key constant @type Number

Defaults to:

74

K

Key constant @type Number

Defaults to:

75

L

Key constant @type Number

Defaults to:

76

LEFT

Key constant @type Number

Defaults to:

37

M

Key constant @type Number

Defaults to:

77

META

Key constant @type Number

Defaults to:

91

N

Key constant @type Number

Defaults to:

78

NINE

Key constant @type Number

Defaults to:

57

NUM_CENTER

Key constant @type Number

Defaults to:

12

NUM_DIVISION

Key constant @type Number

Defaults to:

111

NUM_EIGHT

Key constant @type Number

Defaults to:

104

NUM_FIVE

Key constant @type Number

Defaults to:

101

NUM_FOUR

Key constant @type Number

Defaults to:

100

NUM_MINUS

Key constant @type Number

Defaults to:

109

NUM_MULTIPLY

Key constant @type Number

Defaults to:

106

NUM_NINE

Key constant @type Number

Defaults to:

105

NUM_ONE

Key constant @type Number

Defaults to:

97

NUM_PERIOD

Key constant @type Number

Defaults to:

110

NUM_PLUS

Key constant @type Number

Defaults to:

107

NUM_SEVEN

Key constant @type Number

Defaults to:

103

NUM_SIX

Key constant @type Number

Defaults to:

102

NUM_THREE

Key constant @type Number

Defaults to:

99

NUM_TWO

Key constant @type Number

Defaults to:

98

NUM_ZERO

Key constant @type Number

Defaults to:

96

O

Key constant @type Number

Defaults to:

79

ONE

Key constant @type Number

Defaults to:

49

P

Key constant @type Number

Defaults to:

80

PAGE_DOWN

Key constant @type Number

Defaults to:

34

PAGE_UP

Key constant @type Number

Defaults to:

33

pageX : Number

The browsers x coordinate of the event. Note: this only works in browsers that support pageX on the native browser event object (pageX is not natively supported in IE9 and earlier). In Ext JS, for a cross browser normalized x-coordinate use getX

pageY : Number

The browsers y coordinate of the event. Note: this only works in browsers that support pageY on the native browser event object (pageY is not natively supported in IE9 and earlier). In Ext JS, for a cross browser normalized y-coordinate use getY

PAUSE

Key constant @type Number

Defaults to:

19

pointerType : String

The pointer type for this event. May be empty if the event was not triggered by a pointer. Current available types are:

  • mouse
  • touch
  • pen

PRINT_SCREEN

Key constant @type Number

Defaults to:

44

Q

Key constant @type Number

Defaults to:

81

R

Key constant @type Number

Defaults to:

82

RETURN

Key constant @type Number

Defaults to:

13

RIGHT

Key constant @type Number

Defaults to:

39

rotation : Number

A amount of rotation, since the start of the event.

This is only available when the event type is rotate

S

Key constant @type Number

Defaults to:

83

scale : Number

The scape of a pinch event.

This is only available when the event type is pinch

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

SEVEN

Key constant @type Number

Defaults to:

55

SHIFT

Key constant @type Number

Defaults to:

16

shiftKey : Boolean

True if the shift key was down during the event.

SIX

Key constant @type Number

Defaults to:

54

SPACE

Key constant @type Number

Defaults to:

32

stopped : Boolean
private pri

true if stopPropagation has been called on this instance

Defaults to:

false

T

Key constant @type Number

Defaults to:

84

TAB

Key constant @type Number

Defaults to:

9

target : HTMLElement

The element that fired this event. For the element whose handlers are currently being processed, i.e. the element that the event handler was attached to, use currentTarget

THREE

Key constant @type Number

Defaults to:

51

TWO

Key constant @type Number

Defaults to:

50

U

Key constant @type Number

Defaults to:

85

UP

Key constant @type Number

Defaults to:

38

V

Key constant @type Number

Defaults to:

86

W

Key constant @type Number

Defaults to:

87

WHEEL_LINE_SIZE : Number

The mouse wheel delta scaling factor when the deltaMode is DOM_DELTA_LINE

To change this value:

 Ext.event.Event.prototype.WHEEL_LINE_SIZE = 16;

Defaults to:

20

WHEEL_PAGE_SIZE : Number

The mouse wheel delta scaling factor when the deltaMode is DOM_DELTA_PAGE

To change this value:

 Ext.event.Event.prototype.WHEEL_PAGE_SIZE = 400;

Defaults to:

600

WHEEL_PIXEL_SIZE : Number

The mouse wheel delta scaling factor when the deltaMode is DOM_DELTA_PIXEL

To change this value:

 Ext.event.Event.prototype.WHEEL_PIXEL_SIZE = 3;

Defaults to:

1

X

Key constant @type Number

Defaults to:

88

Y

Key constant @type Number

Defaults to:

89

Z

Key constant @type Number

Defaults to:

90

ZERO

Key constant @type Number

Defaults to:

48

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

blurEvents
static sta private pri

Defaults to:

{
    blur: 1,
    focusout: 1,
    focusleave: 1
}

clickEvents
static sta private pri

These are tracked separately from mouseEvents because the mouseEvents map is used by Dom publisher to eliminate duplicate events on devices that fire multiple kinds of events (mouse, touch, pointer). Adding click events to the mouse events map can cause click events to be blocked from firing in some cases.

Defaults to:

{
    click: 1,
    dblclick: 1
}

focusEvents
static sta private pri

Defaults to:

{
    focus: 1,
    focusin: 1,
    focusenter: 1
}

gestureEvents
static sta private pri

An amalgamation of pointerEvents/mouseEvents/touchEvents. Will be populated in class callback.

Defaults to:

{}

mouseEvents
static sta private pri

Defaults to:

{
    mousedown: 1,
    mousemove: 1,
    mouseup: 1,
    mouseover: 1,
    mouseout: 1,
    mouseenter: 1,
    mouseleave: 1
}

pointerEvents
static sta private pri

Defaults to:

{
    pointerdown: 1,
    pointermove: 1,
    pointerup: 1,
    pointercancel: 1,
    pointerover: 1,
    pointerout: 1,
    pointerenter: 1,
    pointerleave: 1,
    MSPointerDown: 1,
    MSPointerMove: 1,
    MSPointerUp: 1,
    MSPointerOver: 1,
    MSPointerOut: 1,
    MSPointerCancel: 1,
    MSPointerEnter: 1,
    MSPointerLeave: 1
}

touchEvents
static sta private pri

Defaults to:

{
    touchstart: 1,
    touchmove: 1,
    touchend: 1,
    touchcancel: 1
}

wheelEvents
static sta private pri

Defaults to:

{
    wheel: 1
}

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

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

chain ( props )
private pri

Creates a new Event object that is prototype-chained to this event. Useful for creating identical events so that certain properties can be changed without affecting the original event. For example, translated events have their "type" corrected in this manner.

Parameters

props :  Object

properties to set on the chained event

claimGesture Ext.event.Event
chainable ch

Claims this event as the currently active gesture. Once a gesture is claimed no other gestures will fire events until after the current gesture has completed. For example, if claimGesture() is invoked on a dragstart or drag event, no swipestart or swipe events will be fired until the drag gesture completes, even if the gesture also meets the required duration and distance requirements to be recognized as a swipe.

If claimGesture() is invoked on a mouse, touch, or pointer event, it will disable all gesture events until termination of the current gesture is indicated by a mouseup, touchend, or pointerup event.

Returns

:Ext.event.Event

correctWheelDelta ( delta )
private pri

Correctly scales a given wheel delta.

Parameters

delta :  Number

The delta value.

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.

destroyMembers ( args )

Destroys member properties by name.

If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.

The property will be destroyed, and the corrected name (if the property is a config and config names are prefixed) will set to null in this object's dictionary.

Parameters

args :  String...

One or more names of the properties to destroy and remove from the object.

getCharCode Number

Gets the character code for the event.

Returns

:Number

getClipboardData ( [type] ) : Mixed

If this is an event of type paste, this returns the clipboard data of the pasesd mime type.

Available since: 6.5.1

Parameters

type :  String (optional)

The mime type of the data to extract from the clipabord.

Note that this uses non-standard browaer APIs and may not work reliably on all platforms.

Defaults to: 'text/plain'

Returns

:Mixed

The clipboard data.

getConfig ( [name], [peek], [ifInitialized] ) : 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

ifInitialized :  Boolean (optional)

true to only return the initialized property value, not the raw config value, and not to trigger initialization. Returns undefined if the property has not yet been initialized.

Defaults to: false

Returns

:Object

The config property value.

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.

getKey Number

Returns a normalized keyCode for the event.

Returns

:Number

The key code

getKeyName String

Returns the name of the keyCode for the event.

Returns

:String

The key name

getLocalXY ( clip ) : Number[]
private pri

Gets the event coordinates relative to the currentTargets position.

Parameters

clip :  Boolean

The returned coordinates are guaranteed to be within [0, width] and [0, height] of the target, if clip is set to true.

Returns

:Number[]

The xy values like [x, y]

getPageX Number
deprecated dep

Gets the x coordinate of the event.

Returns

:Number

Deprecated since version 4.0
use getX instead

getPageY Number
deprecated dep

Gets the y coordinate of the event.

Returns

:Number

Deprecated since version 4.0
use getY instead

getPoint Ext.util.Point

Returns a point object that consists of the object coordinates.

Returns

:Ext.util.Point

point

getRelatedTarget ( [selector], [maxDepth], [returnEl] ) : HTMLElement

Gets the related target.

Parameters

selector :  String (optional)

A simple selector to filter the target or look for an ancestor of the target. See Ext.dom.Query for information about simple selectors.

maxDepth :  Number/HTMLElement (optional)

The max depth to search as a number or element (defaults to 10 || document.body).

returnEl :  Boolean (optional)

true to return a Ext.Element object instead of DOM node.

Returns

:HTMLElement

getTarget ( [selector], [maxDepth], [returnEl] ) : HTMLElement

Gets the target for the event.

Parameters

selector :  String (optional)

A simple selector to filter the target or look for an ancestor of the target

maxDepth :  Number/Mixed (optional)

The max depth to search as a number or element (defaults to 10 || document.body)

Defaults to: 10||document.body

returnEl :  Boolean (optional)

true to return a Ext.Element object instead of DOM node.

Returns

:HTMLElement

getTime Date

Returns the time of the event.

Returns

:Date

getWheelDelta Number
deprecated dep

Normalizes mouse wheel y-delta across browsers. To get x-delta information, use getWheelDeltas instead.

Returns

:Number

The mouse wheel y-delta

Deprecated since version 6.6.0
Use deltaY instead

getWheelDeltas Object
deprecated dep

Returns the mouse wheel deltas for this event.

Returns

:Object

An object with "x" and "y" properties holding the mouse wheel deltas.

Deprecated since version 6.7.0
Use deltaX and deltaY instead

getX Number

Gets the x coordinate of the event.

Returns

:Number

getXY Number[]

Gets the X and Y coordinates of the event.

Returns

:Number[]

The xy values like [x, y]

getY Number

Gets the y coordinate of the event.

Returns

:Number

hasConfig ( name )
private pri

Parameters

name :  String

hasModifier Boolean

Returns true if the control, meta, shift or alt key was pressed during this event.

Returns

:Boolean

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

isNavKeyPress ( [scrollableOnly] ) : Boolean

Checks if the key pressed was a "navigation" key. A navigation key is defined by these keys:

  • Page Up
  • Page Down
  • End
  • Home
  • Left
  • Up
  • Right
  • Down
  • Return
  • Tab
  • Esc

Parameters

scrollableOnly :  Boolean (optional)

Only check navigation keys that can cause element scrolling by their default action.

Returns

:Boolean

true if the press is a navigation keypress

isSpecialKey Boolean

Checks if the key pressed was a "special" key. A special key is defined as one of these keys:

  • Page Up
  • Page Down
  • End
  • Home
  • Left arrow
  • Up arrow
  • Right arrow
  • Down arrow
  • Return
  • Tab
  • Esc
  • Backspace
  • Delete
  • Shift
  • Ctrl
  • Alt
  • Pause
  • Caps Lock
  • Print Screen
  • Insert

Returns

:Boolean

true if the key for this event is special

key String

Returns the key property of a keyboard event.

Returns

:String

preventDefault
chainable ch

Prevents the browsers default handling of the event.

Returns

:

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

startDrag

Initiates a drag gesture in response to this event

Only available when type is 'longpress'. When invoked a dragstart event will be immediately fired at the coordinates of the longpress event. Thereafter drag events will fire in response to movement on the screen without regard to the distance moved.

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

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


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

        statics.totalCreated++;
    },

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

        // equivalent to: My.Cat.speciesName
        cloned.groupName = this.statics().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

stopPropagation
chainable ch

Cancels bubbling of the event.

Returns

:

watchConfig ( name, fn, scope )
private pri

Watches config properties.

 instance.watchConfig({
     title: 'onTitleChange',
     scope: me
 });

Available since: 6.7.0

Parameters

name :  Object

fn :  Object

scope :  Object

within ( el, [related], [allowEl] ) : Boolean

Returns true if the target of this event is a child of el. If the allowEl parameter is set to false, it will return false if the target is el. Example usage:

// Handle click on any child of an element
Ext.getBody().on('click', function(e){
    if(e.within('some-el')){
        alert('Clicked on a child of some-el!');
    }
});

// Handle click directly on an element, ignoring clicks on child nodes
Ext.getBody().on('click', function(e,t){
    if((t.id == 'some-el') && !e.within(t, true)){
        alert('Clicked directly on some-el!');
    }
});

Parameters

el :  String/HTMLElement/Ext.dom.Element

The id, DOM element or Ext.Element to check

related :  Boolean (optional)

true to test if the related target is within el instead of the target

allowEl :  Boolean (optional)

true to allow the target to be considered "within" itself. false to only allow child elements.

Defaults to: true

Returns

:Boolean
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, privacy ) :
chainable ch static sta private pri

Parameters

name :  Object

member :  Object

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

getKeyId ( keyName )
static sta private pri

Convert a key specification in the form eg: "CTRL+ALT+DELETE" to the glyph sequence for use in menu items, eg "⌃⌥⌦".

Parameters

keyName :  Object

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

globalTabKeyDown ( e )
static sta private pri

Parameters

e :  Object

globalTabKeyUp ( e )
static sta private pri

Parameters

e :  Object

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

ExtAngular 7.3.0