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.

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

### Member Types

- Config - The configuration options for a class.
- Property - Set once a class is instantiated. *See Read Only below.
- Method - Actions that can be performed by a class. Methods should be read as instance methods and can only be called from a instance of a given class. Static methods that can be called directly from the class itself will have a `static` label next to the method name. *See Static below.
- Event - Events are specific to the framework event system allowing for classes to programmatically raise an event to be handled by one or more event handler methods. DOM events, while handled by the framework event system, are not specifically described within the API documentation. *For DOM events refer to the event reference page from MDN.
- Theme Variable - Variables used by the visual theme engine employed by the framework.
- Theme Mixin - Functions used by the visual theme engine employed by the framework and may use values set in various Theme Variables.

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

Ext.container.Container
view source
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:

- Expand/Collapse - On the left-hand size of the member row is a control used to expand and collapse each member row to show / hide member details.
- Member Name - The name of the class member (`lookupComponent` in this example)
- Method Param - Any required or optional params used by a method (or passed to an event handler method) will be listed next to the method name within parenthesis (`( item )` in this example)
- Return type - The class instance or javascript object returned by the method or property (`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`).
- Flags - Any flags applicable to the member will be displayed next (`PROTECTED` in this example - see the Flags section below)
- Member Origin - On the right-hand side of the member row is the class where the member was initially described (`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.
- Member Source - On the right-hand side below the member origin class is a link to view the member's source (`view source` in the example)
- Params List - Each param for a class method will be listed using the same name found above in parenthesis, the type of class or object expected, and a description of the param (`item : Object` in the example).
- Returns - If a class returns a value other than `undefined` a "Returns" section will note the type of class or object returned and a description (`Ext.Component` in the example)
- Since (not shown in the example) - Some members will show which version of the product the member was first introduced (i.e. `Available since 3.4.0` - not pictured in the example) just after the member description
- Default (not shown in the example) - Configs often show the default config value to be applied to a class instance if not overridden (i.e. `Defaults to: false`)

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

- Required - Required config when instantiating a class
- Bindable - The config has a setter which allows this config to be set via ViewModel binding
- Read Only - The property may be read, but cannot be used to configure / re-configure a class instance at runtime
- Singleton - Singleton classes are instantiated immediately once defined and may not be instantiated manually
- Static - A static method or property is a method or property belonging to the class itself, not an instance of the class
- Chainable - Refers to methods that return the class instance back when called.
  This enables chained method calls like: `classInstance.method1().method2().etc();`
- Deprecated - A class or member that is scheduled for removal in a future framework version and is provided in the current version for backwards compatibility.
  Deprecated classes and members will have a message directing you to the preferred class / method going forward.
- Removed - A removed class or member that exists in documentation only as a reference for users upgrading between framework versions
- Template - A method defined within a base class designed to be overridden by subclasses
- Abstract - A class or member may be be defined as abstract. Abstract classes and members establish a class structure and provide limited, if any, code. Class-specific code will be furnished via overrides in subclasses.
- Preventable - Events marked preventable will not fire if `false` is returned from an event handler

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

## Navigation and Features

### 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 and inheritance. This is done using the checkboxes at the top of the page. Note that filtering out `private` members also filters the API class navigation tree.

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:

- Alternate Name - One or more additional class name synonymns (in Ext JS 6.0.0 the `Ext.button.Button` class has an alternate class name of `Ext.Button`). Alternate class names are commonly maintained for backward compatibility.
- Hierarchy - The hierararchy view lists the inheritance chain of the current class up through its ancestor classes up to the root base class.
- Mixins - A list of classes that are mixed into the current class
- Inherited Mixins - A list of classes that are mixed into an ancestor of the current class
- Requires - All classes required to be defined for the class to be instantiated
- Uses - A list of classes potentially used by the class at some point in its lifecycle, but not necessarily requried for the class to initially be instantiated
- Subclasses - Classes that extend the current class

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

- Global navigation will be located in a menu on the left-hand side accessible via the hamburger menu icon. The menu houses the following (on most pages):
  - The name of the current product (as a link to the product landing page)
  - The Sencha icon used to navigate back to the documentation home page
  - The product menu drop-down button
  - Tabs of navigation trees for the API docs and guides
- Current context navigation and tools is located on the right-hand side accessible via the gear icon. The context menu houses teh following:
  - The global search input field
  - (API doc) A "Filters" tab with the member filter, expand / collapse all examples button, expand / collapse all member rows button, the access level filter checkboxes, and the counts of each member
  - (API doc) A "Related Classes" tab containing the menu of metadata related to the current class
  - (Guides) The table of contents for the guide

### 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.event.Event Classic Toolkit

##
Ext JS 6.2.0 - Modern Toolkit

Guides
API
▸ Ext
▸ app
▸ bind
▸ AbstractStub
▸ BaseBinding
▸ Binding
▸ Formula
▸ LinkStub
▸ Multi
▸ Parser
▸ RootStub
▸ Stub
▸ Template
▸ TemplateBinding
▸ domain
▸ Component
▸ Controller
▸ Direct
▸ Global
▸ Store
▸ View
▸ route
▸ Queue
▸ Route
▸ Router
▸ Application
▸ BaseController
▸ Controller
▸ EventBus
▸ EventDomain
▸ Profile
▸ Util
▸ ViewController
▸ ViewModel
▸ behavior
▸ Behavior
▸ Draggable
▸ Translatable
▸ calendar
▸ date
▸ Range
▸ Util
▸ dd
▸ DaysAllDaySource
▸ DaysAllDayTarget
▸ DaysBodySource
▸ DaysBodyTarget
▸ DaysProxy
▸ WeeksProxy
▸ WeeksSource
▸ WeeksTarget
▸ form
▸ AbstractForm
▸ Add
▸ Base
▸ CalendarPicker
▸ Edit
▸ Form
▸ header
▸ Base
▸ Days
▸ Weeks
▸ model
▸ Calendar
▸ CalendarBase
▸ Event
▸ EventBase
▸ panel
▸ AbstractBase
▸ AbstractPanel
▸ Base
▸ Day
▸ Days
▸ Month
▸ Panel
▸ Week
▸ Weeks
▸ store
▸ Calendars
▸ Events
▸ EventSource
▸ theme
▸ Palette
▸ Theme
▸ util
▸ Dom
▸ view
▸ Base
▸ Day
▸ Days
▸ DaysRenderer
▸ Month
▸ Multi
▸ Week
▸ Weeks
▸ WeeksRenderer
▸ AbstractList
▸ Event
▸ EventBase
▸ List
▸ carousel
▸ Carousel
▸ Indicator
▸ Infinite
▸ Item
▸ chart
▸ axis
▸ layout
▸ CombineDuplicate
▸ Continuous
▸ Discrete
▸ Layout
▸ segmenter
▸ Names
▸ Numeric
▸ Segmenter
▸ Time
▸ sprite
▸ Axis
▸ Axis3D
▸ Axis
▸ Axis3D
▸ Category
▸ Category3D
▸ Numeric
▸ Numeric3D
▸ Time
▸ Time3D
▸ grid
▸ CircularGrid
▸ HorizontalGrid
▸ HorizontalGrid3D
▸ RadialGrid
▸ VerticalGrid
▸ VerticalGrid3D
▸ interactions
▸ Abstract
▸ Crosshair
▸ CrossZoom
▸ ItemEdit
▸ ItemHighlight
▸ ItemInfo
▸ PanZoom
▸ Rotate
▸ RotatePie3D
▸ label
▸ Callout
▸ legend
▸ sprite
▸ Border
▸ Item
▸ store
▸ Item
▸ Store
▸ Legend
▸ LegendBase
▸ SpriteLegend
▸ plugin
▸ ItemEvents
▸ series
▸ sprite
▸ Aggregative
▸ Area
▸ Bar
▸ Bar3D
▸ Box
▸ CandleStick
▸ Cartesian
▸ Line
▸ Pie3DPart
▸ PieSlice
▸ Polar
▸ Radar
▸ Scatter
▸ Series
▸ StackedCartesian
▸ Area
▸ Bar
▸ Bar3D
▸ CandleStick
▸ Cartesian
▸ Gauge
▸ Line
▸ Pie
▸ Pie3D
▸ Polar
▸ Radar
▸ Scatter
▸ Series
▸ StackedCartesian
▸ sprite
▸ Label
▸ theme
▸ Base
▸ Default
▸ AbstractChart
▸ CartesianChart
▸ MarkerHolder
▸ Markers
▸ PolarChart
▸ SpaceFillingChart
▸ d3
▸ axis
▸ Axis
▸ Color
▸ Data
▸ canvas
▸ Canvas
▸ HiDPI
▸ hierarchy
▸ partition
▸ Icicle
▸ Partition
▸ Sunburst
▸ tree
▸ HorizontalTree
▸ Tree
▸ Hierarchy
▸ Pack
▸ Partition
▸ Tree
▸ TreeMap
▸ interaction
▸ Abstract
▸ PanZoom
▸ legend
▸ Color
▸ Legend
▸ mixin
▸ Detached
▸ ToolTip
▸ svg
▸ Svg
▸ Component
▸ HeatMap
▸ Helpers
▸ data
▸ amf
▸ Encoder
▸ Packet
▸ Proxy
▸ Reader
▸ RemotingMessage
▸ XmlDecoder
▸ XmlEncoder
▸ field
▸ Boolean
▸ Date
▸ Field
▸ Integer
▸ Number
▸ String
▸ flash
▸ BinaryXhr
▸ identifier
▸ Generator
▸ Negative
▸ Sequential
▸ Uuid
▸ matrix
▸ Matrix
▸ Side
▸ Slice
▸ operation
▸ Create
▸ Destroy
▸ Operation
▸ Read
▸ Update
▸ proxy
▸ Ajax
▸ Client
▸ Direct
▸ JsonP
▸ LocalStorage
▸ Memory
▸ Proxy
▸ Rest
▸ Server
▸ SessionStorage
▸ WebStorage
▸ reader
▸ Array
▸ Json
▸ Reader
▸ Xml
▸ request
▸ Ajax
▸ Base
▸ Form
▸ schema
▸ Association
▸ HasMany
▸ HasOne
▸ ManyToMany
▸ ManyToOne
▸ Namer
▸ OneToOne
▸ Reference
▸ Role
▸ Schema
▸ session
▸ BatchVisitor
▸ ChangesVisitor
▸ ChildChangesVisitor
▸ soap
▸ Proxy
▸ Reader
▸ validator
▸ Bound
▸ Email
▸ Exclusion
▸ Format
▸ Inclusion
▸ Length
▸ List
▸ Presence
▸ Range
▸ Validator
▸ writer
▸ Json
▸ Writer
▸ Xml
▸ AbstractStore
▸ ArrayStore
▸ Batch
▸ BufferedStore
▸ ChainedStore
▸ Connection
▸ DirectStore
▸ Error
▸ ErrorCollection
▸ JsonP
▸ JsonPStore
▸ JsonStore
▸ LocalStore
▸ Model
▸ ModelManager
▸ NodeInterface
▸ NodeStore
▸ PageMap
▸ ProxyStore
▸ Request
▸ ResultSet
▸ Session
▸ SortTypes
▸ Store
▸ StoreManager
▸ TreeModel
▸ TreeStore
▸ Types
▸ Validation
▸ XmlStore
▸ dataview
▸ component
▸ Container
▸ DataItem
▸ element
▸ Container
▸ List
▸ plugin
▸ ItemTip
▸ DataView
▸ IndexBar
▸ ItemHeader
▸ List
▸ ListItem
▸ ListItemBody
▸ ListItemDisclosure
▸ NestedList
▸ SimpleListItem
▸ direct
▸ AmfRemotingProvider
▸ Event
▸ ExceptionEvent
▸ JsonProvider
▸ Manager
▸ PollingProvider
▸ Provider
▸ RemotingEvent
▸ RemotingMethod
▸ RemotingProvider
▸ Transaction
▸ dom
▸ CompositeElement
▸ CompositeElementLite
▸ Element
▸ ElementEvent
▸ Fly
▸ GarbageCollector
▸ Helper
▸ Query
▸ Shadow
▸ Shim
▸ TouchAction
▸ Underlay
▸ UnderlayPool
▸ drag
▸ proxy
▸ None
▸ Original
▸ Placeholder
▸ Constraint
▸ Info
▸ Item
▸ Manager
▸ Source
▸ Target
▸ draw
▸ engine
▸ SvgContext
▸ Gradient
▸ Canvas
▸ excanvas
▸ Svg
▸ gradient
▸ Gradient
▸ GradientDefinition
▸ Linear
▸ Radial
▸ modifier
▸ Animation
▸ Highlight
▸ Modifier
▸ Target
▸ overrides
▸ hittest
▸ sprite
▸ Instancing
▸ Path
▸ Path
▸ Surface
▸ plugin
▸ SpriteEvents
▸ sprite
▸ AnimationParser
▸ Arc
▸ Arrow
▸ AttributeDefinition
▸ AttributeParser
▸ Circle
▸ Composite
▸ Cross
▸ Diamond
▸ Ellipse
▸ EllipticalArc
▸ Image
▸ Instancing
▸ Line
▸ Path
▸ Plus
▸ Rect
▸ Sector
▸ Sprite
▸ Square
▸ Text
▸ Tick
▸ Triangle
▸ Animator
▸ Container
▸ Draw
▸ LimitedCache
▸ Matrix
▸ Path
▸ PathUtil
▸ Point
▸ SegmentTree
▸ Surface
▸ SurfaceBase
▸ TextMeasurer
▸ TimingFunctions
▸ env
▸ Browser
▸ OS
▸ Ready
▸ event
▸ gesture
▸ DoubleTap
▸ Drag
▸ EdgeSwipe
▸ LongPress
▸ MultiTouch
▸ Pinch
▸ Recognizer
▸ Rotate
▸ SingleTouch
▸ Swipe
▸ Tap
▸ publisher
▸ Dom
▸ ElementPaint
▸ ElementSize
▸ Focus
▸ Gesture
▸ Publisher
▸ Event
▸ exporter
▸ data
▸ Base
▸ Cell
▸ Column
▸ Group
▸ Row
▸ Table
▸ excel
▸ Xlsx
▸ Xml
▸ file
▸ excel
▸ Cell
▸ Column
▸ Row
▸ Style
▸ Table
▸ Workbook
▸ Worksheet
▸ html
▸ Doc
▸ Style
▸ ooxml
▸ excel
▸ Border
▸ BorderPr
▸ Cell
▸ CellAlignment
▸ CellStyleXf
▸ CellXf
▸ Column
▸ Fill
▸ Font
▸ NumberFormat
▸ Row
▸ SharedStrings
▸ Sheet
▸ Stylesheet
▸ Workbook
▸ Worksheet
▸ Base
▸ ContentType
▸ ContentTypes
▸ CoreProperties
▸ Excel
▸ Relationship
▸ Relationships
▸ zip
▸ Archive
▸ File
▸ Folder
▸ Base
▸ Style
▸ text
▸ CSV
▸ Html
▸ TSV
▸ Base
▸ File
▸ Plugin
▸ field
▸ trigger
▸ Clear
▸ Date
▸ Expand
▸ Reveal
▸ Search
▸ SpinDown
▸ SpinUp
▸ Trigger
▸ Checkbox
▸ DatePicker
▸ DatePickerNative
▸ Email
▸ Field
▸ File
▸ FileInput
▸ Hidden
▸ Input
▸ Number
▸ Password
▸ Picker
▸ Radio
▸ Search
▸ Select
▸ SingleSlider
▸ Slider
▸ Spinner
▸ Text
▸ TextArea
▸ TextAreaInput
▸ TextInput
▸ Toggle
▸ Url
▸ form
▸ FieldContainer
▸ FieldSet
▸ Panel
▸ fx
▸ animation
▸ Abstract
▸ Cube
▸ Fade
▸ FadeOut
▸ Flip
▸ Pop
▸ PopOut
▸ Slide
▸ SlideOut
▸ Wipe
▸ WipeOut
▸ easing
▸ Abstract
▸ Bounce
▸ BoundMomentum
▸ EaseIn
▸ EaseOut
▸ Easing
▸ Linear
▸ Momentum
▸ layout
▸ card
▸ Abstract
▸ Cover
▸ Cube
▸ Fade
▸ Flip
▸ Pop
▸ Reveal
▸ Scroll
▸ ScrollCover
▸ ScrollReveal
▸ Slide
▸ Style
▸ Card
▸ runner
▸ Css
▸ CssAnimation
▸ CssTransition
▸ Animation
▸ Runner
▸ State
▸ google
▸ data
▸ AbstractProxy
▸ CalendarsProxy
▸ EventsProxy
▸ ux
▸ Client
▸ grid
▸ cell
▸ Base
▸ Boolean
▸ Cell
▸ Check
▸ Date
▸ Expander
▸ Number
▸ RowNumberer
▸ Summary
▸ Text
▸ Tree
▸ Widget
▸ column
▸ Boolean
▸ Check
▸ Column
▸ Date
▸ Number
▸ RowNumberer
▸ Selection
▸ Tree
▸ plugin
▸ ColumnResizing
▸ Editable
▸ Exporter
▸ MultiSelection
▸ PagingToolbar
▸ RowExpander
▸ SummaryRow
▸ ViewOptions
▸ Grid
▸ HeaderContainer
▸ HeaderGroup
▸ PagingToolbar
▸ Row
▸ RowBody
▸ RowHeader
▸ Tree
▸ layout
▸ wrapper
▸ BoxDock
▸ Dock
▸ Inner
▸ Abstract
▸ Box
▸ Card
▸ Default
▸ Fit
▸ FlexBox
▸ Float
▸ HBox
▸ VBox
▸ list
▸ AbstractTreeItem
▸ RootTreeItem
▸ Tree
▸ TreeItem
▸ mixin
▸ Accessible
▸ Bindable
▸ ComponentDelegation
▸ ConfigState
▸ Container
▸ Dirty
▸ Factoryable
▸ Hookable
▸ Identifiable
▸ Inheritable
▸ Keyboard
▸ Mashup
▸ Observable
▸ Pluggable
▸ Progressable
▸ Queryable
▸ Responsive
▸ Selectable
▸ StyleCacher
▸ Templatable
▸ Traversable
▸ panel
▸ Header
▸ Title
▸ Tool
▸ parse
▸ symbol
▸ Constant
▸ Infix
▸ InfixRight
▸ Paren
▸ Prefix
▸ Parser
▸ Symbol
▸ Tokenizer
▸ perf
▸ Accumulator
▸ Monitor
▸ picker
▸ Date
▸ Picker
▸ Slot
▸ pivot
▸ axis
▸ Base
▸ Item
▸ Local
▸ cell
▸ Cell
▸ Group
▸ dimension
▸ Item
▸ feature
▸ PivotStore
▸ filter
▸ Base
▸ Label
▸ Value
▸ matrix
▸ Base
▸ Local
▸ Remote
▸ plugin
▸ configurator
▸ model
▸ Select
▸ store
▸ Select
▸ Column
▸ Container
▸ DragZone
▸ DropZone
▸ Field
▸ FieldSettings
▸ Form
▸ FormController
▸ Panel
▸ PanelController
▸ rangeeditor
▸ Panel
▸ PanelController
▸ Configurator
▸ DrillDown
▸ Exporter
▸ RangeEditor
▸ result
▸ Base
▸ Collection
▸ Local
▸ update
▸ Base
▸ Increment
▸ Overwrite
▸ Percentage
▸ Uniform
▸ Aggregators
▸ Grid
▸ MixedCollection
▸ Row
▸ plugin
▸ field
▸ PlaceHolderLabel
▸ Abstract
▸ LazyItems
▸ ListPaging
▸ MouseEnter
▸ PullRefresh
▸ Responsive
▸ SortableList
▸ promise
▸ Consequence
▸ Deferred
▸ Promise
▸ scroll
▸ Scroller
▸ slider
▸ Slider
▸ Thumb
▸ Toggle
▸ sparkline
▸ Bar
▸ BarBase
▸ Base
▸ Box
▸ Bullet
▸ CanvasBase
▸ CanvasCanvas
▸ Discrete
▸ Line
▸ Pie
▸ RangeMap
▸ Shape
▸ TriState
▸ VmlCanvas
▸ tab
▸ Bar
▸ Panel
▸ Tab
▸ table
▸ Table
▸ tip
▸ Manager
▸ Tip
▸ ToolTip
▸ util
▸ paintmonitor
▸ Abstract
▸ CssAnimation
▸ OverflowChange
▸ sizemonitor
▸ Abstract
▸ OverflowChange
▸ Scroll
▸ TaskRunner
▸ Task
▸ translatable
▸ Abstract
▸ CssPosition
▸ CssTransform
▸ Dom
▸ ScrollParent
▸ ScrollPosition
▸ AbstractMixedCollection
▸ Audio
▸ Bag
▸ Base64
▸ BufferedCollection
▸ Cache
▸ Collection
▸ CollectionKey
▸ Color
▸ CSS
▸ CSV
▸ DelayedTask
▸ DelimitedValue
▸ Draggable
▸ Droppable
▸ Event
▸ Filter
▸ FilterCollection
▸ Fly
▸ Format
▸ Geolocation
▸ Group
▸ GroupCollection
▸ Grouper
▸ HashMap
▸ History
▸ Inflector
▸ InputBlocker
▸ ItemCollection
▸ LineSegment
▸ LocalStorage
▸ LruCache
▸ MixedCollection
▸ ObjectTemplate
▸ Observable
▸ Offset
▸ Operators
▸ PaintMonitor
▸ Point
▸ Positionable
▸ PositionMap
▸ Region
▸ Schedulable
▸ Scheduler
▸ SizeMonitor
▸ Sortable
▸ Sorter
▸ SorterCollection
▸ TapRepeater
▸ TaskManager
▸ TextMetrics
▸ Translatable
▸ TranslatableGroup
▸ TranslatableList
▸ TSV
▸ Wrapper
▸ XTemplateCompiler
▸ XTemplateParser
▸ ux
▸ ajax
▸ DataSimlet
▸ JsonSimlet
▸ PivotSimlet
▸ Simlet
▸ SimManager
▸ SimXhr
▸ XmlSimlet
▸ event
▸ Driver
▸ Maker
▸ Player
▸ Recorder
▸ google
▸ Api
▸ Feeds
▸ Gauge
▸ viewport
▸ Android
▸ Default
▸ Ios
▸ Viewport
▸ WindowsPhone
▸ AbstractComponent
▸ AbstractManager
▸ ActionSheet
▸ Ajax
▸ Anim
▸ AnimationQueue
▸ anims
▸ Array
▸ Assert
▸ Audio
▸ Base
▸ browser
▸ Button
▸ Class
▸ ClassManager
▸ Component
▸ ComponentManager
▸ ComponentQuery
▸ Config
▸ Configurator
▸ Container
▸ Date
▸ Decorator
▸ Deferred
▸ Error
▸ Evented
▸ Factory
▸ feature
▸ Function
▸ GlobalEvents
▸ Glyph
▸ Img
▸ Inventory
▸ JSON
▸ Label
▸ Loader
▸ LoadMask
▸ Mask
▸ Media
▸ MessageBox
▸ Mixin
▸ Msg
▸ Number
▸ Object
▸ os
▸ Panel
▸ Progress
▸ ProgressBase
▸ Promise
▸ SegmentedButton
▸ Sheet
▸ Sortable
▸ Spacer
▸ String
▸ supports
▸ TaskQueue
▸ Template
▸ Title
▸ Titlebar
▸ TitleBar
▸ Toast
▸ Toolbar
▸ Version
▸ Video
▸ Viewport
▸ Widget
▸ XTemplate
▸ Array
▸ Boolean
▸ CanvasRenderingContext2D
▸ CanvasRenderingContext2D_
▸ Date
▸ Function
▸ Global_CSS
▸ Number
▸ Object
▸ RegExp
▸ String
▸ Getting Started
▸ Setup & Getting Started
▸ Ext JS - FAQ
▸ Sample Login App
▸ API Diffs
▸ Modern - 6.0.2 and 6.2.0
▸ Classic - 6.0.2 and 6.2.0
▸ Examples
▸ 6.2.0 Examples
▸ What's New?
▸ Release Notes
▸ Core Concepts
▸ The Class System
▸ Layouts and Containers
▸ Components
▸ Data Package
▸ Events and Gestures
▸ Drag and Drop
▸ Theming System
▸ Material Theme
▸ Memory Management
▸ Draw Package
▸ Draw Package
▸ Creating Images - Pt 1
▸ Creating Images - Pt 2
▸ Creating Images - Pt 3
▸ Accessibility
▸ Localization
▸ Right to Left in Ext JS
▸ Sencha Font Packages
▸ Tablet Support
▸ Architecture
▸ Intro to App Architecture
▸ Multiple Screens
▸ View Controllers
▸ View Models & Binding
▸ View Model Internals
▸ Using the Router
▸ UI Components
▸ Carousel
▸ Forms
▸ Introduction to Charting
▸ Trees
▸ Grids
▸ Pivot Grid
▸ Widgets and Widget Cols
▸ Backend Connectors
▸ SOAP Services
▸ AMF Data Sources
▸ Ext Direct
▸ Ext Direct Specification
▸ Using MySQL and PHP
▸ Other Resources
▸ Basics of OOP
▸ Ext JS Ecosystem
▸ From the Sencha Blog
▸ Supported Browsers
top

# Ext.event.Event

### Alternate Names

Ext.EventObjectImpl

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

var container = Ext.create('Ext.Container', { layout: 'fit', renderTo: Ext.getBody(), items: [{ id: 'logger', styleHtmlContent: true, html: 'Click somewhere!', padding: 5 }] }); container.getEl().on({ click: function(e, node) { var string = ''; string += 'You clicked at: <strong>{ x: ' + e.pageX + ', y: ' + e.pageY + ' }</strong> <i>(e.pageX & e.pageY)</i>'; string += '<hr />'; string += 'The HTMLElement you clicked has the className of: <strong>' + e.target.className + '</strong> <i>(e.target)</i>'; string += '<hr />'; string += 'The HTMLElement which has the listener has a className of: <strong>' + e.currentTarget.className + '</strong> <i>(e.currentTarget)</i>'; Ext.getCmp('logger').setHtml(string); } });

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

Sample Code

    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

Ext.Base
view source

## $className
private pri

Defaults to: 'Ext.Base'

Ext.Base
view source

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

Ext.Base
view source

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

Ext.event.Event
view source

## A

Key constant @type Number

Defaults to: 65

Ext.event.Event
view source

## ALT

Key constant @type Number

Defaults to: 18

Ext.event.Event
view source

## altKey : Boolean

True if the alt key was down during the event.

Ext.event.Event
view source

## angle : Number

The angle of the rotation.

This is only available when the event type is `rotate`

Ext.event.Event
view source

## B

Key constant @type Number

Defaults to: 66

Ext.event.Event
view source

## BACKSPACE

Key constant @type Number

Defaults to: 8

Ext.event.Event
view source

## browserEvent : Event

The raw browser event which this object wraps.

Ext.event.Event
view source

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

Ext.event.Event
view source

## C

Key constant @type Number

Defaults to: 67

Ext.Base
view source

## callOverridden
deprecated dep protected pro

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

Sample Code

    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"

Defaults to: BasePrototype.callParent

### 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: Use
{@link #callParent} instead.

Ext.event.Event
view source

## CAPS_LOCK

Key constant @type Number

Defaults to: 20

Ext.event.Event
view source

## claimed : Boolean
private pri

`true` if claimGesture has been called on this instance

Defaults to: false

Ext.Base
view source

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

Ext.Base
view source

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

Ext.event.Event
view source

## CTRL

Key constant @type Number

Defaults to: 17

Ext.event.Event
view source

## ctrlKey : Boolean

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

Ext.event.Event
view source

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

Ext.event.Event
view source

## D

Key constant @type Number

Defaults to: 68

Ext.event.Event
view source

## defaultPrevented : Boolean

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

Defaults to: false

Ext.event.Event
view source

## delegatedTarget : HTMLElement
deprecated dep

Same as currentTarget

Deprecated: 5.0.0
use {@link #property!currentTarget #currentTarget} instead.

Ext.event.Event
view source

## DELETE

Key constant @type Number

Defaults to: 46

Ext.Base
view source

## destroyed : Boolean
protected pro

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

Defaults to: false

Ext.event.Event
view source

## direction : Number

The direction of the swipe. Available options are:

- up
- down
- left
- right

This is only available when the event type is `swipe`

Ext.event.Event
view source

## distance : Number

The distance of the event.

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

Ext.event.Event
view source

## DOWN

Key constant @type Number

Defaults to: 40

Ext.event.Event
view source

## duration : Number

The duration of the swipe.

This is only available when the event type is `swipe`

Ext.event.Event
view source

## E

Key constant @type Number

Defaults to: 69

Ext.event.Event
view source

## EIGHT

Key constant @type Number

Defaults to: 56

Ext.event.Event
view source

## END

Key constant @type Number

Defaults to: 35

Ext.event.Event
view source

## ENTER

Key constant @type Number

Defaults to: 13

Ext.event.Event
view source

## ESC

Key constant @type Number

Defaults to: 27

Ext.event.Event
view source

## F

Key constant @type Number

Defaults to: 70

Ext.event.Event
view source

## F1

Key constant @type Number

Defaults to: 112

Ext.event.Event
view source

## F10

Key constant @type Number

Defaults to: 121

Ext.event.Event
view source

## F11

Key constant @type Number

Defaults to: 122

Ext.event.Event
view source

## F12

Key constant @type Number

Defaults to: 123

Ext.event.Event
view source

## F2

Key constant @type Number

Defaults to: 113

Ext.event.Event
view source

## F3

Key constant @type Number

Defaults to: 114

Ext.event.Event
view source

## F4

Key constant @type Number

Defaults to: 115

Ext.event.Event
view source

## F5

Key constant @type Number

Defaults to: 116

Ext.event.Event
view source

## F6

Key constant @type Number

Defaults to: 117

Ext.event.Event
view source

## F7

Key constant @type Number

Defaults to: 118

Ext.event.Event
view source

## F8

Key constant @type Number

Defaults to: 119

Ext.event.Event
view source

## F9

Key constant @type Number

Defaults to: 120

Ext.event.Event
view source

## FIVE

Key constant @type Number

Defaults to: 53

Ext.event.Event
view source

## FOUR

Key constant @type Number

Defaults to: 52

Ext.event.Event
view source

## G

Key constant @type Number

Defaults to: 71

Ext.event.Event
view source

## getTrueXY
private pri

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

Defaults to: prototype.getXY

Ext.event.Event
view source

## H

Key constant @type Number

Defaults to: 72

Ext.event.Event
view source

## HOME

Key constant @type Number

Defaults to: 36

Ext.event.Event
view source

## I

Key constant @type Number

Defaults to: 73

Ext.event.Event
view source

## INSERT

Key constant @type Number

Defaults to: 45

Ext.Base
view source

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

Ext.Base
view source

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

Ext.Base
view source

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

Ext.event.Event
view source

## J

Key constant @type Number

Defaults to: 74

Ext.event.Event
view source

## K

Key constant @type Number

Defaults to: 75

Ext.event.Event
view source

## L

Key constant @type Number

Defaults to: 76

Ext.event.Event
view source

## LEFT

Key constant @type Number

Defaults to: 37

Ext.event.Event
view source

## M

Key constant @type Number

Defaults to: 77

Ext.event.Event
view source

## N

Key constant @type Number

Defaults to: 78

Ext.event.Event
view source

## NINE

Key constant @type Number

Defaults to: 57

Ext.event.Event
view source

## NUM_CENTER

Key constant @type Number

Defaults to: 12

Ext.event.Event
view source

## NUM_DIVISION

Key constant @type Number

Defaults to: 111

Ext.event.Event
view source

## NUM_EIGHT

Key constant @type Number

Defaults to: 104

Ext.event.Event
view source

## NUM_FIVE

Key constant @type Number

Defaults to: 101

Ext.event.Event
view source

## NUM_FOUR

Key constant @type Number

Defaults to: 100

Ext.event.Event
view source

## NUM_MINUS

Key constant @type Number

Defaults to: 109

Ext.event.Event
view source

## NUM_MULTIPLY

Key constant @type Number

Defaults to: 106

Ext.event.Event
view source

## NUM_NINE

Key constant @type Number

Defaults to: 105

Ext.event.Event
view source

## NUM_ONE

Key constant @type Number

Defaults to: 97

Ext.event.Event
view source

## NUM_PERIOD

Key constant @type Number

Defaults to: 110

Ext.event.Event
view source

## NUM_PLUS

Key constant @type Number

Defaults to: 107

Ext.event.Event
view source

## NUM_SEVEN

Key constant @type Number

Defaults to: 103

Ext.event.Event
view source

## NUM_SIX

Key constant @type Number

Defaults to: 102

Ext.event.Event
view source

## NUM_THREE

Key constant @type Number

Defaults to: 99

Ext.event.Event
view source

## NUM_TWO

Key constant @type Number

Defaults to: 98

Ext.event.Event
view source

## NUM_ZERO

Key constant @type Number

Defaults to: 96

Ext.event.Event
view source

## O

Key constant @type Number

Defaults to: 79

Ext.event.Event
view source

## ONE

Key constant @type Number

Defaults to: 49

Ext.event.Event
view source

## P

Key constant @type Number

Defaults to: 80

Ext.event.Event
view source

## PAGE_DOWN

Key constant @type Number

Defaults to: 34

Ext.event.Event
view source

## PAGE_UP

Key constant @type Number

Defaults to: 33

Ext.event.Event
view source

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

Ext.event.Event
view source

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

Ext.event.Event
view source

## PAUSE

Key constant @type Number

Defaults to: 19

Ext.event.Event
view source

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

Ext.event.Event
view source

## PRINT_SCREEN

Key constant @type Number

Defaults to: 44

Ext.event.Event
view source

## Q

Key constant @type Number

Defaults to: 81

Ext.event.Event
view source

## R

Key constant @type Number

Defaults to: 82

Ext.event.Event
view source

## RETURN

Key constant @type Number

Defaults to: 13

Ext.event.Event
view source

## RIGHT

Key constant @type Number

Defaults to: 39

Ext.event.Event
view source

## rotation : Number

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

This is only available when the event type is `rotate`

Ext.event.Event
view source

## S

Key constant @type Number

Defaults to: 83

Ext.event.Event
view source

## scale : Number

The scape of a pinch event.

This is only available when the event type is `pinch`

Ext.Base
view source

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

Sample Code

    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

Ext.event.Event
view source

## SEVEN

Key constant @type Number

Defaults to: 55

Ext.event.Event
view source

## SHIFT

Key constant @type Number

Defaults to: 16

Ext.event.Event
view source

## shiftKey : Boolean

True if the shift key was down during the event.

Ext.event.Event
view source

## SIX

Key constant @type Number

Defaults to: 54

Ext.event.Event
view source

## SPACE

Key constant @type Number

Defaults to: 32

Ext.event.Event
view source

## stopped : Boolean
private pri

`true` if stopPropagation has been called on this instance

Defaults to: false

Ext.event.Event
view source

## T

Key constant @type Number

Defaults to: 84

Ext.event.Event
view source

## TAB

Key constant @type Number

Defaults to: 9

Ext.event.Event
view source

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

Ext.event.Event
view source

## THREE

Key constant @type Number

Defaults to: 51

Ext.event.Event
view source

## TWO

Key constant @type Number

Defaults to: 50

Ext.event.Event
view source

## U

Key constant @type Number

Defaults to: 85

Ext.event.Event
view source

## UP

Key constant @type Number

Defaults to: 38

Ext.event.Event
view source

## V

Key constant @type Number

Defaults to: 86

Ext.event.Event
view source

## W

Key constant @type Number

Defaults to: 87

Ext.event.Event
view source

## WHEEL_SCALE : Number

The mouse wheel delta scaling factor. This value depends on browser version and OS and attempts to produce a similar scrolling experience across all platforms and browsers.

To change this value:

Sample Code

     Ext.event.Event.prototype.WHEEL_SCALE = 72;

Defaults to: (function() { var scale; if (Ext.isGecko) { // Firefox uses 3 on all platforms scale = 3; } else if (Ext.isMac) { // Continuous scrolling devices have momentum and produce much more scroll than // discrete devices on the same OS and browser. To make things exciting, Safari // (and not Chrome) changed from small values to 120 (like IE). if (Ext.isSafari && Ext.webKitVersion >= 532) { // Safari changed the scrolling factor to match IE (for details see // https://bugs.webkit.org/show_bug.cgi?id=24368). The WebKit version where this // change was introduced was 532.0 // Detailed discussion: // https://bugs.webkit.org/show_bug.cgi?id=29601 // http://trac.webkit.org/browser/trunk/WebKit/chromium/src/mac/WebInputEventFactory.mm#L1063 scale = 120; } else { // MS optical wheel mouse produces multiples of 12 which is close enough // to help tame the speed of the continuous mice... scale = 12; } // Momentum scrolling produces very fast scrolling, so increase the scale factor // to help produce similar results cross platform. This could be even larger and // it would help those mice, but other mice would become almost unusable as a // result (since we cannot tell which device type is in use). scale *= 3; } else { // IE, Opera and other Windows browsers use 120. scale = 120; } return scale; }())

Ext.event.Event
view source

## X

Key constant @type Number

Defaults to: 88

Ext.event.Event
view source

## Y

Key constant @type Number

Defaults to: 89

Ext.event.Event
view source

## Z

Key constant @type Number

Defaults to: 90

Ext.event.Event
view source

## ZERO

Key constant @type Number

Defaults to: 48

Ext.Base
view source

## $onExtended
static sta private pri

Defaults to: []

Ext.event.Event
view source

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

Ext.event.Event
view source

## focusEvents
static sta private pri

Defaults to: { focus: 1, blur: 1, focusin: 1, focusout: 1, focusenter: 1, focusleave: 1 }

Ext.event.Event
view source

## mouseEvents
static sta private pri

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

Ext.event.Event
view source

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

Ext.event.Event
view source

## touchEvents
static sta private pri

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

## methods

Ext.Base
view source

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

Ext.Base
view source

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

Sample Code

     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:

Sample Code

     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.

Sample Code

     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.

Sample Code

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

Ext.Base
view source

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

Sample Code

     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:

Sample Code

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

Ext.event.Event
view source

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

Ext.event.Event
view source

## 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
Ext.event.Event
view source

## correctWheelDelta ( delta )
private pri

Correctly scales a given wheel delta.

### Parameters

delta : Number

The delta value.

Ext.Base
view source

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

Ext.event.Event
view source

## getCharCode : Number

Gets the character code for the event.

### Returns

:Number
Ext.Base
view source

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

Ext.Base
view source

## getCurrentConfig
private pri

Ext.Base
view source

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

Sample Code

    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:

Sample Code

    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.

Ext.event.Event
view source

## getKey : Number

Returns a normalized keyCode for the event.

### Returns

:Number

The key code

Ext.event.Event
view source

## getKeyName : String

Returns the name of the keyCode for the event.

### Returns

:String

The key name

Ext.event.Event
view source

## getPoint : Ext.util.Point

Returns a point object that consists of the object coordinates.

### Returns

:Ext.util.Point

point

Ext.event.Event
view source

## 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
Ext.event.Event
view source

## 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
Ext.event.Event
view source

## getTime : Date

Returns the time of the event.

### Returns

:Date
Ext.event.Event
view source

## getWheelDelta : Number

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

### Returns

:Number

The mouse wheel y-delta

Ext.event.Event
view source

## getWheelDeltas : Object

Returns the mouse wheel deltas for this event.

### Returns

:Object

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

Ext.event.Event
view source

## getX : Number

Gets the x coordinate of the event.

### Returns

:Number
Ext.event.Event
view source

## getXY : Number[]

Gets the X and Y coordinates of the event.

### Returns

:Number[]

The xy values like [x, y]

Ext.event.Event
view source

## getY : Number

Gets the y coordinate of the event.

### Returns

:Number
Ext.Base
view source

## hasConfig ( config )
private pri

### Parameters

config : Object

Ext.event.Event
view source

## hasModifier : Boolean

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

### Returns

:Boolean
Ext.Base
view source

## initConfig ( config ) : Ext.Base
chainable ch protected pro

Initialize configuration for this class. a typical example:

Sample Code

    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

config : Object

### Returns

:Ext.Base

this

Ext.event.Event
view source

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

Ext.event.Event
view source

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

Ext.Base
view source

## link ( name , value ) : Object
private pri

Adds a "destroyable" object to an internal list of objects that will be destroyed when this instance is destroyed (via destroy).

### Parameters

name : String

value : Object

### Returns

:Object

The `value` passed.

Ext.event.Event
view source

## preventDefault
chainable ch

Prevents the browsers default handling of the event.

Ext.Base
view source

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

Ext.event.Event
view source

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

Ext.Base
view source

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

Sample Code

    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
Ext.event.Event
view source

## stopEvent
chainable ch

Stop the event (preventDefault and stopPropagation).

Ext.event.Event
view source

## stopPropagation
chainable ch

Cancels bubbling of the event.

Ext.Base
view source

## unlink ( names ) : Ext.Base
chainable ch private pri

Destroys a given set of linked objects. This is only needed if the linked object is being destroyed before this instance.

### Parameters

names : String[]

The names of the linked objects to destroy.

### Returns

:Ext.Base

this

Ext.event.Event
view source

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

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

Sample Code

    // 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 also check if the passed element is the target or related target

### Returns

:Boolean
Ext.Base
view source

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

Ext.Base
view source

## addInheritableStatics ( members )
chainable ch static sta private pri

### Parameters

members : Object

Ext.Base
view source

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

### Parameters

name : Object

member : Object

Ext.Base
view source

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

Add methods / properties to the prototype of this class.

Sample Code

    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

Ext.Base
view source

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

Add / override static properties of this class.

Sample Code

    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

Ext.Base
view source

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

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

Sample Code

    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

Ext.Base
view source

## callParent ( args )
static sta protected pro

### Parameters

args : Object

Ext.Base
view source

## callSuper ( args )
static sta protected pro

### Parameters

args : Object

Ext.Base
view source

## create : Object
static sta

Create a new instance of this Class.

Sample Code

    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.

Ext.Base
view source

## createAlias ( alias , origin )
static sta

Create aliases for existing prototype methods. Example:

Sample Code

    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

Ext.Base
view source

## extend ( config )
static sta private pri

### Parameters

config : Object

Ext.Base
view source

## getConfigurator : Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

### Returns

:Ext.Configurator
Ext.event.Event
view source

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

Ext.Base
view source

## getName : String
static sta

Get the current class' name in string format.

Sample Code

    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

Ext.Base
view source

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

Used internally by the mixins pre-processor

### Parameters

name : Object

mixinClass : Object

Ext.Base
view source

## onExtended ( fn , scope )
static sta private pri

### Parameters

fn : Object

scope : Object

Ext.Base
view source

## override ( members ) : Ext.Base
chainable ch static sta

Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.

Sample Code

    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:

Sample Code

    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

Ext.Base
view source

## triggerExtended
static sta private pri

## Ext JS 6.2.0 - Modern Toolkit

## Ext JS

### 6.x

6.2.0 EA (classic) (modern)
6.0.2 (classic) (modern)
6.0.1 (classic) (modern)
6.0.0 (classic) (modern)

### 5.x

5.1.3 5.1.2 5.1.1 5.1.0 5.0.1 5.0.0

### 4.x

4.2.5 4.1.3 4.0.7

### 3.x

3.4.0

## Sencha Test

Sencha Test

## Cmd

Cmd

## GXT

4.x 3.x

## IDE Plugins

IDE Plugins

## Sencha Inspector

Sencha Inspector

## Architect

Architect 3 Architect 4 EA

## Touch

### 2.x

Touch 2.4 Touch 2.3 Touch 2.2 Touch 2.0

## Web Application Manager

Web Application Manager
Current Product / Version
All
Show product details in the history bar