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.field.SingleSlider 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.field.SingleSlider xtype: singlesliderfield

### Hierarchy

Ext.Base
Ext.Evented
Ext.Widget
Ext.Component
Ext.Decorator
Ext.field.Field
Ext.field.Slider
Ext.field.SingleSlider

### Inherited Mixins

Ext.Mixin
Ext.mixin.Bindable
Ext.mixin.ComponentDelegation
Ext.mixin.Identifiable
Ext.mixin.Inheritable
Ext.mixin.Keyboard
Ext.mixin.Observable
Ext.mixin.Pluggable

### Sub-Classes

Ext.field.Toggle

## Summary

The slider is a way to allow the user to select a value from a given numerical range. You might use it for choosing

No members found using the current filters

## configs

Ext.Component
view source

## axisLock : Boolean

If `true`, then, when showBy or alignTo fallback on constraint violation only takes place along the major align axis.

That is, if alignment `"l-r"` is being used, and `axisLock: true` is used, then if constraints fail, only fallback to `"r-l"` is considered.

Defaults to: null

Ext.Widget
view source

## baseCls : String / Boolean
bindable bind protected pro

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

Defaults to: true

## getBaseCls String / Boolean

Returns the value of baseCls

### Returns

String / Boolean

## setBaseCls (baseCls)

Sets the value of baseCls

### Parameters

baseCls : String / Boolean

Ext.mixin.Bindable
view source

## bind : Object

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

Sample Code

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

To dynamically add bindings:

Sample Code

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

To remove bindings:

Sample Code

     panel.setBind({
         title: null
     });

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

Defaults to: null

Ext.field.Field
view source

## bodyAlign : 'start' / 'center' / 'end' / 'stretch'

The horizontal alignment of this field's component within the body of the field

Defaults to: 'start'

Ext.Widget
view source

## border : Boolean
bindable bind

Enables or disables bordering on this component. The following values are accepted:

- `null` or `true (default): Do nothing and allow the border to be specified by the theme.
- `false`: suppress the default border provided by the theme.

Please note that enabling bordering via this config will not add a `border-color` or `border-style` CSS property to the component; you provide the `border-color` and `border-style` via CSS rule or style configuration (if not already provide by the theme).

## Using style:

Sample Code

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

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

## Using CSS:

Sample Code

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

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

And your CSS file:

Sample Code

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

Defaults to: null

## getBorder Boolean

Returns the value of border

### Returns

Boolean

## setBorder (border)

Sets the value of border

### Parameters

border : Boolean

Ext.Component
view source

## bottom : Number / String
bindable bind

The absolute bottom position of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to: null

## getBottom Number / String

Returns the value of bottom

### Returns

Number / String

## setBottom (bottom)

Sets the value of bottom

### Parameters

bottom : Number / String

Ext.Component
view source

## centered : Boolean
bindable bind

Configure this as `true` to have this Component centered within its Container. Setting this value to `true` will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to: false

## getCentered Boolean

Returns the value of centered

### Returns

Boolean

## setCentered (centered)

Sets the value of centered

### Parameters

centered : Boolean

Ext.field.Field
view source

## clearIcon : Boolean
bindable bind

`true` to use a clear icon in this field.

Defaults to: null

## getClearIcon Boolean

Returns the value of clearIcon

### Returns

Boolean

## setClearIcon (clearIcon)

Sets the value of clearIcon

### Parameters

clearIcon : Boolean

Ext.Widget
view source

## cls : String / String[]
bindable bind

The CSS class to add to this widget's element, in addition to the baseCls. In many cases, this property will be specified by the derived widget class. See userCls for adding additional CSS classes to widget instances (such as items in a Ext.Container).

Defaults to: null

## getCls String / String[]

Returns the value of cls

### Returns

String / String[]

## setCls (cls)

Sets the value of cls

### Parameters

cls : String / String[]

Ext.field.Field
view source

## component : Object

The inner component for this field.

Ext.Component
view source

## contentEl : Ext.dom.Element / HTMLElement / String
bindable bind

The configured element will automatically be added as the content of this component. When you pass a string, we expect it to be an element id. If the content element is hidden, we will automatically show it.

Defaults to: null

## getContentEl Ext.dom.Element / HTMLElement / String

Returns the value of contentEl

### Returns

Ext.dom.Element / HTMLElement / String

## setContentEl (contentEl)

Sets the value of contentEl

### Parameters

contentEl : Ext.dom.Element / HTMLElement / String

Ext.mixin.Bindable
view source

## controller : String / Object / Ext.app.ViewController

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

Sample Code

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

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

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

Defaults to: null

Ext.mixin.Bindable
view source

## getController : Ext.app.ViewController

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

### Returns

:Ext.app.ViewController

Returns this component's ViewController or null if one was not configured

Ext.Component
view source

## data : Object
bindable bind

The initial set of data to apply to the tpl to update the content area of the Component.

Defaults to: null

## getData Object

Returns the value of data

### Returns

Object

## setData (data)

Sets the value of data

### Parameters

data : Object

Ext.mixin.Bindable
view source

## defaultListenerScope : Boolean

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

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

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

Defaults to: false

Ext.Component
view source

## disabled : Boolean
bindable bind

Whether or not this component is disabled

Defaults to: null

## getDisabled Boolean

Returns the value of disabled

### Returns

Boolean

Ext.Decorator
view source

## setDisabled ( disabled )
private pri

### Parameters

disabled : Object

Ext.Component
view source

## docked : String
bindable bind

The dock position of this component in its container. Can be left, top, right or bottom.

Notes

You must use a HTML5 doctype for docked bottom to work. To do this, simply add the following code to the HTML file:

Sample Code

    <!doctype html>

So your index.html file should look a little like this:

Sample Code

    <!doctype html>
    <html>
        <head>
            <title>MY application title</title>
            ...

Defaults to: null

## getDocked String

Returns the value of docked

### Returns

String

## setDocked (docked)

Sets the value of docked

### Parameters

docked : String

Ext.Component
view source

## draggable : Object
bindable bind

Configuration options to make this Component draggable

Defaults to: null

## getDraggable Object

Returns the value of draggable

### Returns

Object

## setDraggable (draggable)

Sets the value of draggable

### Parameters

draggable : Object

Ext.Component
view source

## enterAnimation : String / Mixed
deprecated dep bindable bind

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'.

Defaults to: null

Deprecated: 2.0.0
Please use {@link #cfg!showAnimation #showAnimation} instead.

## getEnterAnimation String / Mixed

Returns the value of enterAnimation

### Returns

String / Mixed

## setEnterAnimation (enterAnimation)

Sets the value of enterAnimation

### Parameters

enterAnimation : String / Mixed

Ext.Component
view source

## exitAnimation : String / Mixed
deprecated dep bindable bind

Animation effect to apply when the Component is being hidden.

Defaults to: null

Deprecated: 2.0.0
Please use {@link #cfg!hideAnimation #hideAnimation} instead. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'.

## getExitAnimation String / Mixed

Returns the value of exitAnimation

### Returns

String / Mixed

## setExitAnimation (exitAnimation)

Sets the value of exitAnimation

### Parameters

exitAnimation : String / Mixed

Ext.Widget
view source

## height : Number / String
bindable bind

The height of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to `auto`, it will set the width to `null` meaning it will have its own natural size.

Defaults to: null

## getHeight Number / String

Returns the value of height

### Returns

Number / String

## setHeight (height)

Sets the value of height

### Parameters

height : Number / String

Ext.Widget
view source

## hidden : Boolean
bindable bind

Whether or not this Component is hidden (its CSS `display` property is set to `none`).

Defaults to `true` for floated Components.

Defaults to: null

## getHidden Boolean

Returns the value of hidden

### Returns

Boolean

## setHidden (hidden)

Sets the value of hidden

### Parameters

hidden : Boolean

Ext.Component
view source

## hideAnimation : String / Mixed
bindable bind

Animation effect to apply when the Component is being hidden. Typically you want to use an outbound animation type such as 'fadeOut' or 'slideOut'. For more animations, check the Ext.fx.Animation#type config.

Defaults to: null

## getHideAnimation String / Mixed

Returns the value of hideAnimation

### Returns

String / Mixed

## setHideAnimation (hideAnimation)

Sets the value of hideAnimation

### Parameters

hideAnimation : String / Mixed

Ext.Component
view source

## hideOnMaskTap : Boolean
bindable bind

When using a modal Component, setting this to `true` will hide the modal mask and the Container when the mask is tapped on.

Defaults to: null

## getHideOnMaskTap Boolean

Returns the value of hideOnMaskTap

### Returns

Boolean

## setHideOnMaskTap (hideOnMaskTap)

Sets the value of hideOnMaskTap

### Parameters

hideOnMaskTap : Boolean

Ext.Component
view source

## html : String / Ext.dom.Element / HTMLElement
bindable bind

Optional HTML content to render inside this Component, or a reference to an existing element on the page.

Defaults to: null

## getHtml String / Ext.dom.Element / HTMLElement

Returns the value of html

### Returns

String / Ext.dom.Element / HTMLElement

## setHtml (html)

Sets the value of html

### Parameters

html : String / Ext.dom.Element / HTMLElement

Ext.field.Slider
view source

## increment : Number
bindable bind

The increment by which to snap each thumb when its value changes. Any thumb movement will be snapped to the nearest value that is a multiple of the increment (e.g. if increment is 10 and the user tries to move the thumb to 67, it will be snapped to 70 instead)

Defaults to: 1

## getIncrement Number

Returns the value of increment

### Returns

Number

## setIncrement (increment)

Sets the value of increment

### Parameters

increment : Number

Ext.field.Field
view source

## inputCls : String

CSS class to add to the input element of this fields component

Defaults to: null

Ext.field.Field
view source

## inputType : String
deprecated dep bindable bind

The type attribute for input fields -- e.g. radio, text, password, file. The types 'file' and 'password' must be used to render those field types currently -- there are no separate Ext components for those.

Defaults to: 'text'

Deprecated: 2.0
Please use `input.type` instead.

## getInputType String

Returns the value of inputType

### Returns

String

## setInputType (inputType)

Sets the value of inputType

### Parameters

inputType : String

Ext.field.Field
view source

## isFocused : Boolean
private pri

`true` if this field is currently focused.

Ext.mixin.Keyboard
view source

## keyMap : Object

An object containing handlers for keyboard events. The property names of this object are the key name and any modifiers. The values of the properties are the descriptors of how to handle each event.

The handler descriptor can be simply the handler function (either the literal function or the method name), or it can be an object with these properties:

- `handler`: The function or its name to call to handle the event.
- `scope`: The this pointer context (can be "this" or "controller").
- `event`: An optional override of the key event to which to listen.

Important: Calls to `setKeyMap` do not replace the entire keyMap but instead update the provided mappings. That is, unless `null` is passed as the value of the keyMap which will clear the keyMap of all entries.

Defaults to: null

### Properties

scope : String

The default scope to apply to key handlers which do not specify a scope. This is processed the same way as the scope of listeners. It defaults to the `"controller"`, but using `'this'` means that an instance method will be used.

Ext.mixin.Keyboard
view source

## keyMapEnabled : Boolean

Enables or disables processing keys in the keyMap. This value starts as `null` and if it is `null` when initKeyMap is called, it will automatically be set to `true`. Since initKeyMap is called by Ext.Component at the proper time, this is not something application code normally handles.

Defaults to: null

Ext.mixin.Keyboard
view source

## keyMapTarget : Boolean
protected pro

The name of the member that should be used to listen for keydown/keypress events. This is intended to be controlled at the class level not per instance.

Defaults to: 'el'

Ext.field.Field
view source

## label : String
bindable bind

The label of this field

Defaults to: null

## getLabel String

Returns the value of label

### Returns

String

## setLabel (label)

Sets the value of label

### Parameters

label : String

Ext.field.Field
view source

## labelAlign : 'top' / 'left' / 'bottom' / 'right'
bindable bind

The position to render the label relative to the field input.

Defaults to: 'left'

## getLabelAlign 'top' / 'left' / 'bottom' / 'right'

Returns the value of labelAlign

### Returns

'top' / 'left' / 'bottom' / 'right'

## setLabelAlign (labelAlign)

Sets the value of labelAlign

### Parameters

labelAlign : 'top' / 'left' / 'bottom' / 'right'

Ext.field.Field
view source

## labelCls : String
bindable bind

Optional CSS class to add to the Label element.

Defaults to: null

## getLabelCls String

Returns the value of labelCls

### Returns

String

## setLabelCls (labelCls)

Sets the value of labelCls

### Parameters

labelCls : String

Ext.field.Field
view source

## labelTextAlign : 'top' / 'right' / 'bottom' / 'left'

Text alignment of this field's label

Defaults to: 'left'

Ext.field.Field
view source

## labelWidth : Number / String
bindable bind

The width to make this field's label.

Defaults to: '30%'

## getLabelWidth Number / String

Returns the value of labelWidth

### Returns

Number / String

## setLabelWidth (labelWidth)

Sets the value of labelWidth

### Parameters

labelWidth : Number / String

Ext.field.Field
view source

## labelWrap : Boolean
bindable bind

`true` to allow the label to wrap. If set to `false`, the label will be truncated with an ellipsis.

Defaults to: false

## getLabelWrap Boolean

Returns the value of labelWrap

### Returns

Boolean

## setLabelWrap (labelWrap)

Sets the value of labelWrap

### Parameters

labelWrap : Boolean

Ext.Component
view source

## left : Number / String
bindable bind

The absolute left position of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to: null

## getLeft Number / String

Returns the value of left

### Returns

Number / String

## setLeft (left)

Sets the value of left

### Parameters

left : Number / String

Ext.mixin.Observable
view source

## listeners : Object
bindable bind

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from Ext JS Ext.Component

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataViews itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the `element` option to identify the Component property to add a DOM listener to:

Sample Code

    new Ext.panel.Panel({
        width: 400,
        height: 200,
        dockedItems: [{
            xtype: 'toolbar'
        }],
        listeners: {
            click: {
                element: 'el', //bind to the underlying el property on the panel
                fn: function(){ console.log('click el'); }
            },
            dblclick: {
                element: 'body', //bind to the underlying body property on the panel
                fn: function(){ console.log('dblclick body'); }
            }
        }
    });

Ext.mixin.Observable
view source

## setListeners ( listeners )

An alias for addListener. In versions prior to 5.1, listeners had a generated setter which could be called to add listeners. In 5.1 the listeners config is not processed using the config system and has no generated setter, so this method is provided for backward compatibility. The preferred way of adding listeners is to use the on method.

### Parameters

listeners : Object

The listeners

Ext.field.Slider
view source

## liveUpdate : Boolean

`true` to fire change events while the slider is dragging. `false` will only fire a change once the drag is complete.

Defaults to: false

Ext.Component
view source

## margin : Number / String
bindable bind

The margin to use on this Component. Can be specified as a number (in which case all edges get the same margin) or a CSS string like '5 10 10 10'

Defaults to: null

## getMargin Number / String

Returns the value of margin

### Returns

Number / String

## setMargin (margin)

Sets the value of margin

### Parameters

margin : Number / String

Ext.Component
view source

## maxHeight : Number / String
bindable bind

The maximum height of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. If set to `auto`, it will set the width to `null` meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to: null

## getMaxHeight Number / String

Returns the value of maxHeight

### Returns

Number / String

## setMaxHeight (maxHeight)

Sets the value of maxHeight

### Parameters

maxHeight : Number / String

Ext.field.Slider
view source

## maxValue : Number
bindable bind

The highest value any thumb on this slider can be set to.

Defaults to: 100

## getMaxValue Number

Returns the value of maxValue

### Returns

Number

## setMaxValue (maxValue)

Sets the value of maxValue

### Parameters

maxValue : Number

Ext.Component
view source

## maxWidth : Number / String
bindable bind

The maximum width of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. If set to `auto`, it will set the width to `null` meaning it will have its own natural size. Note that this config will not apply if the Component is 'positioned' (absolutely positioned or centered)

Defaults to: null

## getMaxWidth Number / String

Returns the value of maxWidth

### Returns

Number / String

## setMaxWidth (maxWidth)

Sets the value of maxWidth

### Parameters

maxWidth : Number / String

Ext.Component
view source

## minHeight : Number / String
bindable bind

The minimum height of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. If set to `auto`, it will set the width to `null` meaning it will have its own natural size.

Defaults to: null

## getMinHeight Number / String

Returns the value of minHeight

### Returns

Number / String

## setMinHeight (minHeight)

Sets the value of minHeight

### Parameters

minHeight : Number / String

Ext.field.Slider
view source

## minValue : Number
bindable bind

The lowest value any thumb on this slider can be set to.

Defaults to: 0

## getMinValue Number

Returns the value of minValue

### Returns

Number

## setMinValue (minValue)

Sets the value of minValue

### Parameters

minValue : Number

Ext.Component
view source

## minWidth : Number / String
bindable bind

The minimum width of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. If set to `auto`, it will set the width to `null` meaning it will have its own natural size.

Defaults to: null

## getMinWidth Number / String

Returns the value of minWidth

### Returns

Number / String

## setMinWidth (minWidth)

Sets the value of minWidth

### Parameters

minWidth : Number / String

Ext.Component
view source

## modal : Boolean
bindable bind

`true` to make this Componenrt modal. This will create a mask underneath the Component that covers its parent and does not allow the user to interact with any other Components until this Component is dismissed.

Defaults to: null

## getModal Boolean

Returns the value of modal

### Returns

Boolean

## setModal (modal)

Sets the value of modal

### Parameters

modal : Boolean

Ext.field.Field
view source

## name : String
bindable bind

The field's HTML name attribute.

Note: this property must be set if this field is to be automatically included with. form submit().

Defaults to: null

## getName String

Returns the value of name

### Returns

String

## setName (name)

Sets the value of name

### Parameters

name : String

Ext.Component
view source

## padding : Number / String
bindable bind

The padding to use on this Component. Can be specified as a number (in which case all edges get the same padding) or a CSS string like '5 10 10 10'

Defaults to: null

## getPadding Number / String

Returns the value of padding

### Returns

Number / String

## setPadding (padding)

Sets the value of padding

### Parameters

padding : Number / String

Ext.mixin.Pluggable
view source

## plugins : Object / String / Object[] / String[]

An object or array of objects that will provide custom functionality for this component. If a string is provided or a string is one of the elements of the array, that string is treated as the `type` alias. For example, "listpaging" is the type alias for Ext.plugin.ListPaging. The full alias includes the "plugin." prefix (i.e., 'plugin.listpaging').

Plugins should derive from Ext.plugin.Abstract but this is not required. The only requirement for a valid plugin is that it contain an `init()` method that accepts a reference to the owning component.

When a component is created, if any plugins are available, the component will call the init method on each plugin, passing a reference to itself. Each plugin can then call methods or respond to events on the component as needed to provide its functionality.

## Example code

A plugin by alias:

Sample Code

     var list = Ext.create({
         xtype: 'list',
         itemTpl: '<div class="item">{title}</div>',
         store: 'Items',

         plugins: 'listpaging'
     });

Multiple plugins by alias:

Sample Code

     var list = Ext.create({
         xtype: 'list',
         itemTpl: '<div class="item">{title}</div>',
         store: 'Items',

         plugins: ['listpaging', 'pullrefresh']
     });

Single plugin by class name with config options:

Sample Code

     var list = Ext.create({
         xtype: 'list',
         itemTpl: '<div class="item">{title}</div>',
         store: 'Items',

         plugins: {
             type: 'listpaging',
             autoPaging: true
         }
     });

Multiple plugins by type and class name with config options:

Sample Code

     var list = Ext.create({
         xtype: 'list',
         itemTpl: '<div class="item">{title}</div>',
         store: 'Items',

         plugins: [{
             xclass: 'Ext.plugin.PullRefresh',
             pullRefreshText: 'Pull to refresh...'
         }, {
             type: 'listpaging',
             autoPaging: true
         }]
     });

Defaults to: null

Ext.mixin.Bindable
view source

## publishes : String / String[] / Object

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

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

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

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

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

Sample Code

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

Classes must provide this config as an Object:

Sample Code

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

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

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

Sample Code

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

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

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

Sample Code

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

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

Defaults to: null

Available since: 5.0.0

Ext.field.Slider
view source

## readOnly : Boolean
bindable bind

Will make this field read only, meaning it cannot be changed with used interaction.

Defaults to: false

## getReadOnly Boolean

Returns the value of readOnly

### Returns

Boolean

## setReadOnly (readOnly)

Sets the value of readOnly

### Parameters

readOnly : Boolean

Ext.Component
view source

## record : Ext.data.Model
bindable bind

A model instance which updates the Component's html based on it's tpl. Similar to the data configuration, but tied to to a record to make allow dynamic updates. This must be a model instance and not a configuration of one.

Defaults to: null

## getRecord Ext.data.Model

Returns the value of record

### Returns

Ext.data.Model

## setRecord (record)

Sets the value of record

### Parameters

record : Ext.data.Model

Ext.mixin.Bindable
view source

## reference : String

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

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

Defaults to: null

Ext.Component
view source

## renderTo : Ext.dom.Element
bindable bind

Optional element to render this Component to. Usually this is not needed because a Component is normally full screen or automatically rendered inside another Ext.Container

Defaults to: null

## getRenderTo Ext.dom.Element

Returns the value of renderTo

### Returns

Ext.dom.Element

## setRenderTo (renderTo)

Sets the value of renderTo

### Parameters

renderTo : Ext.dom.Element

Ext.field.Field
view source

## required : Boolean
bindable bind

`true` to make this field required.

Note: this only causes a visual indication.

Doesn't prevent user from submitting the form.

Defaults to: false

## getRequired Boolean

Returns the value of required

### Returns

Boolean

## setRequired (required)

Sets the value of required

### Parameters

required : Boolean

Ext.Component
view source

## right : Number / String
bindable bind

The absolute right position of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to: null

## getRight Number / String

Returns the value of right

### Returns

Number / String

## setRight (right)

Sets the value of right

### Parameters

right : Number / String

Ext.Component
view source

## scrollable : Boolean / String / Object
bindable bind

Configuration options to make this Component scrollable. Acceptable values are:

- `true` to enable auto scrolling.
- `false` (or `null`) to disable scrolling - this is the default.
- `x` or `horizontal` to enable horizontal scrolling only
- `y` or `vertical` to enable vertical scrolling only

Also accepts a configuration object for a Ext.scroll.Scroller if if advanced configuration is needed.

The getter for this config returns the Ext.scroll.Scroller instance. You can use the Scroller API to read or manipulate the scroll position:

Sample Code

    // scrolls the component to 5 on the x axis and 10 on the y axis
    component.getScrollable().scrollTo(5, 10);

Defaults to: null

## getScrollable Boolean / String / Object

Returns the value of scrollable

### Returns

Boolean / String / Object

## setScrollable (scrollable)

Sets the value of scrollable

### Parameters

scrollable : Boolean / String / Object

Ext.mixin.Bindable
view source

## session : Boolean / Object / Ext.data.Session

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

To create a new session you can specify `true`:

Sample Code

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

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

Alternatively, a config object can be provided:

Sample Code

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

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

Defaults to: null

Ext.Component
view source

## showAnimation : String / Mixed
bindable bind

Animation effect to apply when the Component is being shown. Typically you want to use an inbound animation type such as 'fadeIn' or 'slideIn'. For more animations, check the Ext.fx.Animation#type config.

Defaults to: null

## getShowAnimation String / Mixed

Returns the value of showAnimation

### Returns

String / Mixed

## setShowAnimation (showAnimation)

Sets the value of showAnimation

### Parameters

showAnimation : String / Mixed

Ext.Widget
view source

## style : String / Object
bindable bind

Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.

You can pass either a string syntax:

Sample Code

    style: 'background:red'

Or by using an object:

Sample Code

    style: {
        background: 'red'
    }

When using the object syntax, you can define CSS Properties by using a string:

Sample Code

    style: {
        'border-left': '1px solid red'
    }

Although the object syntax is much easier to read, we suggest you to use the string syntax for better performance.

Defaults to: null

## getStyle String / Object

Returns the value of style

### Returns

String / Object

## setStyle (style)

Sets the value of style

### Parameters

style : String / Object

Ext.Component
view source

## styleHtmlCls : String
bindable bind

The class that is added to the content target when you set styleHtmlContent to `true`.

Defaults to: "x-html"

## getStyleHtmlCls String

Returns the value of styleHtmlCls

### Returns

String

## setStyleHtmlCls (styleHtmlCls)

Sets the value of styleHtmlCls

### Parameters

styleHtmlCls : String

Ext.Component
view source

## styleHtmlContent : Boolean
bindable bind

`true` to automatically style the HTML inside the content target of this component (body for panels).

Defaults to: false

## getStyleHtmlContent Boolean

Returns the value of styleHtmlContent

### Returns

Boolean

## setStyleHtmlContent (styleHtmlContent)

Sets the value of styleHtmlContent

### Parameters

styleHtmlContent : Boolean

Ext.field.Slider
view source

## tabIndex

The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via `applyTo`.

Defaults to: -1

Ext.Component
view source

## tooltip : String / Object

The tooltip for this component - can be a string to be used as innerHTML (html tags are accepted) or Ext.tip.ToolTip config object.

The default behavior is to use a shared tip instance. The tooltip configuration is registered with the Ext.tip.Manager. To enable this, your application can set the Ext.app.Application#quickTips config, or an instance of the Ext.tip.Manager may be created manually.

To force a unique tooltip instance to be created, specify `autoCreate: true` on this configuration.

Defaults to: null

Ext.Component
view source

## top : Number / String
bindable bind

The absolute top position of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. Explicitly setting this value will make this Component become 'positioned', which means it will no longer participate in the layout of the Container that it resides in.

Defaults to: null

## getTop Number / String

Returns the value of top

### Returns

Number / String

## setTop (top)

Sets the value of top

### Parameters

top : Number / String

Ext.Widget
view source

## touchAction : Object

Emulates the behavior of the CSS touch-action property in a cross-browser compatible manner.

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

- `panX`
- `panY`
- `pinchZoom`
- `doubleTapZoom`

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

Sample Code

    touchAction: {
        panX: false,
        pinchZoom: false
    }

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

Sample Code

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

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

Sample Code

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

Defaults to: null

Ext.Component
view source

## tpl : String / String[] / Ext.Template / Ext.XTemplate[]
bindable bind

A String, Ext.Template, Ext.XTemplate or an Array of strings to form an Ext.XTemplate. Used in conjunction with the data and tplWriteMode configurations.

Note The data configuration must be set for any content to be shown in the component when using this configuration.

Defaults to: null

## getTpl String / String[] / Ext.Template / Ext.XTemplate[]

Returns the value of tpl

### Returns

String / String[] / Ext.Template / Ext.XTemplate[]

## setTpl (tpl)

Sets the value of tpl

### Parameters

tpl : String / String[] / Ext.Template / Ext.XTemplate[]

Ext.Component
view source

## tplWriteMode : String
bindable bind

The Ext.(X)Template method to use when updating the content area of the Component. Valid modes are:

- append
- insertAfter
- insertBefore
- insertFirst
- overwrite

Defaults to: 'overwrite'

## getTplWriteMode String

Returns the value of tplWriteMode

### Returns

String

## setTplWriteMode (tplWriteMode)

Sets the value of tplWriteMode

### Parameters

tplWriteMode : String

Ext.mixin.Bindable
view source

## twoWayBindable : String / String[] / Object

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

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

Defaults to: null

Ext.Widget
view source

## ui : String / String[]

The ui or uis to be used on this Component

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

Defaults to: null

Ext.Component
view source

## useBodyElement
private pri

Defaults to: null

Ext.Widget
view source

## userCls : String / String[]

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

For example:

Sample Code

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

Defaults to: null

Ext.field.SingleSlider
view source

## value : Number
bindable bind

The value(s) of this slider's thumbs. If you pass a number, it will assume you have just 1 thumb.

## getValue Number

Returns the value of value

### Returns

Number

## setValue (value)

Sets the value of value

### Parameters

value : Number

Ext.field.Slider
view source

## values : Number / Number[]
bindable bind

Alias to value

Ext.field.Slider
view source

## getValues : Object

Convenience method. Calls getValue

### Returns

:Object
Ext.field.Slider
view source

## setValues ( value )

Convenience method. Calls setValue.

### Parameters

value : Object

Ext.mixin.Bindable
view source

## viewModel : String / Object / Ext.app.ViewModel

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

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

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

Defaults to: null

Ext.Widget
view source

## width : Number / String
bindable bind

The width of this Component; must be a valid CSS length value, e.g: `300`, `100px`, `30%`, etc. By default, if this is not explicitly set, this Component's element will simply have its own natural size. If set to `auto`, it will set the width to `null` meaning it will have its own natural size.

Defaults to: null

## getWidth Number / String

Returns the value of width

### Returns

Number / String

## setWidth (width)

Sets the value of width

### Parameters

width : Number / String

Ext.Component
view source

## xtype : String

The xtype configuration option can be used to optimize Component creation and rendering. It serves as a shortcut to the full component name. For example, the component `Ext.button.Button` has an xtype of `button`.

You can define your own xtype on a custom Ext.Component by specifying the alias config option with a prefix of `widget`. For example:

Sample Code

    Ext.define('PressMeButton', {
        extend: 'Ext.button.Button',
        alias: 'widget.pressmebutton',
        text: 'Press Me'
    });

Any Component can be created implicitly as an object config with an xtype specified, allowing it to be declared and passed into the rendering pipeline without actually being instantiated as an object. Not only is rendering deferred, but the actual creation of the object itself is also deferred, saving memory and resources until they are actually needed. In complex, nested layouts containing many Components, this can make a noticeable improvement in performance.

Sample Code

    // Explicit creation of contained Components:
    var panel = new Ext.Panel({
       // ...
       items: [
          Ext.create('Ext.button.Button', {
             text: 'OK'
          })
       ]
    });

    // Implicit creation using xtype:
    var panel = new Ext.Panel({
       // ...
       items: [{
          xtype: 'button',
          text: 'OK'
       }]
    });

In the first example, the button will always be created immediately during the panel's initialization. With many added Components, this approach could potentially slow the rendering of the page. In the second example, the button will not be created or rendered until the panel is actually displayed in the browser. If the panel is never displayed (for example, if it is a tab that remains hidden) then the button will never be created and will never consume any resources whatsoever.

Ext.Component
view source

## zIndex : Number
bindable bind

The z-index to give this Component when it is rendered.

Not valid for floated Components. The Z ordering of floated Components is managed by ordering of the DOM elements.

Defaults to: null

## getZIndex Number

Returns the value of zIndex

### Returns

Number

## setZIndex (zIndex)

Sets the value of zIndex

### Parameters

zIndex : Number

## 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.mixin.Observable
view source

## $eventOptions
private pri

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

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

Ext.mixin.Observable
view source

## $vetoClearingPrototypeOnDestroy

our destroyObservable handler must be called the very last. It will take care of the prototype after completing Observable destruction sequence.

Defaults to: true

Ext.Component
view source

## activeAnimation
private pri

Defaults to: null

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.Widget
view source

## classCls
protected pro

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

Sample Code

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

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

    var bar = new Bar();

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

Defaults to: null

Ext.Widget
view source

## classClsRoot
protected pro

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

Defaults to: true

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.Component
view source

## defaultBindProperty

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

Sample Code

     bind: '{name}'

Is equivalent to this object form:

Sample Code

     bind: {
         value: '{name}'
     }

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

Defaults to: 'html'

Ext.Base
view source

## destroyed : Boolean
protected pro

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

Defaults to: false

Ext.Component
view source

## dockPositions
readonly ro private pri

Defaults to: { top: true, right: true, bottom: true, left: true }

Ext.Widget
view source

## element : Object
protected pro

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

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

   element: {

   Sample Code

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

   }

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

Sample Code

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

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

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

   element: {

   Sample Code

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

   }

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

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

Defaults to: { reference: 'element' }

Ext.mixin.Observable
view source

## eventsSuspended
private pri

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

Defaults to: 0

Ext.mixin.Observable
view source

## hasListeners : Object
readonly ro

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

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

Sample Code

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

Ext.Component
view source

## isComponent
private pri

Defaults to: true

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.field.Field
view source

## isField : Boolean

Set to `true` on all Ext.field.Field subclasses. This is used by Ext.form.Panel#getValues to determine which components inside a form are fields.

Defaults to: true

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.field.Field
view source

## isFormField
private pri

Defaults to: true

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.mixin.Observable
view source

## isObservable : Boolean

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

Defaults to: true

Ext.field.Field
view source

## labelEl : Ext.dom.Element

The label Element associated with this Field.

Note: Only available if a label is specified.

Ext.Widget
view source

## noBorderCls : String
readonly ro private pri

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

Defaults to: Ext.baseCSSPrefix + 'noborder-trbl'

Ext.field.Field
view source

## originalValue : Mixed

The original value of the field as configured in the value configuration. setting is `true`.

Defaults to: this.getInitialConfig().value

Ext.Component
view source

## positioned
private pri

Defaults to: false

Ext.Component
view source

## rendered
private pri

Defaults to: false

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.Widget
view source

## template : Array
protected pro

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

Defaults to: []

Ext.mixin.Bindable
view source

## validRefRe : RegExp
private pri

Regular expression used for validating reference values.

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

Ext.Base
view source

## $onExtended
static sta private pri

Defaults to: []

## methods

Ext.mixin.Observable
view source

## _addDeclaredListeners ( listeners ) : Boolean
private pri

Adds declarative listeners as nested arrays of listener objects.

### Parameters

listeners : Array

### Returns

:Boolean

`true` if any listeners were added

Ext.mixin.Pluggable
view source

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

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

Available since: 6.2.0

### Parameters

type : String

The `type` of the plugin.

### Returns

:Ext.plugin.Abstract

The plugin that was created.

Ext.mixin.Observable
view source

## addAfterListener

Alias for onAfter.

Ext.mixin.Observable
view source

## addBeforeListener

Alias for onBefore.

Ext.mixin.Bindable
view source

## addBindableUpdater ( property )
private pri

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

Available since: 5.0.0

### Parameters

property : String

The name of the config property.

Ext.Component
view source

## addCls ( cls , [prefix] , [suffix] )

Adds a CSS class (or classes) to this Component's rendered element.

### Parameters

cls : String

The CSS class to add.

prefix : String (optional)

Optional prefix to add to each class.

Defaults to: ""

suffix : String (optional)

Optional suffix to add to each class.

Defaults to: ""

Ext.mixin.ComponentDelegation
view source

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

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

### Parameters

eventName : Object

fn : Object

scope : Object

options : Object

order : Object

caller : Object

manager : Object

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.Widget
view source

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

Adds an element reference to this Widget instance.

### Parameters

name : String

The name of the reference

domNode : HTMLElement

### Returns

:Ext.dom.Element
Ext.Widget
view source

## addElementReferenceOnDemand ( name , domNode )
private pri

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

### Parameters

name : String

The name of the reference

domNode : HTMLElement

Ext.mixin.Observable
view source

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

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

Sample Code

    myGridPanel.on("itemclick", this.onItemClick, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

Sample Code

    myGridPanel.on({
        cellclick: this.onCellClick,
        select: this.onSelect,
        viewready: this.onViewReady,
        scope: this // Important. Ensure "this" is correct during handler execution
    });

One can also specify options for each event handler separately:

Sample Code

    myGridPanel.on({
        cellclick: {fn: this.onCellClick, scope: this, single: true},
        viewready: {fn: panel.onViewReady, scope: panel}
    });

Names of methods in a specified scope may also be used:

Sample Code

    myGridPanel.on({
        cellclick: {fn: 'onCellClick', scope: this, single: true},
        viewready: {fn: 'onViewReady', scope: panel}
    });

### Parameters

eventName : String / Object

The name of the event to listen for. May also be an object who's property names are event names.

fn : Function / String (optional)

The method the event invokes or the name of the method within the specified `scope`. Will be called with arguments given to Ext.util.Observable#fireEvent plus the `options` parameter described below.

scope : Object (optional)

The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options : Object< / a> (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope : Object

The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay : Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single : Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer : Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame : Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target : Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element : String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

Sample Code

      var panel = new Ext.panel.Panel({
                                  title: 'The title',
                                  listeners: {
                                      click: this.handlePanelClick,
                                      element: 'body'
                                  }
                              });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

Sample Code

     panel.body.un(...)

delegate : String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture : Boolean (optional)

When set to `true`, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call stopPropagation on the event object before firing the handler.

preventDefault : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call preventDefault on the event object before firing the handler.

stopEvent : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call stopEvent on the event object before firing the handler.

args : Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable : Boolean (optional)

When specified as `true`, the function returns a `destroyable` object. An object which implements the `destroy` method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to: false

priority : Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order : String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the `priority` option instead. Available options are:

- `'before'`: equal to a priority of `100`
- `'current'`: equal to a priority of `0` or default priority
- `'after'`: equal to a priority of `-100`

Defaults to: 'current'

order : String (optional)

A shortcut for the `order` event option. Provided for backward compatibility. Please use the `priority` event option instead.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.

Sample Code

    myPanel.on('hide', this.handleClick, this, {
        single: true,
        delay: 100
    });

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

Sample Code

    grid.on({
        itemclick: 'onItemClick',
        itemcontextmenu: grid.onItemContextmenu,
        destroy: {
            fn: function () {
                // function called within the 'altCmp' scope instead of grid
            },
            scope: altCmp // unique scope for the destroy handler
        },
        scope: grid       // default scope - provided for example clarity
    });

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

Sample Code

    var panel = Ext.create({
        xtype: 'panel',
        renderTo: document.body,
        title: 'Delegate Handler Example',
        frame: true,
        height: 220,
        width: 220,
        html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
    });

    // The click handler will only be called when the click occurs on the
    // delegate: h1.myTitle ("h1" tag with class "myTitle")
    panel.on({
        click: function (e) {
            console.log(e.getTarget().innerHTML);
        },
        element: 'body',
        delegate: 'h1.myTitle'
     });

Defaults to: 'current'

### Returns

:Object

Only when the `destroyable` option is specified.

A `Destroyable` object. An object which implements the `destroy` method which removes all listeners added in this call. For example:

Sample Code

    this.btnListeners =  = myButton.on({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });

And when those listeners need to be removed:

Sample Code

    Ext.destroy(this.btnListeners);

or

Sample Code

    this.btnListeners.destroy();

Ext.mixin.Observable
view source

## addManagedListener ( item , ename , [fn] , [scope] , [options] ) : Object

The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Sample Code

    Ext.define('Foo', {
        extend: 'Ext.Component',

        initComponent: function () {
            this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
            this.callParent();
        }
    });

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (`MyApp.SomeGlobalSharedMenu`) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

### Parameters

item : Ext.util.Observable / Ext.dom.Element

The item to which to add a listener/listeners.

ename : Object / String

The event name, or an object containing event name properties.

fn : Function / String (optional)

If the `ename` parameter was an event name, this is the handler function or the name of a method on the specified `scope`.

scope : Object (optional)

If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

options : Object (optional)

If the `ename` parameter was an event name, this is the addListener options.

### Returns

:Object

Only when the `destroyable` option is specified.

A `Destroyable` object. An object which implements the `destroy` method which removes all listeners added in this call. For example:

Sample Code

    this.btnListeners = myButton.mon({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });

And when those listeners need to be removed:

Sample Code

    Ext.destroy(this.btnListeners);

or

Sample Code

    this.btnListeners.destroy();

Ext.mixin.Pluggable
view source

## addPlugin ( plugin )

Adds a plugin. For example:

Sample Code

     list.addPlugin('pullrefresh');

Or:

Sample Code

     list.addPlugin({
         type: 'pullrefresh',
         pullRefreshText: 'Pull to refresh...'
     });

Available since: 6.2.0

### Parameters

plugin : Object / String / Ext.plugin.Abstract

The plugin or config object or alias to add.

Ext.Component
view source

## afterEdit
private pri

Used to handle joining of a record to a tpl

Ext.Component
view source

## afterErase
private pri

Used to handle joining of a record to a tpl

Ext.mixin.Bindable
view source

## applyBind ( binds , currentBindings ) : Object
private pri

Available since: 5.0.0

### Parameters

binds : String / Object

currentBindings : Object

### Returns

:Object
Ext.Component
view source

## applyCentered ( centered ) : Boolean
private pri

### Parameters

centered : Boolean

### Returns

:Boolean
Ext.Decorator
view source

## applyComponent ( config )
private pri

### Parameters

config : Object

Ext.mixin.Pluggable
view source

## applyPlugins ( plugins , oldPlugins )
private pri

Applier for the plugins config property.

### Parameters

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

The new plugins to use.

oldPlugins : Ext.plugin.Abstract[]

The existing plugins in use.

Ext.mixin.Bindable
view source

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

Transforms a Session config to a proper instance.

Available since: 5.0.0

### Parameters

session : Object

### Returns

:Ext.data.Session
Ext.Widget
view source

## applyStyle ( style , oldStyle )
protected pro

### Parameters

style : Object

oldStyle : Object

Ext.Component
view source

## applyTpl ( tpl )
private pri

### Parameters

tpl : Object

Ext.mixin.Bindable
view source

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

Transforms a ViewModel config to a proper instance.

Available since: 5.0.0

### Parameters

viewModel : String / Object / Ext.app.ViewModel

### Returns

:Ext.app.ViewModel
Ext.Component
view source

## beforeInitialize
private pri

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.Component
view source

## center : Ext.Component
chainable ch

Center this floated Component in its parent.

### Returns

:Ext.Component

this

Ext.mixin.ComponentDelegation
view source

## clearDelegatedListeners
private pri

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

Ext.mixin.Observable
view source

## clearListeners

Removes all listeners for this object including the managed listeners

Ext.mixin.Observable
view source

## clearManagedListeners

Removes all managed listeners for this object.

Ext.Component
view source

## constructor ( config )

Creates new Component.

### Parameters

config : Object

The standard configuration object.

Ext.mixin.Pluggable
view source

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

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

### Parameters

config : String / Object / Ext.plugin.Abstract

The plugin type, config object or instance.

### Returns

:Ext.plugin.Abstract
Ext.mixin.Observable
view source

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

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

### Parameters

newName : String

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

beginEnd : Array (optional)

The caller can specify on which indices to slice.

### Returns

:Function
Ext.Widget
view source

## destroy

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

Ext.mixin.Pluggable
view source

## destroyPlugin ( plugin ) : Ext.plugin.Abstract

Removes and destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

### Parameters

plugin : String / Ext.plugin.Abstract

The plugin or its `id` to remove.

### Returns

:Ext.plugin.Abstract

plugin instance or `null` if not found.

Ext.Component
view source

## disable

Disables this Component

Ext.Widget
view source

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

### Parameters

name : Object

fn : Object

scope : Object

options : Object

order : Object

caller : Object

manager : Object

Ext.Component
view source

## doDestroy

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

If the Component is currently added to a Container it will first be removed from that Container. All Ext.Element references are also deleted and the Component is de-registered from Ext.ComponentManager.

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

Available since: 6.2.0

Ext.mixin.ComponentDelegation
view source

## doFireDelegatedEvent ( eventName , args )
private pri

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

### Parameters

eventName : Object

args : Object

Ext.mixin.Observable
view source

## doFireEvent ( eventName , args , bubbles )
private pri

Continue to fire event.

### Parameters

eventName : String

args : Array

bubbles : Boolean

Ext.field.Field
view source

## doInitValue
private pri

Ext.Decorator
view source

## doSetComponent ( component )
private pri

### Parameters

component : Object

Ext.Decorator
view source

## doUnsetComponent ( component )
private pri

### Parameters

component : Object

Ext.Component
view source

## enable

Enables this Component

Ext.mixin.Observable
view source

## enableBubble ( eventNames )

Enables events fired by this Observable to bubble up an owner hierarchy by calling `this.getBubbleTarget()` if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component#getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Sample Code

    Ext.define('Ext.overrides.form.field.Base', {
        override: 'Ext.form.field.Base',

        //  Add functionality to Field's initComponent to enable the change event to bubble
        initComponent: function () {
            this.callParent();
            this.enableBubble('change');
        }
    });

    var myForm = Ext.create('Ext.form.Panel', {
        title: 'User Details',
        items: [{
            ...
        }],
        listeners: {
            change: function() {
                // Title goes red if form has been modified.
                myForm.header.setStyle('color', 'red');
            }
        }
    });

### Parameters

eventNames : String / String[]

The event name to bubble, or an Array of event names.

Ext.mixin.Pluggable
view source

## findPlugin ( type ) : Ext.plugin.Abstract

Retrieves plugin by its `type` alias. For example:

Sample Code

     var list = Ext.create({
         xtype: 'list',
         itemTpl: '<div class="item">{title}</div>',
         store: 'Items',

         plugins: ['listpaging', 'pullrefresh']
     });

     list.findPlugin('pullrefresh').setPullRefreshText('Pull to refresh...');

Note: See also getPlugin.

Available since: 6.2.0

### Parameters

type : String

The Plugin's `type` as specified by the class's alias configuration.

### Returns

:Ext.plugin.Abstract

plugin instance or `null` if not found.

Ext.mixin.Observable
view source

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

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

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

### Parameters

eventName : String

The name of the event to fire.

args : Array

Arguments to pass to handlers and to the action function.

fn : Function

The action function.

scope : Object (optional)

The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options : Object (optional)

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

order : String (optional)

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

Defaults to: 'before'

Deprecated: 5.5
Use {@link #method!fireEventedAction #fireEventedAction} instead.

Ext.mixin.Observable
view source

## fireEvent ( eventName , args ) : Boolean

Fires the specified event with the passed parameters (minus the event name, plus the `options` object passed to addListener).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

### Parameters

eventName : String

The name of the event to fire.

args : Object...

Variable number of parameters are passed to handlers.

### Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

Ext.mixin.Observable
view source

## fireEventArgs ( eventName , args ) : Boolean

Fires the specified event with the passed parameter list.

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component#getBubbleTarget) by calling enableBubble.

### Parameters

eventName : String

The name of the event to fire.

args : Object[]

An array of parameters which are passed to handlers.

### Returns

:Boolean

returns false if any of the handlers return false otherwise it returns true.

Ext.mixin.Observable
view source

## fireEventedAction ( eventName , args , fn , [scope] , [fnArgs] )

Fires the specified event with the passed parameters and executes a function (action). Evented Actions will automatically dispatch a 'before' event passing. This event will be given a special controller that allows for pausing/resuming of the event flow.

By pausing the controller the updater and events will not run until resumed. Pausing, however, will not stop the processing of any other before events.

### Parameters

eventName : String

The name of the event to fire.

args : Array

Arguments to pass to handlers and to the action function.

fn : Function / String

The action function.

scope : Object (optional)

The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

fnArgs : Array / Boolean (optional)

Optional arguments for the action `fn`. If not given, the normal `args` will be used to call `fn`. If `false` is passed, the `args` are used but if the first argument is this instance it will be removed from the args passed to the action function.

Ext.mixin.Inheritable
view source

## fixReference
private pri

Sets up a reference on our current reference holder.

Ext.mixin.Observable
view source

## getBubbleParent : Ext.util.Observable
private pri

Gets the bubbling parent for an Observable

### Returns

:Ext.util.Observable

The bubble parent. null is returned if no bubble target exists

Ext.Widget
view source

## getClassCls
private pri

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.

## getController

see: controller
Ext.Base
view source

## getCurrentConfig
private pri

Ext.Widget
view source

## getElementConfig : Object
protected pro

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

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

### Returns

:Object

the element config object

Ext.Component
view source

## getFloatedStack ( selector )

Returns the stack of floated components in which this Component resides. This Component and all siblings at this level are returned.

### Parameters

selector : String / Function

A ComponentQuery selector, or a selection function which returns `true` to select a component.

Ext.mixin.Identifiable
view source

## getId : String

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

### Returns

:String

id

Ext.mixin.Inheritable
view source

## getInherited ( [inner] ) : Object

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

Available since: 5.0.0

### Parameters

inner : Boolean (optional)

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

Defaults to: false

### Returns

:Object

The `inheritedState` object containing inherited properties.

Ext.mixin.Inheritable
view source

## getInheritedConfig ( property , [skipThis] ) : Mixed

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

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

Available since: 5.0.0

### Parameters

property : String

The name of the config property to return.

skipThis : Boolean (optional)

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

Defaults to: false

### Returns

:Mixed

The value of the requested `property`.

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.mixin.Pluggable
view source

## getPlugin ( id ) : Ext.plugin.Abstract

Retrieves a plugin by its `id`.

Sample Code

     var list = Ext.create({
         xtype: 'list',
         itemTpl: '<div class="item">{title}</div>',
         store: 'Items',

         plugins: {
             xclass: 'Ext.plugin.PullRefresh',
             id: 'foo'
         }
     });

     list.getPlugin('foo').setPullRefreshText('Pull to refresh...');

Note: See also findPlugin.

Available since: 6.2.0

### Parameters

id : String

The `id` of the plugin.

### Returns

:Ext.plugin.Abstract

plugin instance or `null` if not found.

Ext.mixin.Inheritable
view source

## getRefOwner
protected pro

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

By default this returns the Container which contains this Component.

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

Ext.Widget
view source

## getSize : Object< / a>

Returns the height and width of the Component.

### Returns

:Object< / a>

The current height and width of the Component.

width : Number

height : Number

## getValues

see: values
Ext.Component
view source

## getXTypes : String

Returns this Component's xtype hierarchy as a slash-delimited string. For a list of all available xtypes, see the Ext.Component header.

Note: If using your own subclasses, be aware that a Component must register its own xtype to participate in determination of inherited xtypes.

Example usage:

Sample Code

    var t = new Ext.field.Text();
    alert(t.getXTypes());  // alerts 'component/field/textfield'

### Returns

:String

The xtype hierarchy string.

Ext.Base
view source

## hasConfig ( config )
private pri

### Parameters

config : Object

Ext.mixin.Observable
view source

## hasListener ( eventName ) : Boolean

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

### Parameters

eventName : String

The name of the event to check for

### Returns

:Boolean

`true` if the event is being listened for or bubbles, else `false`

Ext.Component
view source

## hide ( [animation] ) : Ext.Component
chainable ch

Hides this Component optionally using an animation.

### Parameters

animation : Object / Boolean (optional)

You can specify an animation here or a bool to use the hideAnimation config.

### Returns

:Ext.Component
Ext.mixin.Bindable
view source

## initBindable
private pri

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

Available since: 5.0.0

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.Widget
view source

## initElement
protected pro

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

Ext.Widget
view source

## initElementListeners ( elementConfig )
private pri

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

Sample Code

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

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

This method is invoked with the prototype object as the scope

### Parameters

elementConfig : Object

Ext.field.Slider
view source

## initialize
private pri

Ext.mixin.Inheritable
view source

## initInheritedState ( inheritedState , [inheritedStateInner] )
protected pro

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

Available since: 5.0.0

### Parameters

inheritedState : Object

The state object for this instance.

inheritedStateInner : Object (optional)

This object is only provided for containers.

Ext.mixin.Keyboard
view source

## initKeyMap
protected pro

This method should be called when the instance is ready to start listening for keyboard events. This is called automatically for Ext.Component and derived classes. In Classic Toolkit, this is done after the component is rendered.

Ext.mixin.Inheritable
view source

## invalidateInheritedState
private pri

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

Available since: 5.0.0

Ext.Widget
view source

## is ( selector ) : Boolean

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

### Parameters

selector : String

The selector string to test against.

### Returns

:Boolean

`true` if this Widget matches the selector.

Ext.Component
view source

## isCentered : Boolean
private pri

### Returns

:Boolean
Ext.field.Field
view source

## isDirty : Boolean

Returns `true` if the value of this Field has been changed from its originalValue. Will return `false` if the field is disabled or has not been rendered yet.

### Returns

:Boolean

`true` if this field has been changed from its original value (and is not disabled), `false` otherwise.

Ext.Component
view source

## isDisabled : Boolean

Returns `true` if this Component is currently disabled.

### Returns

:Boolean

`true` if currently disabled.

Ext.Widget
view source

## isHidden ( [deep] ) : Boolean

Returns `true` if this Component is currently hidden.

### Parameters

deep : Boolean (optional)

`true` to check if this component is hidden because a parent container is hidden.

Defaults to: false

### Returns

:Boolean

`true` if currently hidden.

Ext.Component
view source

## isPainted
private pri

Ext.Component
view source

## isRendered
private pri

Ext.mixin.Observable
view source

## isSuspended ( [event] ) : Boolean

Checks if all events, or a specific event, is suspended.

### Parameters

event : String (optional)

The name of the specific event to check

### Returns

:Boolean

`true` if events are suspended

Ext.mixin.Bindable
view source

## isSyncing ( name ) : Boolean
private pri

Checks if a particular binding is synchronizing the value.

### Parameters

name : String

The name of the property being bound to.

### Returns

:Boolean

`true` if the binding is syncing.

Ext.Widget
view source

## isVisible ( [deep] ) : Boolean

Returns `true` if this Component is currently visible.

### Parameters

deep : Boolean (optional)

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

Defaults to: false

### Returns

:Boolean

`true` if currently visible.

Ext.Widget
view source

## isXType ( xtype , [shallow] ) : Boolean

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

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

Example usage:

Sample Code

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

### Parameters

xtype : String

The xtype to check for this Component.

shallow : Boolean (optional)

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

### Returns

:Boolean

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

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.mixin.Bindable
view source

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

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

Available since: 5.0.1

### Parameters

skipThis : Boolean (optional)

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

Defaults to: false

### Returns

:Ext.app.ViewController

The controller. `null` if no controller is found.

Ext.mixin.Inheritable
view source

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

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

Available since: 5.0.0

### Parameters

skipThis : Boolean (optional)

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

Defaults to: true

### Returns

:Ext.app.ViewController / Ext.Container

The reference holder.

Ext.mixin.Bindable
view source

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

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

Available since: 5.0.0

### Parameters

skipThis : Boolean (optional)

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

Defaults to: false

### Returns

:Ext.data.Session
Ext.Widget
view source

## lookupTpl ( name ) : Ext.XTemplate

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

Available since: 6.2.0

### Parameters

name : String

The name of the property that holds the template.

### Returns

:Ext.XTemplate

The template, `null` if not found.

Ext.mixin.Bindable
view source

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

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

Available since: 5.0.0

### Parameters

skipThis : Boolean (optional)

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

Defaults to: false

### Returns

:Ext.app.ViewModel
Ext.mixin.Bindable
view source

## makeBindableUpdater ( cfg ) : Function
private pri

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

Available since: 5.0.0

### Parameters

cfg : Ext.Config

### Returns

:Function

The updater function.

Ext.mixin.Observable
view source

## mon ( item , ename , [fn] , [scope] , [options] ) : Object

Shorthand for addManagedListener. The addManagedListener method is used when some object (call it "A") is listening to an event on another observable object ("B") and you want to remove that listener from "B" when "A" is destroyed. This is not an issue when "B" is destroyed because all of its listeners will be removed at that time.

Example:

Sample Code

    Ext.define('Foo', {
        extend: 'Ext.Component',

        initComponent: function () {
            this.addManagedListener(MyApp.SomeGlobalSharedMenu, 'show', this.doSomething);
            this.callParent();
        }
    });

As you can see, when an instance of Foo is destroyed, it ensures that the 'show' listener on the menu (`MyApp.SomeGlobalSharedMenu`) is also removed.

As of version 5.1 it is no longer necessary to use this method in most cases because listeners are automatically managed if the scope object provided to addListener is an Observable instance. However, if the observable instance and scope are not the same object you still need to use mon or addManagedListener if you want the listener to be managed.

### Parameters

item : Ext.util.Observable / Ext.dom.Element

The item to which to add a listener/listeners.

ename : Object / String

The event name, or an object containing event name properties.

fn : Function / String (optional)

If the `ename` parameter was an event name, this is the handler function or the name of a method on the specified `scope`.

scope : Object (optional)

If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

options : Object (optional)

If the `ename` parameter was an event name, this is the addListener options.

### Returns

:Object

Only when the `destroyable` option is specified.

A `Destroyable` object. An object which implements the `destroy` method which removes all listeners added in this call. For example:

Sample Code

    this.btnListeners = myButton.mon({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });

And when those listeners need to be removed:

Sample Code

    Ext.destroy(this.btnListeners);

or

Sample Code

    this.btnListeners.destroy();

Ext.mixin.Observable
view source

## mun ( item , ename , [fn] , [scope] )

Shorthand for removeManagedListener. Removes listeners that were added by the mon method.

### Parameters

item : Ext.util.Observable / Ext.dom.Element

The item from which to remove a listener/listeners.

ename : Object / String

The event name, or an object containing event name properties.

fn : Function (optional)

If the `ename` parameter was an event name, this is the handler function.

scope : Object (optional)

If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

Ext.mixin.Observable
view source

## on ( eventName , [fn] , [scope] , [options] , [order] ) : Object

The on method is shorthand for addListener.

Appends an event handler to this object. For example:

Sample Code

    myGridPanel.on("itemclick", this.onItemClick, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

Sample Code

    myGridPanel.on({
        cellclick: this.onCellClick,
        select: this.onSelect,
        viewready: this.onViewReady,
        scope: this // Important. Ensure "this" is correct during handler execution
    });

One can also specify options for each event handler separately:

Sample Code

    myGridPanel.on({
        cellclick: {fn: this.onCellClick, scope: this, single: true},
        viewready: {fn: panel.onViewReady, scope: panel}
    });

Names of methods in a specified scope may also be used:

Sample Code

    myGridPanel.on({
        cellclick: {fn: 'onCellClick', scope: this, single: true},
        viewready: {fn: 'onViewReady', scope: panel}
    });

### Parameters

eventName : String / Object

The name of the event to listen for. May also be an object who's property names are event names.

fn : Function / String (optional)

The method the event invokes or the name of the method within the specified `scope`. Will be called with arguments given to Ext.util.Observable#fireEvent plus the `options` parameter described below.

scope : Object (optional)

The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

options : Object< / a> (optional)

An object containing handler configuration.

Note: The options object will also be passed as the last argument to every event handler.

This object may contain any of the following properties:

scope : Object

The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

delay : Number

The number of milliseconds to delay the invocation of the handler after the event fires.

single : Boolean

True to add a handler to handle just the next firing of the event, and then remove itself.

buffer : Number

Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

onFrame : Number

Causes the handler to be scheduled to run at the next animation frame event. If the event fires again before that time, the handler is not rescheduled - the handler will only be called once when the next animation frame is fired, with the last set of arguments passed.

target : Ext.util.Observable

Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

element : String

This option is only valid for listeners bound to Ext.Component. The name of a Component property which references an Ext.dom.Element to add a listener to.

This option is useful during Component construction to add DOM event listeners to elements of Ext.Component which will exist only after the Component is rendered.

For example, to add a click listener to a Panel's body:

Sample Code

      var panel = new Ext.panel.Panel({
                                  title: 'The title',
                                  listeners: {
                                      click: this.handlePanelClick,
                                      element: 'body'
                                  }
                              });

In order to remove listeners attached using the element, you'll need to reference the element itself as seen below.

Sample Code

     panel.body.un(...)

delegate : String (optional)

A simple selector to filter the event target or look for a descendant of the target.

The "delegate" option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

See the delegate example below.

capture : Boolean (optional)

When set to `true`, the listener is fired in the capture phase of the event propagation sequence, instead of the default bubble phase.

The capture option is only available on Ext.dom.Element instances (or when attaching a listener to a Ext.dom.Element via a Component using the element option).

stopPropagation : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call stopPropagation on the event object before firing the handler.

preventDefault : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call preventDefault on the event object before firing the handler.

stopEvent : Boolean (optional)

This option is only valid for listeners bound to Ext.dom.Element. `true` to call stopEvent on the event object before firing the handler.

args : Array (optional)

Optional arguments to pass to the handler function. Any additional arguments passed to fireEvent will be appended to these arguments.

destroyable : Boolean (optional)

When specified as `true`, the function returns a `destroyable` object. An object which implements the `destroy` method which removes all listeners added in this call. This syntax can be a helpful shortcut to using un; particularly when removing multiple listeners. NOTE - not compatible when using the element option. See un for the proper syntax for removing listeners added using the element config.

Defaults to: false

priority : Number (optional)

An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handlers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code. A priority must be an integer to be valid. Fractional values are reserved for internal framework use.

order : String (optional)

A legacy option that is provided for backward compatibility. It is recommended to use the `priority` option instead. Available options are:

- `'before'`: equal to a priority of `100`
- `'current'`: equal to a priority of `0` or default priority
- `'after'`: equal to a priority of `-100`

Defaults to: 'current'

order : String (optional)

A shortcut for the `order` event option. Provided for backward compatibility. Please use the `priority` event option instead.

Combining Options

Using the options argument, it is possible to combine different types of listeners:

A delayed, one-time listener.

Sample Code

    myPanel.on('hide', this.handleClick, this, {
        single: true,
        delay: 100
    });

Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers and handler configs.

Sample Code

    grid.on({
        itemclick: 'onItemClick',
        itemcontextmenu: grid.onItemContextmenu,
        destroy: {
            fn: function () {
                // function called within the 'altCmp' scope instead of grid
            },
            scope: altCmp // unique scope for the destroy handler
        },
        scope: grid       // default scope - provided for example clarity
    });

Delegate

This is a configuration option that you can pass along when registering a handler for an event to assist with event delegation. By setting this configuration option to a simple selector, the target element will be filtered to look for a descendant of the target. For example:

Sample Code

    var panel = Ext.create({
        xtype: 'panel',
        renderTo: document.body,
        title: 'Delegate Handler Example',
        frame: true,
        height: 220,
        width: 220,
        html: '<h1 class="myTitle">BODY TITLE</h1>Body content'
    });

    // The click handler will only be called when the click occurs on the
    // delegate: h1.myTitle ("h1" tag with class "myTitle")
    panel.on({
        click: function (e) {
            console.log(e.getTarget().innerHTML);
        },
        element: 'body',
        delegate: 'h1.myTitle'
     });

Defaults to: 'current'

### Returns

:Object

Only when the `destroyable` option is specified.

A `Destroyable` object. An object which implements the `destroy` method which removes all listeners added in this call. For example:

Sample Code

    this.btnListeners =  = myButton.on({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });

And when those listeners need to be removed:

Sample Code

    Ext.destroy(this.btnListeners);

or

Sample Code

    this.btnListeners.destroy();

Ext.mixin.Observable
view source

## onAfter ( eventName , fn , [scope] , [options] )

Appends an after-event handler.

Same as addListener with `order` set to `'after'`.

### Parameters

eventName : String / String[] / Object

The name of the event to listen for.

fn : Function / String

The method the event invokes.

scope : Object (optional)

The scope for `fn`.

options : Object (optional)

An object containing handler configuration.

Ext.mixin.Observable
view source

## onBefore ( eventName , fn , [scope] , [options] )

Appends a before-event handler. Returning `false` from the handler will stop the event.

Same as addListener with `order` set to `'before'`.

### Parameters

eventName : String / String[] / Object

The name of the event to listen for.

fn : Function / String

The method the event invokes.

scope : Object (optional)

The scope for `fn`.

options : Object (optional)

An object containing handler configuration.

Ext.mixin.Inheritable
view source

## onInheritedAdd ( instanced )
private pri

Called when this Inheritable is added to a parent

### Parameters

instanced : Boolean

Ext.mixin.Inheritable
view source

## onInheritedRemove ( destroying )
private pri

Called when this inheritable is removed from a parent

### Parameters

destroying : Boolean

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

Ext.Component
view source

## onInitialized ( fn , scope , args )
private pri

### Parameters

fn : Object

scope : Object

args : Object

Ext.Component
view source

## onScrollEnd ( x , y )
template tpl protected pro

Invoked when a scroll operation is completed via this component's scroller.

### Parameters

x : Number

The current x position

y : Number

The current y position

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Ext.Component
view source

## onScrollMove ( x , y )
template tpl protected pro

Invoked when this component is scrolled via its scroller.

### Parameters

x : Number

The current x position

y : Number

The current y position

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Ext.Component
view source

## onScrollStart ( x , y )
template tpl protected pro

Invoked when a scroll is initiated on this component via its scroller.

### Parameters

x : Number

The current x position

y : Number

The current y position

This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

Ext.Component
view source

## onShowByErased ( component )
private pri

### Parameters

component : Ext.Component

Ext.Widget
view source

## processElementConfig : Object
private pri

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

### Returns

:Object
Ext.mixin.Bindable
view source

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

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

This method is called only by component authors.

Available since: 5.0.0

### Parameters

property : String (optional)

The name of the property to update.

value : Object (optional)

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

Ext.mixin.Observable
view source

## relayEvents ( origin , events , [prefix] ) : Object

Relays selected events from the specified Observable as if the events were fired by `this`.

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

Sample Code

    this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword (unless the event is handled by a controller's control/listen event listener in which case 'this' will be the controller rather than the grid).

### Parameters

origin : Object

The Observable whose events this object is to relay.

events : String[] / Object

Array of event names to relay or an Object with key/value pairs translating to ActualEventName/NewEventName respectively. For example: this.relayEvents(this, {add:'push', remove:'pop'});

Would now redispatch the add event of this as a push event and the remove event as a pop event.

prefix : String (optional)

A common prefix to prepend to the event names. For example:

Sample Code

    this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

### Returns

:Object

A `Destroyable` object. An object which implements the `destroy` method which, when destroyed, removes all relayers. For example:

Sample Code

    this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');

Can be undone by calling

Sample Code

    Ext.destroy(this.storeRelayers);

or this.store.relayers.destroy();

Ext.mixin.Observable
view source

## removeAfterListener

Alias for unAfter.

Ext.mixin.Observable
view source

## removeBeforeListener

Alias for unBefore.

Ext.Component
view source

## removeCls ( cls , [prefix] , [suffix] )

Removes the given CSS class(es) from this Component's rendered element.

### Parameters

cls : String

The class(es) to remove.

prefix : String (optional)

Optional prefix to prepend before each class.

Defaults to: ""

suffix : String (optional)

Optional suffix to append to each class.

Defaults to: ""

Ext.mixin.ComponentDelegation
view source

## removeDelegatedListener ( eventName , fn , scope )
private pri

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

### Parameters

eventName : Object

fn : Object

scope : Object

Ext.mixin.Observable
view source

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

Removes an event handler.

### Parameters

eventName : String

The type of event the handler was associated with.

fn : Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope : Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener `destroyable: true` config option in place of calling un(). For example:

Sample Code

    var listeners = cmp.on({
        scope: cmp,
        afterrender: cmp.onAfterrender,
        beforehide: cmp.onBeforeHide,
        destroyable: true
    });

    // Remove listeners
    listeners.destroy();
    // or
    cmp.un(
        scope: cmp,
        afterrender: cmp.onAfterrender,
        beforehide: cmp.onBeforeHide
    );

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

Sample Code

    panel.on({
        element: 'body',
        click: 'onBodyCLick'
    });

    panel.body.un({
        click: 'onBodyCLick'
    });

Ext.mixin.Observable
view source

## removeManagedListener ( item , ename , [fn] , [scope] )

Removes listeners that were added by the mon method.

### Parameters

item : Ext.util.Observable / Ext.dom.Element

The item from which to remove a listener/listeners.

ename : Object / String

The event name, or an object containing event name properties.

fn : Function (optional)

If the `ename` parameter was an event name, this is the handler function.

scope : Object (optional)

If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

Ext.mixin.Observable
view source

## removeManagedListenerItem ( isClear , managedListener )
private pri

Remove a single managed listener item

### Parameters

isClear : Boolean

True if this is being called during a clear

managedListener : Object

The managed listener item See removeManagedListener for other args

Ext.mixin.Pluggable
view source

## removePlugin ( plugin , [destroy] ) : Ext.plugin.Abstract

Removes and (optionally) destroys a plugin.

Note: Not all plugins are designed to be removable. Consult the documentation for the specific plugin in question to be sure.

Available since: 6.2.0

### Parameters

plugin : String / Ext.plugin.Abstract

The plugin or its `id` to remove.

destroy : Boolean (optional)

Pass `true` to not call `destroy()` on the plugin.

### Returns

:Ext.plugin.Abstract

plugin instance or `null` if not found.

Ext.Component
view source

## replaceCls ( oldCls , newCls , [prefix] , [suffix] )

Replaces specified classes with the newly specified classes. It uses the addCls and removeCls methods, so if the class(es) you are removing don't exist, it will still add the new classes.

### Parameters

oldCls : String

The class(es) to remove.

newCls : String

The class(es) to add.

prefix : String (optional)

Optional prefix to prepend before each class.

Defaults to: ""

suffix : String (optional)

Optional suffix to append to each class.

Defaults to: ""

Ext.field.Field
view source

## reset : Ext.field.Field
chainable ch

Resets the current field value back to the original value on this field when it was created.

Sample Code

    // This will create a field with an original value
    var field = Ext.Viewport.add({
        xtype: 'textfield',
        value: 'first value'
    });

    // Update the value
    field.setValue('new value');

    // Now you can reset it back to the `first value`
    field.reset();

### Returns

:Ext.field.Field

this

Ext.Component
view source

## resetFloating
deprecated dep

Resets top, right, bottom and left configurations to `null`, which will cause this component to stop being 'positioned' and to take its place in its owning container's layout.

Deprecated: 6.2
Use {@link #method!resetPositioned #resetPositioned} instead.

Ext.field.Field
view source

## resetOriginalValue

Resets the field's originalValue property so it matches the current value. This is called by Ext.form.Panel.setValues if the form's trackResetOnLoad property is set to true.

Ext.Component
view source

## resetPositioned

Resets top, right, bottom and left configurations to `null`, which will cause this component to stop being 'positioned' and to take its place in its owning container's layout.

Ext.mixin.Observable
view source

## resolveListenerScope ( [defaultScope] ) : Object
protected pro

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

### Parameters

defaultScope : Object (optional)

The default scope to return if none is found.

Defaults to: this

### Returns

:Object

The default event scope

Ext.mixin.Inheritable
view source

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

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

Available since: 5.1.1

### Parameters

satellite : Ext.mixin.Observable

defaultScope : Object (optional)

### Returns

:Object

The listener scope

Ext.mixin.Observable
view source

## resumeEvent ( eventName )

Resumes firing of the named event(s).

After calling this method to resume events, the events will fire when requested to fire.

Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

### Parameters

eventName : String...

Multiple event names to resume.

Ext.mixin.Observable
view source

## resumeEvents ( [discardQueue] )

Resumes firing events (see suspendEvents).

If events were suspended using the `queueSuspended` parameter, then all events fired during event suspension will be sent to any listeners now.

### Parameters

discardQueue : Boolean (optional)

`true` to prevent any previously queued events from firing while we were suspended. See suspendEvents.

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

## setDisabled
private

see: disabled

## setListeners

see: listeners
Ext.Decorator
view source

## setRendered ( rendered )
private pri

### Parameters

rendered : Object

Ext.Widget
view source

## setSize ( width , height )

Sets the size of the Component.

### Parameters

width : Number

The new width for the Component.

height : Number

The new height for the Component.

## setValues

see: values
Ext.Component
view source

## setVisibility ( isVisible )
private pri

### Parameters

isVisible : Object

Ext.Component
view source

## show ( [animation] ) : Ext.Component
chainable ch

Shows this component optionally using an animation.

### Parameters

animation : Object / Boolean (optional)

You can specify an animation here or a bool to use the showAnimation config.

### Returns

:Ext.Component
Ext.Component
view source

## showBy ( component , [alignment] , [options] )

Shows this component by another component. If you specify no alignment, it will automatically position this component relative to the reference component.

For example, say we are aligning a Panel next to a Button, the alignment string would look like this:

Sample Code

    [panel-vertical (t/b/c)][panel-horizontal (l/r/c)]-[button-vertical (t/b/c)][button-horizontal (l/r/c)]

where t = top, b = bottom, c = center, l = left, r = right.

## Examples

- `tl-tr` means top-left corner of the Panel to the top-right corner of the Button
- `tc-bc` means top-center of the Panel to the bottom-center of the Button

You can put a '?' at the end of the alignment string to constrain the positioned element to the Ext.Viewport

Sample Code

    // show `panel` by `button` using the default positioning (auto fit)
    panel.showBy(button);

    // align the top left corner of `panel` with the top right corner of `button` (constrained to viewport)
    panel.showBy(button, "tl-tr?");

    // align the bottom right corner of `panel` with the center left edge of `button` (not constrained by viewport)
    panel.showBy(button, "br-cl");

### Parameters

component : Ext.Component

The target component to show this component by.

alignment : String (optional)

The specific alignment.

options : Object (optional)

An object containing options for the Ext.util.Region#alignTo method.

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.mixin.Observable
view source

## suspendEvent ( eventName )

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

### Parameters

eventName : String...

Multiple event names to suspend.

Ext.mixin.Observable
view source

## suspendEvents ( queueSuspended )

Suspends the firing of all events. (see resumeEvents)

### Parameters

queueSuspended : Boolean

`true` to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events.

Ext.Component
view source

## toggleCls ( className , [state] )
chainable ch

Add or removes a class based on if the class is already added to the Component.

### Parameters

className : String

The class to toggle.

state : Boolean (optional)

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

Ext.Component
view source

## triggerInitialized
private pri

Ext.mixin.Observable
view source

## un ( eventName , fn , [scope] )

Shorthand for removeListener. Removes an event handler.

### Parameters

eventName : String

The type of event the handler was associated with.

fn : Function

The handler to remove. This must be a reference to the function passed into the addListener call.

scope : Object (optional)

The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable#addListener or the listener will not be removed.

Convenience Syntax

You can use the addListener `destroyable: true` config option in place of calling un(). For example:

Sample Code

    var listeners = cmp.on({
        scope: cmp,
        afterrender: cmp.onAfterrender,
        beforehide: cmp.onBeforeHide,
        destroyable: true
    });

    // Remove listeners
    listeners.destroy();
    // or
    cmp.un(
        scope: cmp,
        afterrender: cmp.onAfterrender,
        beforehide: cmp.onBeforeHide
    );

Exception - DOM event handlers using the element config option

You must go directly through the element to detach an event handler attached using the addListener element option.

Sample Code

    panel.on({
        element: 'body',
        click: 'onBodyCLick'
    });

    panel.body.un({
        click: 'onBodyCLick'
    });

Ext.mixin.Observable
view source

## unAfter ( eventName , fn , [scope] , [options] )

Removes a before-event handler.

Same as removeListener with `order` set to `'after'`.

### Parameters

eventName : String / String[] / Object

The name of the event the handler was associated with.

fn : Function / String

The handler to remove.

scope : Object (optional)

The scope originally specified for `fn`.

options : Object (optional)

Extra options object.

Ext.mixin.Observable
view source

## unBefore ( eventName , fn , [scope] , [options] )

Removes a before-event handler.

Same as removeListener with `order` set to `'before'`.

### Parameters

eventName : String / String[] / Object

The name of the event the handler was associated with.

fn : Function / String

The handler to remove.

scope : Object (optional)

The scope originally specified for `fn`.

options : Object (optional)

Extra options object.

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.Widget
view source

## up ( [selector] , [limit] ) : Ext.Container

Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.

Example:

Sample Code

    var owningTabPanel = grid.up('tabpanel');

### Parameters

selector : String (optional)

The simple selector to test.

limit : String / Number / Ext.Component (optional)

This may be a selector upon which to stop the upward scan, or a limit of the number of steps, or Component reference to stop on.

### Returns

:Ext.Container

The matching ancestor Container (or `undefined` if no match was found).

Ext.Widget
view source

## updateCls ( newCls , oldCls )
private pri

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

### Parameters

newCls : Object

oldCls : Object

Ext.field.Slider
view source

## updateComponent ( component , oldComponent )
private pri

### Parameters

component : Object

oldComponent : Object

Ext.Component
view source

## updateData ( newData )
private pri

### Parameters

newData : Object

Ext.Widget
view source

## updateHeight ( height )
protected pro

### Parameters

height : Object

Ext.field.Field
view source

## updateLabel ( newLabel , oldLabel )
private pri

### Parameters

newLabel : Object

oldLabel : Object

Ext.field.Field
view source

## updateLabelAlign ( newLabelAlign , oldLabelAlign )
private pri

### Parameters

newLabelAlign : Object

oldLabelAlign : Object

Ext.field.Field
view source

## updateLabelCls ( newLabelCls , oldLabelCls )
private pri

### Parameters

newLabelCls : Object

oldLabelCls : Object

Ext.field.Field
view source

## updateLabelWidth ( newLabelWidth )
private pri

### Parameters

newLabelWidth : Object

Ext.field.Field
view source

## updateLabelWrap ( newLabelWrap , oldLabelWrap )
private pri

### Parameters

newLabelWrap : Object

oldLabelWrap : Object

Ext.field.Field
view source

## updateRequired ( newRequired )
private pri

Updates the required configuration.

### Parameters

newRequired : Object

Ext.mixin.Bindable
view source

## updateSession ( session )
private pri

Updates the session config.

### Parameters

session : Ext.data.Session

Ext.Widget
view source

## updateStyle ( style )
protected pro

### Parameters

style : Object

Ext.Component
view source

## updateStyleHtmlCls ( newHtmlCls , oldHtmlCls )

Updates the styleHtmlCls configuration

### Parameters

newHtmlCls : Object

oldHtmlCls : Object

Ext.mixin.Bindable
view source

## updateViewModel ( viewModel , oldViewModel )
private pri

Updates the viewModel config.

### Parameters

viewModel : Ext.app.ViewModel

oldViewModel : Ext.app.ViewModel

Ext.Widget
view source

## updateWidth ( width )
protected pro

### Parameters

width : Object

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

## events

Ext.Component
view source

## added ( this , container , index , eOpts )

Fires after a Component had been added to a Container.

### Parameters

this : Ext.Component

container : Ext.Container

Parent Container

index : Number

The index of the item within the Container.

eOpts : Object

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

Ext.Component
view source

## beforehide ( this , eOpts )

Fires before the Component is hidden. Hide may be vetoed by returning `false` from a handler.

### Parameters

this : Ext.Component

The component instance

eOpts : Object

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

Ext.Component
view source

## beforeorientationchange
removed rem

Fires before orientation changes.

This method has been REMOVED since 2.0.0

Ext.Component
view source

## beforeshow ( this , eOpts )

Fires before the Component is shown. Show may be vetoed by returning `false` from a handler.

### Parameters

this : Ext.Component

The component instance

eOpts : Object

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

Ext.field.Slider
view source

## change ( me , newValue , oldValue , eOpts )

Fires when the value changes.

### Parameters

me : Ext.field.Slider

newValue : Number[]

The new value.

oldValue : Number[]

The old value.

eOpts : Object

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

Ext.Component
view source

## destroy

Fires when the component is destroyed

Ext.field.SingleSlider
view source

## drag ( this , sl , thumb , e , eOpts )

Fires when the slider thumb starts a drag operation.

### Parameters

this : Ext.field.Slider

sl : Ext.slider.Slider

Slider Component.

thumb : Ext.slider.Thumb

The thumb being dragged.

e : Ext.event.Event

eOpts : Object

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

Ext.field.SingleSlider
view source

## dragchange ( me , newValue , oldValue , eOpts )

Fires when the value changes.

### Parameters

me : Ext.field.Slider

newValue : Number

The new value.

oldValue : Number

The old value.

eOpts : Object

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

Ext.field.SingleSlider
view source

## dragchange ( me , sl , newValue , oldValue , eOpts )

Fires when the value changes via drag.

### Parameters

me : Ext.field.Slider

sl : Ext.slider.Slider

Slider Component.

newValue : Number

The new value.

oldValue : Number

The old value.

eOpts : Object

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

Ext.field.SingleSlider
view source

## dragend ( this , sl , thumb , value , e , eOpts )

Fires when the slider thumb ends a drag operation.

### Parameters

this : Ext.field.Slider

sl : Ext.slider.Slider

Slider Component.

thumb : Ext.slider.Thumb

The thumb being dragged.

value : Array

The end value.

e : Ext.event.Event

eOpts : Object

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

Ext.field.SingleSlider
view source

## dragstart ( this , sl , thumb , value , e , eOpts )

Fires when the slider thumb starts a drag operation.

### Parameters

this : Ext.field.Slider

sl : Ext.slider.Slider

Slider Component.

thumb : Ext.slider.Thumb

The thumb being dragged.

value : Array

The start value.

e : Ext.event.Event

eOpts : Object

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

Ext.Component
view source

## erased ( this , eOpts )

Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.

### Parameters

this : Ext.Component

The component instance

eOpts : Object

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

Ext.Component
view source

## floatingchange ( this , positioned , eOpts )
deprecated dep

Fires whenever there is a change in the positioned status of a component

### Parameters

this : Ext.Component

The component instance

positioned : Boolean

The component's new positioned state. This becomes `true` is a component is positioned using the top, right, bottom or left configs.

eOpts : Object

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

Deprecated: 6.2.0
Use {@link #event!positionedchange #positionedchange} instead

Ext.Component
view source

## fullscreen ( this , eOpts )

Fires whenever a Component with the fullscreen config is instantiated

### Parameters

this : Ext.Component

The component instance

eOpts : Object

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

Ext.Component
view source

## hide ( this , eOpts )

Fires whenever the Component is hidden

### Parameters

this : Ext.Component

The component instance

eOpts : Object

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

Ext.Component
view source

## initialize ( this , eOpts )

Fires when the component has been initialized

### Parameters

this : Ext.Component

The component instance

eOpts : Object

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

Ext.Component
view source

## moved ( this , container , toIndex , fromIndex , eOpts )

Fires when a component si moved within its Container.

### Parameters

this : Ext.Component

container : Ext.Container

Container which holds the component

toIndex : Number

The new index of the item.

fromIndex : Number

The old index of the item.

eOpts : Object

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

Ext.Component
view source

## orientationchange
removed rem

Fires when orientation changes.

This method has been REMOVED since 2.0.0

Ext.Component
view source

## painted ( element , eOpts )

Fires whenever this Element actually becomes visible (painted) on the screen. This is useful when you need to perform 'read' operations on the DOM element, i.e: calculating natural sizes and positioning.

Note: This event is not available to be used with event delegation. Instead painted only fires if you explicitly add at least one listener to it, for performance reasons.

### Parameters

element : Ext.dom.Element

The component's outer element (this.element)

eOpts : Object

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

Ext.Component
view source

## positionedchange ( this , positioned , eOpts )

Fires whenever there is a change in the positioned status of a component

### Parameters

this : Ext.Component

The component instance

positioned : Boolean

The component's new positioned state. This becomes `true` is a component is positioned using the top, right, bottom or left configs.

eOpts : Object

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

Ext.Component
view source

## removed ( this , container , index , eOpts )

Fires when a component is removed from a Container

### Parameters

this : Ext.Component

container : Ext.Container

Container which holds the component

index : Number

The index of the item that was removed.

eOpts : Object

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

Ext.Component
view source

## resize ( element , eOpts )

Important note: For the best performance on mobile devices, use this only when you absolutely need to monitor a Element's size.

Note: This event is not available to be used with event delegation. Instead resize only fires if you explicitly add at least one listener to it, for performance reasons.

### Parameters

element : Ext.dom.Element

The component's outer element (this.element)

eOpts : Object

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

Ext.Component
view source

## show ( this , eOpts )

Fires whenever the Component is shown

### Parameters

this : Ext.Component

The component instance

eOpts : Object

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

Ext.Component
view source

## updatedata ( this , newData , eOpts )

Fires whenever the data of the component is updated

### Parameters

this : Ext.Component

The component instance

newData : Object

The new data

eOpts : Object

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

## theme variables

Ext.field.Field
view source

## $field-background-color : color

Field background-color

Defaults to: null

Ext.field.Field
view source

## $field-disabled-background-color : color

Field background-color when disabled

Defaults to: null

Ext.field.Field
view source

## $field-disabled-label-background-color : color

Field label background-color when disabled

Defaults to: null

Ext.field.Field
view source

## $field-disabled-label-color : color

Field label text color when disabled

Defaults to: null

Ext.field.Field
view source

## $field-disabled-opacity : Number

Opacity of form fields when disabled

Defaults to: .3

Ext.field.Field
view source

## $field-focused-background-color : color

Field background-color when focused

Defaults to: null

Ext.field.Field
view source

## $field-focused-label-background-color : color

Field label background-color when focused

Defaults to: null

Ext.field.Field
view source

## $field-focused-label-color : color

Field label text color when focused

Defaults to: null

Ext.field.Field
view source

## $field-invalid-background-color : color

Field background-color when invalid

Defaults to: null

Ext.field.Field
view source

## $field-invalid-label-background-color : color

Field label background-color when invalid

Defaults to: null

Ext.field.Field
view source

## $field-invalid-label-color : color

Field label text color when invalid

Defaults to: null

Ext.field.Field
view source

## $field-label-background-color : color

Field label background-color

Defaults to: null

Ext.field.Field
view source

## $field-label-color : color

Field label text color

Defaults to: $color

Ext.field.Field
view source

## $field-label-font-family : String

Field label font-family

Defaults to: $font-family

Ext.field.Field
view source

## $field-label-font-size : Number

Field label font-size

Defaults to: 1rem

Ext.field.Field
view source

## $field-label-font-size-big : Number

Field label font-size in the big sizing scheme

Defaults to: null

Ext.field.Field
view source

## $field-label-font-weight : String / Number

Field label font-weight

Defaults to: $font-weight-bold

Ext.field.Field
view source

## $field-label-line-height : Number

Field label line-height

Defaults to: px-to-em(16px, 13px)

Ext.field.Field
view source

## $field-label-line-height-big : Number

Field label line-height in the big sizing scheme

Defaults to: px-to-em(24px, 15px)

Ext.field.Field
view source

## $field-label-padding : color

Field label padding

Defaults to: px-to-em(3px 6px 3px 0, 13px)

Ext.field.Field
view source

## $field-label-padding-big : color

Field label padding in the big sizing scheme

Defaults to: px-to-em(3px 6px 3px 0, 15px)

Ext.field.Field
view source

## $field-required-indicator-font-family : String

Field required indicator font-family

Defaults to: null

Ext.field.Field
view source

## $field-required-indicator-font-size : Number

Field required indicator font-size

Defaults to: null

Ext.field.Field
view source

## $field-required-indicator-font-weight : String / Number

Field required indicator font-weight

Defaults to: null

Ext.field.Field
view source

## $field-required-indicator-line-height : Number

Field required indicator line-height

Defaults to: null

Ext.field.Field
view source

## $field-required-indicator-margin : Number

Field required indicator margin

Defaults to: -.2em null null .3em

Ext.field.Field
view source

## $field-required-indicator-margin-big : Number

Field required indicator margin in the big sizing scheme

Defaults to: null

Ext.field.Field
view source

## $field-vertical-spacing : Number

Vertical space in between form fields

Defaults to: 0.385em

Ext.field.Field
view source

## $field-vertical-spacing-big : Number

Vertical space in between form fields in the big sizing scheme

Defaults to: 0.534em

Ext.field.Field
view source

## $form-field-bg-color : color

Default background-color for form fields.

Defaults to: #fff

Ext.field.Field
view source

## $form-field-height : measurement

Default height for form fields.

Defaults to: 2.5em

Ext.field.Slider
view source

## $form-slider-size : measurement

Height of the slider "track."

Defaults to: .2em

Ext.field.Slider
view source

## $form-thumb-size : measurement

Default size of "thumbs" for form sliders/toggles.

Defaults to: 2.1em

## theme mixins

Ext.field.Field
view source

## field-ui ( ...list... )

Creates a visual theme for a Field

### Parameters

$ui : String

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

$xtype : String (optional)

The Ext.Class#xtype to use in CSS selectors. For use by UI mixins of derived classes.

Defaults to: field

$background-color : color

Field background-color

$focused-background-color : color

Field background-color when focused

$invalid-background-color : color

Field background-color when invalid

$disabled-background-color : color

Field background-color when disabled

$label-color : color

Field label text color

$focused-label-color : color

Field label text color when focused

$invalid-label-color : color

Field label text color when invalid

$disabled-label-color : color

Field label text color when disabled

$label-background-color : color

Field label background-color

$focused-label-background-color : color

Field label background-color when focused

$invalid-label-background-color : color

Field label background-color when invalid

$disabled-label-background-color : color

Field label background-color when disabled

$label-padding : color

Field label padding

$label-padding-big : color

Field label padding in the big sizing scheme

$label-font-weight : String / Number

Field label font-weight

$label-font-size : Number

Field label font-size

$label-font-size-big : Number

Field label font-size in the big sizing scheme

$label-line-height : Number

Field label line-height

$label-line-height-big : Number

Field label line-height in the big sizing scheme

$label-font-family : String

Field label font-family

$disabled-opacity : Number

Opacity of form fields when disabled

$required-indicator-font-weight : String / Number

Field required indicator font-weight

$required-indicator-font-size : Number

Field required indicator font-size

$required-indicator-line-height : Number

Field required indicator line-height

$required-indicator-font-family : String

Field required indicator font-family

$required-indicator-margin : Number

Field required indicator margin

$required-indicator-margin-big : Number

Field required indicator margin in the big sizing scheme

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