The documentation for the ExtReact product diverges somewhat from the
documentation of other Sencha products. The sections below describe
documentation for all products except where indicated as unique to
ExtReact
.
Many classes have shortcut names used when creating (instantiating) a class with a
configuration object. The shortcut name is referred to as an alias
(or xtype
if the
class extends Ext.Component). The alias/xtype is listed next to the class name of
applicable classes for quick reference.
ExtReact component classes list the configurable name prominently at the top of the API class doc followed by the fully-qualified class name.
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.
ExtReact component classes display
configuration options as props
ExtReact component classes do not list
properties as a dedicated member type, but rather as
read only
props
static
label next to the
method name. *See Static below.Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).
Let's look at each part of the member row:
lookupComponent
in this example)( item )
in this example)Ext.Component
in this case). This may be omitted for methods that do not
return anything other than undefined
or may display as multiple possible values
separated by a forward slash /
signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false
if unsuccessful which would be displayed as
Ext.Component/Boolean
).PROTECTED
in
this example - see the Flags section below)Ext.container.Container
in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source
in the example)item : Object
in the example).undefined
a "Returns" section
will note the type of class or object returned and a description (Ext.Component
in the
example)Available since 3.4.0
- not pictured in
the example) just after the member descriptionDefaults to: false
)The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.
All ExtReact props are bindable
unless decorated as immutable
Immutable ExtReact props may not be use as a configurable prop when instantiating a component
classInstance.method1().method2().etc();
false
is returned from
an event handler- Indicates a framework class
- A singleton framework class. *See the singleton flag for more information
- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)
- Indicates that the class, member, or guide is new in the currently viewed version
- Indicates a class member of type config
Or in the case of an ExtReact component class this
indicates a member of type prop
- Indicates a class member of type property
- Indicates a class member of type
method
- Indicates a class member of type event
- Indicates a class member of type
theme variable
- Indicates a class member of type
theme mixin
- Indicates that the class, member, or guide is new in the currently viewed version
Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.
Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.
ExtReact component classes do not hoist the getter /
setter methods into the prop. All methods will be described in the
Methods
section
Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.
Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.
If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.
Both API docs and guides can be searched for using the search field at the top of the page.
On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.
The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.
Clicking on an empty search field will show your last 10 searches for quick navigation.
Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:
Ext.button.Button
class has an alternate class name of Ext.Button
). Alternate class
names are commonly maintained for backward compatibility.Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.
Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.
Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:
The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.
Ext.panel.Date is a date picker. This class is used to allow browsing and selection of valid dates in a popup, but may also be used with other components.
<ExtDatepanel activeItem="value" />
let element = document.body.querySelector('ExtDatepanel');
element.activeItem = 'value';
let activeItem = element.activeItem;
The item from the items collection that will be active first. This is usually only meaningful in a Ext.layout.Card, where only one item can be active at a time. If passes a string, it will be assumed to be a Ext.ComponentQuery selector.
Defaults to:
0
<ExtDatepanel alwaysOnTop="true" />
let element = document.body.querySelector('ExtDatepanel');
element.alwaysOnTop = true;
let alwaysOnTop = element.alwaysOnTop;
A flag indicating that this component should be above its floated siblings.
This may be a positive number to prioritize the ordering of multiple visible always on top components.
This may be set to a negative number to prioritize a component to the bottom of the z-index stack.
Defaults to:
null
Available since: 6.2.0
<ExtDatepanel anchor="true" />
let element = document.body.querySelector('ExtDatepanel');
element.anchor = true;
let anchor = element.anchor;
Configure true
to show an anchor element pointing to the target component when this Panel is
shown by another component.
Defaults to:
false
<ExtDatepanel animation="true" />
let element = document.body.querySelector('ExtDatepanel');
element.animation = true;
let animation = element.animation;
Set to false
to disable animations.
Defaults to:
true
<ExtDatepanel ariaAttributes="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.ariaAttributes = { };
let ariaAttributes = element.ariaAttributes;
An object containing ARIA attributes to be set
on this Component's ARIA element. Use this to set the attributes that cannot be
determined by the Component's state, such as aria-live
, aria-flowto
, etc.
Note that this config is only meaningful at the Component rendering time, and setting it after that will do nothing.
<ExtDatepanel ariaDescribedBy="value" />
let element = document.body.querySelector('ExtDatepanel');
element.ariaDescribedBy = 'value';
let ariaDescribedBy = element.ariaDescribedBy;
DOM selector for a child element that is to be used
as description for this Component, set in aria-describedby
attribute.
The selector works the same way as ariaLabelledBy.
<ExtDatepanel ariaLabel="value" />
let element = document.body.querySelector('ExtDatepanel');
element.ariaLabel = 'value';
let ariaLabel = element.ariaLabel;
ARIA label for this Component. It is best to use
ariaLabelledBy option instead, because screen readers prefer
aria-labelledby
attribute to aria-label
. ariaLabel and
ariaLabelledBy config options are mutually exclusive.
<ExtDatepanel ariaLabelledBy="value" />
let element = document.body.querySelector('ExtDatepanel');
element.ariaLabelledBy = 'value';
let ariaLabelledBy = element.ariaLabelledBy;
DOM selector for a child element that is to be used
as label for this Component, set in aria-labelledby
attribute.
If the selector is by id
, the label element can be any existing element,
not necessarily a child of the main Component element.
ariaLabelledBy and ariaLabel config options are
mutually exclusive, and ariaLabelledBy
has the higher precedence.
<ExtDatepanel autoConfirm="true" />
let element = document.body.querySelector('ExtDatepanel');
element.autoConfirm = true;
let autoConfirm = element.autoConfirm;
When set to true
, clicking or tapping on
a date cell in the calendar will confirm selection and dismiss the picker.
When set to false
, user will have to click OK button after selecting the date.
Defaults to:
false
<ExtDatepanel autoDestroy="true" />
let element = document.body.querySelector('ExtDatepanel');
element.autoDestroy = true;
let autoDestroy = element.autoDestroy;
If true
, children will be destroyed as soon as they are removed
from this container.
Defaults to:
true
<ExtDatepanel autoSize="true" />
let element = document.body.querySelector('ExtDatepanel');
element.autoSize = true;
let autoSize = element.autoSize;
May be set to false
for improved layout performance if auto-sizing is not required.
Some versions of Safari, both desktop and mobile, have very slow performance if the application has deeply nested containers due to the following WebKit bug: https://bugs.webkit.org/show_bug.cgi?id=150445
Applications that experience performance issues in the affected versions of
Safari may need to turn off autoSizing globally for all <ExtContainer/>
instances
by placing the following override in the application's "overrides" directory:
Ext.define('MyApp.overrides.Container', {
override: 'Ext.Container',
config: {
autoSize: false
}
});
Once auto-sizing support has turned off by default, it can be selectively
turned back on only on those container instances that explicitly need auto-sizing
behavior by setting autoSize
to true
.
This option can also be used to allow children to be sized in percentage units as a workaround for the following browser bug: https://bugs.webkit.org/show_bug.cgi?id=137730
To illustrate, the following example should render a 200px by 200px green box
(the container) with a yellow box inside of it (the child item). The child
item's height and width are both set to '50%'
so the child should render
exactly 100px by 100px in size.
<Container
height={200}
width={200}
style="background: green"
>
<Component
style="background: yellow"
height="50%"
width="50%"
/>
</Container>
All browsers except for Safari render the previous example correctly, but
Safari does not assign a height to the component. To make percentage-sized
children work in Safari, simply set autoSize
to false
on the container.
Since the underlying implementation works by absolutely positioning the container's
body element, this option can only be used when the container is not
"shrink wrapping" the content in either direction. When autoSize
is
set to false
, shrink wrapped dimension(s) will collapse to 0.
Defaults to:
true
<ExtDatepanel axisLock="true" />
let element = document.body.querySelector('ExtDatepanel');
element.axisLock = true;
let axisLock = element.axisLock;
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
<ExtDatepanel bodyBorder="true" />
let element = document.body.querySelector('ExtDatepanel');
element.bodyBorder = true;
let bodyBorder = element.bodyBorder;
true
to enable the border around the panel body (as defined by the theme)
Note that even when enabled, the bodyBorder is only visible when there are docked
items around the edges of the panel. Where the bodyBorder touches the panel's outer
border it is automatically collapsed into a single border.
false
to disable the body border
null
- use the value of border as the value for bodyBorder
Defaults to:
null
<ExtDatepanel bodyCls="value" />
let element = document.body.querySelector('ExtDatepanel');
element.bodyCls = 'value';
let bodyCls = element.bodyCls;
The CSS class to add to this container's body element.
Available since: 7.0
<ExtDatepanel bodyPadding="true" />
let element = document.body.querySelector('ExtDatepanel');
element.bodyPadding = true;
let bodyPadding = element.bodyPadding;
A shortcut for setting a padding style on the body element. The value can either be a number to be applied to all sides, or a normal CSS string describing padding.
Defaults to:
null
<ExtDatepanel bodyStyle="value" />
let element = document.body.querySelector('ExtDatepanel');
element.bodyStyle = 'value';
let bodyStyle = element.bodyStyle;
Custom CSS styles to be applied to the panel's body element, which can be supplied as a valid CSS style string or an object containing style property name/value pairs. For example, these two formats are interpreted to be equivalent:
bodyStyle: 'background:#ffc; padding:10px;'
bodyStyle: {
background: '#ffc',
padding: '10px'
}
Defaults to:
null
Available since: 6.5.0
<ExtDatepanel border="true" />
let element = document.body.querySelector('ExtDatepanel');
element.border = true;
let border = element.border;
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).
Defaults to:
false
<ExtDatepanel bottom="value" />
let element = document.body.querySelector('ExtDatepanel');
element.bottom = 'value';
let bottom = element.bottom;
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
<ExtDatepanel centered="true" />
let element = document.body.querySelector('ExtDatepanel');
element.centered = true;
let centered = element.centered;
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:
null
<ExtDatepanel closable="true" />
let element = document.body.querySelector('ExtDatepanel');
element.closable = true;
let closable = element.closable;
True to display the 'close' tool button and allow the user to close the panel, false to hide the button and disallow closing the window.
By default, when close is requested by clicking the close button in the header, the close method will be called. This will destroy the Panel and its content meaning that it may not be reused.
To make closing a Panel hide the Panel so that it may be reused, set closeAction to 'hide'.
Defaults to:
null
<ExtDatepanel closeAction="value" />
let element = document.body.querySelector('ExtDatepanel');
element.closeAction = 'value';
let closeAction = element.closeAction;
The action to take when the close header tool is clicked:
'destroy'
:
remove the window from the DOM and destroy it and all descendant Components. The window will not be available to be redisplayed via the show method.
'hide'
:
hide the window by setting visibility to hidden and applying negative offsets. The window will be available to be redisplayed via the show method.
Note: This behavior has changed! setting does affect the close method which will invoke the appropriate closeAction.
Defaults to:
'destroy'
<ExtDatepanel closeToolText="value" />
let element = document.body.querySelector('ExtDatepanel');
element.closeToolText = 'value';
let closeToolText = element.closeToolText;
Text to be announced by screen readers when the close tool is focused. Will also be set as the close tool's tooltip text.
Note: Applicable when the panel is closable: true
Defaults to:
'Close panel'
<ExtDatepanel collapsed="true" />
let element = document.body.querySelector('ExtDatepanel');
element.collapsed = true;
let collapsed = element.collapsed;
true
to start collapsed.
<ExtDatepanel collapsible="true" />
let element = document.body.querySelector('ExtDatepanel');
element.collapsible = true;
let collapsible = element.collapsible;
A configuration for a Ext.panel.Collapser.
True to make the panel collapsible and have an expand/collapse toggle Tool added into the header tool button area.
You can also set top
/right
/bottom
/left
to directly specify the collapse direction.
Available since: 6.5.0
<ExtDatepanel constrainTo="value" />
let element = document.body.querySelector('ExtDatepanel');
element.constrainTo = 'value';
let constrainTo = element.constrainTo;
The element into which floated or positioned items constrain their position.
Defaults to the parent container for positioned components, and to the viewport for floated components.
Defaults to:
null
<ExtDatepanel contentEl="value" />
let element = document.body.querySelector('ExtDatepanel');
element.contentEl = 'value';
let contentEl = element.contentEl;
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
<ExtDatepanel data="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.data = { };
let data = element.data;
The initial set of data to apply to the tpl
to
update the content area of the Component.
Defaults to:
null
<ExtDatepanel dateCellFormat="value" />
let element = document.body.querySelector('ExtDatepanel');
element.dateCellFormat = 'value';
let dateCellFormat = element.dateCellFormat;
The date format to use for date cells, compatible with Ext.Date#format method. This format usually includes only day of month information.
<ExtDatepanel defaultFocus="value" />
let element = document.body.querySelector('ExtDatepanel');
element.defaultFocus = 'value';
let defaultFocus = element.defaultFocus;
Specifies a child Component to receive focus when this Container's method-focus method is called. Should be a valid Ext.ComponentQuery selector.
<ExtDatepanel defaults="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.defaults = { };
let defaults = element.defaults;
A set of default configurations to apply to all child Components in this Container.
It's often useful to specify defaults when creating more than one children with similar configurations. For example here we can specify that each child has a height of 20px and avoid repeating the declaration for each one:
<Container
fullscreen
defaults={{
height: 20
}}
>
<Panel>Panel 1</Panel>
<Panel>Panel 2</Panel>
</Container>
Defaults to:
null
<ExtDatepanel disabled="true" />
let element = document.body.querySelector('ExtDatepanel');
element.disabled = true;
let disabled = element.disabled;
Whether or not this component is disabled
Defaults to:
null
<ExtDatepanel disabledDates="value" />
let element = document.body.querySelector('ExtDatepanel');
element.disabledDates = 'value';
let disabledDates = element.disabledDates;
An array of dates to disable. This array can contain Date objects, stringified dates in format, or RegExp patterns that would match strings in format. Date objects can be used to disable specific dates, while strings will be used to build a regular expression to match dates against. Some examples:
Note that the format of the dates included in the array should exactly match the format config.
<ExtDatepanel disabledDays="10" />
let element = document.body.querySelector('ExtDatepanel');
element.disabledDays = 10;
let disabledDays = element.disabledDays;
An array of days to disable, 0-based. For example, [0, 6] disables Sunday and Saturday.
<ExtDatepanel docked="value" />
let element = document.body.querySelector('ExtDatepanel');
element.docked = 'value';
let docked = element.docked;
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:
<!doctype html>
So your index.html file should look a little like this:
<!doctype html>
<html>
<head>
<title>MY application title</title>
...
Defaults to:
null
<ExtDatepanel draggable="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.draggable = { };
let draggable = element.draggable;
Configuration options to make this Component draggable
Defaults to:
null
<ExtDatepanel factoryConfig="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.factoryConfig = { };
let factoryConfig = element.factoryConfig;
If this property is specified by the target class of this mixin its properties are
used to configure the created Ext.Factory
.
<ExtDatepanel flex="value" />
let element = document.body.querySelector('ExtDatepanel');
element.flex = 'value';
let flex = element.flex;
The flex of this item if this item item is inside a Ext.layout.HBox or Ext.layout.VBox layout.
You can also update the flex of a component dynamically using the Ext.layout.FlexBox#setItemFlex method.
When supplied as a string or number this option supports the same syntax as CSS href="https://developer.mozilla.org/en-US/docs/Web/CSS/flex" class="external-link" target="_blank">https://developer.mozilla.org/en-US/docs/Web/CSS/flex flex. For example:
flex: '1 2 auto'
sets flex-grow
property to 0
, flex-shrink
to 2
and flex-basis
to
'auto'
.
The default flex-shrink
value for box layout items is set to 0
in the
stylesheet, which is different from the browser's default flex-shrink
value
of 1
. This accommodates the majority use case for applications since where
non-flexed components are typically not expected to shrink smaller than their
default size.
For convenience when only a single number is supplied it is used as the value
for both flex-grow
and flex-shrink
, for example flex: 3
is the same as
flex: '3 3'
An object form with camel-cased names is also accepted:
flex: {
grow: 1,
shrink: 2,
basis: 'auto'
}
When the object form is supplied shrink
always defaults to 0
regardless
of the value of grow
.
Although 'auto'
is the default value for flex-basis, flex-basis defaults to 0%
when flex is supplied as a single numeric or string value (e.g. flex: 1
). If
this behavior is not desired either explicitly set flex-basis to 'auto'
or use
the object form to set only grow and/or shrink:
flex: {
grow: 2
}
<ExtDatepanel floated="true" />
let element = document.body.querySelector('ExtDatepanel');
element.floated = true;
let floated = element.floated;
A Component may be floated above all other components in the application. This means that the component is absolutely positioned, and will move to the front and occlude other sibling floated component if clicked.
A Floated component may have floated descendants. It will bring these decendants to the front with it when brought to the front of its sibling floated components.
By default, descendant floated components are all positioned using the viewport coordinate system. To make a floating
component a positioning parent for descendants, and have the ancestors positioned relatively, configure the parent
floated component with cfg-relative: true
.
Defaults to:
null
Available since: 6.2.0
<ExtDatepanel focusCls="value" />
let element = document.body.querySelector('ExtDatepanel');
element.focusCls = 'value';
let focusCls = element.focusCls;
CSS class that will be added to focused component's focusClsEl, and removed when component blurs.
Defaults to:
'x-focused'
<ExtDatepanel focusClsEl="value" />
let element = document.body.querySelector('ExtDatepanel');
element.focusClsEl = 'value';
let focusClsEl = element.focusClsEl;
The element that will have the focusCls applied when component's focusEl is focused.
<ExtDatepanel focusEl="value" />
let element = document.body.querySelector('ExtDatepanel');
element.focusEl = 'value';
let focusEl = element.focusEl;
The element that will be focused when focus method is called on this component. Usually this is the same element that receives focus via mouse clicks, taps, and pressing Tab key.
Defaults to:
'el'
<ExtDatepanel focusedDate="value" />
let element = document.body.querySelector('ExtDatepanel');
element.focusedDate = 'value';
let focusedDate = element.focusedDate;
Date to receive focus when the picker is focused for the first time. Subsequent navigation via keyboard will update this value.
This config cannot be null. Default is today.
<ExtDatepanel format="value" />
let element = document.body.querySelector('ExtDatepanel');
element.format = 'value';
let format = element.format;
The default date format string which can be overriden for localization support. The format must be valid according to Ext.Date#parse (defaults to Ext.Date#defaultFormat).
<ExtDatepanel fullscreen="true" />
let element = document.body.querySelector('ExtDatepanel');
element.fullscreen = true;
let fullscreen = element.fullscreen;
Force the component to take up 100% width and height available, by adding it to Ext.Viewport.
<ExtDatepanel handler="function() { }" />
let element = document.body.querySelector('ExtDatepanel');
element.handler = function() { };
let handler = element.handler;
A function that will handle the select event of this picker. The function will receive the following parameters:
<ExtDatepanel hasCollapsible="true" />
let element = document.body.querySelector('ExtDatepanel');
element.hasCollapsible = true;
let hasCollapsible = element.hasCollapsible;
true
if this panel has the collapsible override added.
Defaults to:
true
Available since: 6.5.0
<ExtDatepanel hasResizable="true" />
let element = document.body.querySelector('ExtDatepanel');
element.hasResizable = true;
let hasResizable = element.hasResizable;
true
if this panel has the resizable override added.
Defaults to:
true
Available since: 6.5.0
<ExtDatepanel header="true" />
let element = document.body.querySelector('ExtDatepanel');
element.header = true;
let header = element.header;
Pass as false
to prevent a header from being created.
You may also assign a header with a config object (optionally containing an xtype
)
to custom-configure your panel's header.
See <ExtPanelheader/> for all the options that may be specified here.
Defaults to:
null
<ExtDatepanel headerPosition="value" />
let element = document.body.querySelector('ExtDatepanel');
element.headerPosition = 'value';
let headerPosition = element.headerPosition;
The position of the header. Ignored if no cfg-header is created.
Defaults to:
'top'
Available since: 6.5.0
<ExtDatepanel height="value" />
let element = document.body.querySelector('ExtDatepanel');
element.height = 'value';
let height = element.height;
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
<ExtDatepanel hideAnimation="value" />
let element = document.body.querySelector('ExtDatepanel');
element.hideAnimation = 'value';
let hideAnimation = element.hideAnimation;
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
<ExtDatepanel hideCaptions="true" />
let element = document.body.querySelector('ExtDatepanel');
element.hideCaptions = true;
let hideCaptions = element.hideCaptions;
Set to true
to hide calendar pane captions displaying
the month and year shown in each pane.
<ExtDatepanel hideOnMaskTap="true" />
let element = document.body.querySelector('ExtDatepanel');
element.hideOnMaskTap = true;
let hideOnMaskTap = element.hideOnMaskTap;
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
<ExtDatepanel html="value" />
let element = document.body.querySelector('ExtDatepanel');
element.html = 'value';
let html = element.html;
Optional HTML content to render inside this Component, or a reference to an existing element on the page.
Defaults to:
null
<ExtDatepanel icon="value" />
let element = document.body.querySelector('ExtDatepanel');
element.icon = 'value';
let icon = element.icon;
Path to an image to use as an icon.
For instructions on how you can use icon fonts including those distributed in the SDK see iconCls.
Defaults to:
null
<ExtDatepanel iconCls="value" />
let element = document.body.querySelector('ExtDatepanel');
element.iconCls = 'value';
let iconCls = element.iconCls;
One or more space separated CSS classes to be applied to the icon element. The CSS rule(s) applied should specify a background image to be used as the icon.
An example of specifying a custom icon class would be something like:
// specify the property in the config for the class:
iconCls: 'my-home-icon'
// css rule specifying the background image to be used as the icon image:
.my-home-icon {
background-image: url(../images/my-home-icon.gif) !important;
}
In addition to specifying your own classes, you can use the font icons provided in the SDK using the following syntax:
// using Font Awesome
iconCls: 'x-fa fa-home'
// using Pictos
iconCls: 'pictos pictos-home'
Depending on the theme you're using, you may need include the font icon packages in your application in order to use the icons included in the SDK. For more information see:
Defaults to:
null
<ExtDatepanel id="value" />
let element = document.body.querySelector('ExtDatepanel');
element.id = 'value';
let id = element.id;
The unique id of this component instance.
It should not be necessary to use this configuration except for singleton objects in your application. Components created with an id may be accessed globally using Ext.getCmp.
Instead of using assigned ids, use the itemId config, and Ext.ComponentQuery which provides selector-based searching for Sencha Components analogous to DOM querying. The <ExtContainer/> class contains shortcut methods to query its descendant Components by selector.
Note that this id will also be used as the element id for the containing HTML element that is rendered to the page for this component. This allows you to write id-based CSS rules to style the specific instance of this component uniquely, and also to select sub-elements using this component's id as the parent.
Note: to avoid complications imposed by a unique id also see itemId
.
Defaults to an auto-assigned id.
<ExtDatepanel isObservable="true" />
let element = document.body.querySelector('ExtDatepanel');
element.isObservable = true;
let isObservable = element.isObservable;
true
in this class to identify an object as an instantiated Observable, or subclass thereof.
Defaults to:
true
<ExtDatepanel itemId="value" />
let element = document.body.querySelector('ExtDatepanel');
element.itemId = 'value';
let itemId = element.itemId;
An itemId can be used as an alternative way to get a reference to a component when no object reference is
available. Instead of using an id
with Ext#getCmp, use itemId
with
Ext.Container#getComponent which will retrieve itemId
's or id's. Since itemId
's are an
index to the container's internal MixedCollection, the itemId
is scoped locally to the container - avoiding
potential conflicts with Ext.ComponentManager which requires a unique id
.
Also see id, Ext.Container#query, Ext.Container#down and Ext.Container#child.
<ExtDatepanel keyMap="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.keyMap = { };
let keyMap = element.keyMap;
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.
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
cfg-listeners. It defaults to the "controller"
, but using 'this'
means that an instance method will be used.
<ExtDatepanel keyMapEnabled="true" />
let element = document.body.querySelector('ExtDatepanel');
element.keyMapEnabled = true;
let keyMapEnabled = element.keyMapEnabled;
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
<ExtDatepanel layout="value" />
let element = document.body.querySelector('ExtDatepanel');
element.layout = 'value';
let layout = element.layout;
Configuration for this Container's layout. Example:
<Container
layout={{
type: "hbox",
align: "middle"
}}
>
<Panel
html="hello"
flex={1}
bodyStyle={{
background: "#000",
color: "#fff"
}}
/>
<Panel
html="world"
flex={2}
bodyStyle={{
background: "#f00",
color: "#fff"
}}
/>
</Container>
Defaults to:
auto
<ExtDatepanel left="value" />
let element = document.body.querySelector('ExtDatepanel');
element.left = 'value';
let left = element.left;
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
<ExtDatepanel listeners="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.listeners = { };
let listeners = element.listeners;
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 DataView's 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:
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'); }
}
}
});
<ExtDatepanel margin="value" />
let element = document.body.querySelector('ExtDatepanel');
element.margin = 'value';
let margin = element.margin;
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'
<ExtDatepanel masked="true" />
let element = document.body.querySelector('ExtDatepanel');
element.masked = true;
let masked = element.masked;
A configuration to allow you to mask this container.
If the value is a boolean, a plain mask will be displayed without a message.
<Container masked>
Hello World
</Container>
If the value is a string, it will be used as the message config for an <ExtLoadmask/>.
<Container masked="Please wait...">
Hello World
</Container>
For more precise control over the mask, you add a <LoadMask/>
as a child of the container.
Please refer to the <ExtLoadmask/> component to see the props it supports.
<Container>
<LoadMask message="Please wait..."/>
</Container>
There are also two convenient methods, mask and unmask, to allow you to mask and unmask this container at any time.
Defaults to:
null
<ExtDatepanel maxDate="value" />
let element = document.body.querySelector('ExtDatepanel');
element.maxDate = 'value';
let maxDate = element.maxDate;
Maximum allowable date as Date object or a string in format.
<ExtDatepanel maxHeight="value" />
let element = document.body.querySelector('ExtDatepanel');
element.maxHeight = 'value';
let maxHeight = element.maxHeight;
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
<ExtDatepanel maxWidth="value" />
let element = document.body.querySelector('ExtDatepanel');
element.maxWidth = 'value';
let maxWidth = element.maxWidth;
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
<ExtDatepanel minButtonWidth="10" />
let element = document.body.querySelector('ExtDatepanel');
element.minButtonWidth = 10;
let minButtonWidth = element.minButtonWidth;
Minimum width of all footer toolbar buttons in pixels. If set, this will be used as the default value for the Ext.Button#minWidth config of each Button added to the footer toolbar via the fbar or buttons configurations. It will be ignored for buttons that have a minWidth configured some other way, e.g. in their own config object or via the defaults of their parent container.
Defaults to:
null
Available since: 6.5.0
<ExtDatepanel minDate="value" />
let element = document.body.querySelector('ExtDatepanel');
element.minDate = 'value';
let minDate = element.minDate;
Minimum allowable date as Date object or a string in format.
<ExtDatepanel minHeight="value" />
let element = document.body.querySelector('ExtDatepanel');
element.minHeight = 'value';
let minHeight = element.minHeight;
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
<ExtDatepanel minWidth="value" />
let element = document.body.querySelector('ExtDatepanel');
element.minWidth = 'value';
let minWidth = element.minWidth;
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
<ExtDatepanel modal="true" />
let element = document.body.querySelector('ExtDatepanel');
element.modal = true;
let modal = element.modal;
true
to make this Component 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
<ExtDatepanel monthYearFormat="value" />
let element = document.body.querySelector('ExtDatepanel');
element.monthYearFormat = 'value';
let monthYearFormat = element.monthYearFormat;
The date format for the header month.
<ExtDatepanel name="value" />
let element = document.body.querySelector('ExtDatepanel');
element.name = 'value';
let name = element.name;
Name for the widget to be used with Ext.Container#lookupName et al.
Defaults to:
null
<ExtDatepanel nextText="value" />
let element = document.body.querySelector('ExtDatepanel');
element.nextText = 'value';
let nextText = element.nextText;
The next month navigation button tooltip.
Defaults to:
"Next Month (Control+Right)"
<ExtDatepanel padding="value" />
let element = document.body.querySelector('ExtDatepanel');
element.padding = 'value';
let padding = element.padding;
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
<ExtDatepanel paneCaptionFormat="value" />
let element = document.body.querySelector('ExtDatepanel');
element.paneCaptionFormat = 'value';
let paneCaptionFormat = element.paneCaptionFormat;
Date format for calendar pane captions.
Defaults to:
"F Y"
<ExtDatepanel panes="10" />
let element = document.body.querySelector('ExtDatepanel');
element.panes = 10;
let panes = element.panes;
Number of calendar panes to display in the picker.
Defaults to:
1
<ExtDatepanel plugins="value" />
let element = document.body.querySelector('ExtDatepanel');
element.plugins = 'value';
let plugins = element.plugins;
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.
A plugin by alias:
var list = Ext.create({
xtype: 'list',
itemTpl: '<div class="item">{title}</div>',
store: 'Items',
plugins: 'listpaging'
});
Multiple plugins by alias:
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:
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:
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
}]
});
<ExtDatepanel prevText="value" />
let element = document.body.querySelector('ExtDatepanel');
element.prevText = 'value';
let prevText = element.prevText;
The previous month navigation button tooltip.
Defaults to:
"Previous Month (Control+Left)"
<ExtDatepanel record="value" />
let element = document.body.querySelector('ExtDatepanel');
element.record = 'value';
let record = element.record;
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
<ExtDatepanel relative="true" />
let element = document.body.querySelector('ExtDatepanel');
element.relative = true;
let relative = element.relative;
Only valid when a component is cfg-floated
Configure this as true
if you require descendant floated components to be positioned relative to this
component's coordinate space, not the viewport's coordinate space.
Note: The coordinate space is this Component's encapsulating element's area. Not that of the inner element in which static child items are rendered by the layout.
Defaults to:
null
Available since: 6.2.0
<ExtDatepanel resizable="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.resizable = { };
let resizable = element.resizable;
A configuration for a Ext.panel.Resizer.
Available since: 6.5.0
<ExtDatepanel right="value" />
let element = document.body.querySelector('ExtDatepanel');
element.right = 'value';
let right = element.right;
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
<ExtDatepanel scope="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.scope = { };
let scope = element.scope;
The scope in which handler function will be called.
<ExtDatepanel scrollable="true" />
let element = document.body.querySelector('ExtDatepanel');
element.scrollable = true;
let scrollable = element.scrollable;
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 onlyy
or vertical
to enable vertical scrolling onlyAlso 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:
// scrolls the component to 5 on the x axis and 10 on the y axis
component.getScrollable().scrollTo(5, 10);
Defaults to:
null
<ExtDatepanel shadow="true" />
let element = document.body.querySelector('ExtDatepanel');
element.shadow = true;
let shadow = element.shadow;
Configure as true
for the component to have a drop shadow. 'false' will suppress any default shadow.
By default the theme will determine the presence of a shadow.
Defaults to:
null
Available since: 6.2.0
<ExtDatepanel shim="true" />
let element = document.body.querySelector('ExtDatepanel');
element.shim = true;
let shim = element.shim;
Only valid when a component is cfg-floated
Configure as true
for the component to use an <iframe>
as an underlay to ensure certain non-standard
browser plugins are occluded by this component.
Defaults to:
null
Available since: 6.2.0
<ExtDatepanel showAfterMaxDate="true" />
let element = document.body.querySelector('ExtDatepanel');
element.showAfterMaxDate = true;
let showAfterMaxDate = element.showAfterMaxDate;
Set to true
to allow navigating
to months coming after maxDate. This has no effect when maxDate
is not set.
Defaults to:
false
<ExtDatepanel showAnimation="value" />
let element = document.body.querySelector('ExtDatepanel');
element.showAnimation = 'value';
let showAnimation = element.showAnimation;
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
<ExtDatepanel showBeforeMinDate="true" />
let element = document.body.querySelector('ExtDatepanel');
element.showBeforeMinDate = true;
let showBeforeMinDate = element.showBeforeMinDate;
Set to true
to allow navigating
to months preceding minDate. This has no effect when minDate
is not set.
Defaults to:
false
<ExtDatepanel showTodayButton="true" />
let element = document.body.querySelector('ExtDatepanel');
element.showTodayButton = true;
let showTodayButton = element.showTodayButton;
Set to true
to show the Today button. Location
will depend on showFooter config: if the footer is shown, Today button
will be placed in the footer; otherwise the button will be placed in picker header.
<ExtDatepanel specialDates="value" />
let element = document.body.querySelector('ExtDatepanel');
element.specialDates = 'value';
let specialDates = element.specialDates;
An array of Date objects, strings, or RegExp patterns designating special dates like holidays. These dates will have 'x-special-day' CSS class added to their cells, allowing for visually distinct styling.
If you want to disallow selecting these dates you would need to include them in disabledDates config as well.
<ExtDatepanel startDay="10" />
let element = document.body.querySelector('ExtDatepanel');
element.startDay = 10;
let startDay = element.startDay;
Day index at which the week should begin, 0-based.
Defaults to the value of Ext.Date.firstDayOfWeek.
<ExtDatepanel style="value" />
let element = document.body.querySelector('ExtDatepanel');
element.style = 'value';
let style = element.style;
Additional CSS styles that will be rendered into an inline style attribute when the widget is rendered.
You can pass either a string syntax:
style: 'background:red'
Or by using an object:
style: {
background: 'red'
}
When using the object syntax, you can define CSS Properties by using a string:
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
<ExtDatepanel tabIndex="10" />
let element = document.body.querySelector('ExtDatepanel');
element.tabIndex = 10;
let tabIndex = element.tabIndex;
DOM tabIndex attribute for this component's focusEl.
Defaults to:
null
<ExtDatepanel title="value" />
let element = document.body.querySelector('ExtDatepanel');
element.title = 'value';
let title = element.title;
The title text or config object for the <ExtPaneltitle/> component.
Defaults to:
null
<ExtDatepanel titleCollapse="true" />
let element = document.body.querySelector('ExtDatepanel');
element.titleCollapse = true;
let titleCollapse = element.titleCollapse;
true
to allow expanding and collapsing the panel (when collapsible = true
)
by clicking anywhere in the header bar, false
to allow it only by clicking to tool
button.
Available since: 7.0
<ExtDatepanel toFrontOnShow="true" />
let element = document.body.querySelector('ExtDatepanel');
element.toFrontOnShow = true;
let toFrontOnShow = element.toFrontOnShow;
True to automatically call toFront when a cfg-floated Component is shown.
Defaults to:
true
<ExtDatepanel tools="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.tools = { };
let tools = element.tools;
An array of Ext.panel.Tool configs/instances to be added to the header tool area. The tools are stored as child components of the header container.
Defaults to:
null
<ExtDatepanel top="value" />
let element = document.body.querySelector('ExtDatepanel');
element.top = 'value';
let top = element.top;
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
<ExtDatepanel touchAction="{ }" />
let element = document.body.querySelector('ExtDatepanel');
element.touchAction = { };
let touchAction = element.touchAction;
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:
touchAction: {
panX: false,
pinchZoom: false
}
Touch actions can be specified on reference elements using the reference element name, for example:
// 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:
Defaults to:
null
<ExtDatepanel tpl="value" />
let element = document.body.querySelector('ExtDatepanel');
element.tpl = 'value';
let tpl = element.tpl;
A string, array of strings, or a function that returns JSX.
tpl = data =>
Note The data configuration must be set for any content to be shown in the component when using this configuration.
Defaults to:
null
<ExtDatepanel tplWriteMode="value" />
let element = document.body.querySelector('ExtDatepanel');
element.tplWriteMode = 'value';
let tplWriteMode = element.tplWriteMode;
The Ext.(X)Template method to use when updating the content area of the Component.
Valid modes are:
Defaults to:
'overwrite'
<ExtDatepanel transformCellCls="function() { }" />
let element = document.body.querySelector('ExtDatepanel');
element.transformCellCls(transformCellCls);
A function that will be called during cell rendering to allow modifying CSS classes applied to the cell.
transformCellCls : Object
date : Date
Date for which a cell is being rendered.
classes : String[]
Array of standard CSS classes for this cell, including class names for specialDates, disabledDates, etc. You can add custom classes or remove some standard class names as desired.
<ExtDatepanel ui="value" />
let element = document.body.querySelector('ExtDatepanel');
element.ui = 'value';
let ui = element.ui;
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
<ExtDatepanel userCls="value" />
let element = document.body.querySelector('ExtDatepanel');
element.userCls = 'value';
let userCls = element.userCls;
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.
Defaults to:
null
<ExtDatepanel value="value" />
let element = document.body.querySelector('ExtDatepanel');
element.value = 'value';
let value = element.value;
Initial value of this picker. Defaults to today.
Defaults to:
false
<ExtDatepanel weekendDays="10" />
let element = document.body.querySelector('ExtDatepanel');
element.weekendDays = 10;
let weekendDays = element.weekendDays;
Array of weekend day indices, 0-based.
Defaults to the value of Ext.Date.weekendDays
<ExtDatepanel weight="10" />
let element = document.body.querySelector('ExtDatepanel');
element.weight = 10;
let weight = element.weight;
This value controls this item's order in a weighted <ExtContainer/> (see parent).
Lower values gravitate towards the start of the container - the top in vertical layouts, the locale start side in horizontal layouts.
Defaults to:
null
<ExtDatepanel width="value" />
let element = document.body.querySelector('ExtDatepanel');
element.width = 'value';
let width = element.width;
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
<ExtDatepanel x="10" />
let element = document.body.querySelector('ExtDatepanel');
element.x = 10;
let x = element.x;
Only valid when a component is cfg-floated
The x position at which to position this component. This is usually viewport-relative. But if there is a
relative: true
ancestor, it will be relative to that.
Defaults to:
0
<ExtDatepanel xtype="value" />
let element = document.body.querySelector('ExtDatepanel');
element.xtype = 'value';
let xtype = element.xtype;
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:
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.
Defaults to:
"component"
<ExtDatepanel y="10" />
let element = document.body.querySelector('ExtDatepanel');
element.y = 10;
let y = element.y;
Only valid when a component is cfg-floated
The x position at which to position this component. This is usually viewport-relative. But if there is a
relative: true
ancestor, it will be relative to that.
Defaults to:
0
<ExtDatepanel zIndex="10" />
let element = document.body.querySelector('ExtDatepanel');
element.zIndex = 10;
let zIndex = element.zIndex;
The z-index to give this Component when it is rendered.
Not valid for cfg-floated Components. The Z ordering of cfg-floated Components is managed by ordering of the DOM elements.
Defaults to:
null
<ExtDatepanel tooltip="value" />
let element = document.body.querySelector('ExtDatepanel');
element.tooltip = 'value';
let tooltip = element.tooltip;
The <ExtTooltip/> for this component.
<Button text="Basic Tip">
<ToolTip>A simple tooltip</ToolTip>
</Button>
Defaults to:
null
let element = document.body.querySelector('ExtDatepanel');
element.addAfterListener();
Alias for onAfter.
let element = document.body.querySelector('ExtDatepanel');
element.addBeforeListener();
Alias for onBefore.
let element = document.body.querySelector('ExtDatepanel');
let addListener = element.addListener(eventName, fn, scope, options, order);
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
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:
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:
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:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
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 (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:
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.
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.
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.
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:
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'
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:
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:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
let element = document.body.querySelector('ExtDatepanel');
let addManagedListener = element.addManagedListener(item, ename, fn, scope, options);
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:
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.
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.
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:
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:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
let element = document.body.querySelector('ExtDatepanel');
element.addPlugin(plugin);
Adds a plugin. For example:
list.addPlugin('pullrefresh');
Or:
list.addPlugin({
type: 'pullrefresh',
pullRefreshText: 'Pull to refresh...'
});
Available since: 6.2.0
plugin : Object/String/Ext.plugin.Abstract
The plugin or config object or alias to add.
let element = document.body.querySelector('ExtDatepanel');
element.clearListeners();
Removes all listeners for this object including the managed listeners
let element = document.body.querySelector('ExtDatepanel');
element.clearManagedListeners();
Removes all managed listeners for this object.
let element = document.body.querySelector('ExtDatepanel');
let destroyPlugin = element.destroyPlugin(plugin);
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
plugin : String/Ext.plugin.Abstract
The plugin or its id
to remove.
plugin instance or null
if not found.
let element = document.body.querySelector('ExtDatepanel');
element.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:
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');
}
}
});
eventNames : String/String[]
The event name to bubble, or an Array of event names.
let element = document.body.querySelector('ExtDatepanel');
let findPlugin = element.findPlugin(type);
Retrieves plugin by its type
alias. For example:
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
type : String
The Plugin's type
as specified by the class's
alias configuration.
plugin instance or null
if not found.
let element = document.body.querySelector('ExtDatepanel');
let fireEvent = element.fireEvent(eventName, args);
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.
eventName : String
The name of the event to fire.
args : Object...
Variable number of parameters are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
let element = document.body.querySelector('ExtDatepanel');
let fireEventArgs = element.fireEventArgs(eventName, args);
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.
eventName : String
The name of the event to fire.
args : Object[]
An array of parameters which are passed to handlers.
returns false if any of the handlers return false otherwise it returns true.
let element = document.body.querySelector('ExtDatepanel');
element.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.
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.
let element = document.body.querySelector('ExtDatepanel');
let focus = element.focus(selectText);
Try to focus this component.
If this component is disabled or otherwise not focusable, a close relation will be targeted for focus instead to keep focus localized for keyboard users.
selectText : Boolean/Number[] (optional)
If applicable, true
to also select all the text
in this component, or an array consisting of start and end (defaults to start)
position of selection.
true
if focus target was found and focusing was attempted,
false
if no focusing attempt was made.
Sets the value of collapsible
let element = document.body.querySelector('ExtDatepanel');
let getInherited = element.getInherited(inner);
This method returns an object containing the inherited properties for this instance.
Available since: 5.0.0
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
The inheritedState
object containing inherited properties.
let element = document.body.querySelector('ExtDatepanel');
let getInheritedConfig = element.getInheritedConfig(property, skipThis);
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
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
The value of the requested property
.
let element = document.body.querySelector('ExtDatepanel');
let getParent = element.getParent();
Returns the parent of this component, if it has one.
The parent of this component.
let element = document.body.querySelector('ExtDatepanel');
let getPlugin = element.getPlugin(id);
Retrieves a plugin by its id
.
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
id : String
The id
of the plugin.
plugin instance or null
if not found.
let element = document.body.querySelector('ExtDatepanel');
let getTabIndex = element.getTabIndex();
Return the actual tabIndex for this Focusable.
tabIndex attribute value
let element = document.body.querySelector('ExtDatepanel');
let hasListener = element.hasListener(eventName);
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.
eventName : String
The name of the event to check for
true
if the event is being listened for or bubbles, else false
let element = document.body.querySelector('ExtDatepanel');
let hasParent = element.hasParent();
Returns true
if this component has a parent.
true
if this component has a parent.
let element = document.body.querySelector('ExtDatepanel');
let is = element.is();
Selector processing function for use by nextSibling,previousibling, nextNode,and previousNode, to filter candidate nodes.
The base implementation returns true. Classes which mix in Traversable
may implement
their own implementations. @link{Ext.Widget}
does this to implement
Ext.ComponentQuery based filterability.
This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.
let element = document.body.querySelector('ExtDatepanel');
element.isAncestor(possibleDescendant);
Determines whether this Component is an ancestor of the passed Component.
This will return true
if the passed Component is anywhere within the subtree
beneath this Component.
possibleDescendant : Ext.Component
The Component to test for presence within this Component's subtree.
let element = document.body.querySelector('ExtDatepanel');
let isDescendantOf = element.isDescendantOf(ancestor);
Determines whether this component is the descendant of a passed component.
ancestor : Ext.Component
A Component which may contain this Component.
true
if the component is the descendant of the passed component,
otherwise false
.
let element = document.body.querySelector('ExtDatepanel');
let isFocusable = element.isFocusable(deep);
Determine if this Focusable can receive focus at this time.
Note that Containers can be non-focusable themselves while delegating focus treatment to a child Component; see <ExtContainer/> for more information.
deep : Boolean (optional)
Optionally determine if the container itself is focusable, or if container's focus is delegated to a child component and that child is focusable.
Defaults to: false
True if component is focusable, false if not.
let element = document.body.querySelector('ExtDatepanel');
let isSuspended = element.isSuspended(event);
Checks if all events, or a specific event, is suspended.
event : String (optional)
The name of the specific event to check
true
if events are suspended
let element = document.body.querySelector('ExtDatepanel');
let mon = element.mon(item, ename, fn, scope, options);
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:
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.
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.
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:
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:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
let element = document.body.querySelector('ExtDatepanel');
element.mun(item, ename, fn, scope);
Shorthand for removeManagedListener. Removes listeners that were added by the mon method.
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.
let element = document.body.querySelector('ExtDatepanel');
let nextNode = element.nextNode(selector);
Returns the next node in the Component tree in tree traversal order.
Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree to attempt to find a match. Contrast with nextSibling.
selector : String (optional)
A Ext.ComponentQuery selector to filter the following nodes.
The next node (or the next node which matches the selector).
Returns null
if there is no matching node.
let element = document.body.querySelector('ExtDatepanel');
let nextSibling = element.nextSibling(selector);
Returns the next sibling of this Component.
Optionally selects the next sibling which matches the passed Ext.ComponentQuery selector.
May also be referred to as next()
Note that this is limited to siblings, and if no siblings of the item match, null
is returned. Contrast with
nextNode
selector : String (optional)
A Ext.ComponentQuery selector to filter the following items.
The next sibling (or the next sibling which matches the selector).
Returns null
if there is no matching sibling.
let element = document.body.querySelector('ExtDatepanel');
let on = element.on(eventName, fn, scope, options, order);
The on method is shorthand for addListener.
Appends an event handler to this object. For example:
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:
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:
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:
myGridPanel.on({
cellclick: {fn: 'onCellClick', scope: this, single: true},
viewready: {fn: 'onViewReady', scope: panel}
});
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 (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:
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.
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.
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.
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:
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'
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:
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:
Ext.destroy(this.btnListeners);
or
this.btnListeners.destroy();
let element = document.body.querySelector('ExtDatepanel');
element.onAfter(eventName, fn, scope, options);
Appends an after-event handler.
Same as addListener with order
set
to 'after'
.
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.
let element = document.body.querySelector('ExtDatepanel');
element.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'
.
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.
let element = document.body.querySelector('ExtDatepanel');
let previousNode = element.previousNode(selector);
Returns the previous node in the Component tree in tree traversal order.
Note that this is not limited to siblings, and if invoked upon a node with no matching siblings, will walk the tree in reverse order to attempt to find a match. Contrast with previousSibling.
selector : String (optional)
A Ext.ComponentQuery selector to filter the preceding nodes.
The previous node (or the previous node which matches the selector).
Returns null
if there is no matching node.
let element = document.body.querySelector('ExtDatepanel');
let previousSibling = element.previousSibling(selector);
Returns the previous sibling of this Component.
Optionally selects the previous sibling which matches the passed Ext.ComponentQuery selector.
May also be referred to as prev()
Note that this is limited to siblings, and if no siblings of the item match, null
is returned. Contrast with
previousNode
selector : String (optional)
A Ext.ComponentQuery selector to filter the preceding items.
The previous sibling (or the previous sibling which matches the selector).
Returns null
if there is no matching sibling.
let element = document.body.querySelector('ExtDatepanel');
let relayEvents = element.relayEvents(origin, events, prefix);
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:
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).
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:
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
A Destroyable
object. An object which implements the destroy
method which, when destroyed, removes all relayers. For example:
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
Can be undone by calling
Ext.destroy(this.storeRelayers);
or this.store.relayers.destroy();
let element = document.body.querySelector('ExtDatepanel');
element.removeAfterListener();
Alias for unAfter.
let element = document.body.querySelector('ExtDatepanel');
element.removeBeforeListener();
Alias for unBefore.
let element = document.body.querySelector('ExtDatepanel');
element.removeListener(eventName, fn, scope);
Removes an event handler.
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:
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.
panel.on({
element: 'body',
click: 'onBodyCLick'
});
panel.body.un({
click: 'onBodyCLick'
});
let element = document.body.querySelector('ExtDatepanel');
element.removeManagedListener(item, ename, fn, scope);
Removes listeners that were added by the mon method.
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.
let element = document.body.querySelector('ExtDatepanel');
let removePlugin = element.removePlugin(plugin, destroy);
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
plugin : String/Ext.plugin.Abstract
The plugin or its id
to remove.
destroy : Boolean (optional)
Pass true
to not call destroy()
on the plugin.
plugin instance or null
if not found.
let element = document.body.querySelector('ExtDatepanel');
element.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.
eventName : String...
Multiple event names to resume.
let element = document.body.querySelector('ExtDatepanel');
element.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.
discardQueue : Boolean (optional)
true
to prevent any previously queued events from firing
while we were suspended. See suspendEvents.
let element = document.body.querySelector('ExtDatepanel');
element.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.
listeners : Object
The listeners
let element = document.body.querySelector('ExtDatepanel');
element.setTabIndex(newTabIndex);
Set the tabIndex property for this Focusable. If the focusEl is available, set tabIndex attribute on it, too.
newTabIndex : Number
new tabIndex to set
let element = document.body.querySelector('ExtDatepanel');
element.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.
eventName : String...
Multiple event names to suspend.
let element = document.body.querySelector('ExtDatepanel');
element.suspendEvents(queueSuspended);
Suspends the firing of all events. (see resumeEvents)
queueSuspended : Boolean
true
to queue up suspended events to be fired
after the resumeEvents call instead of discarding all suspended events.
let element = document.body.querySelector('ExtDatepanel');
element.un(eventName, fn, scope);
Shorthand for removeListener. Removes an event handler.
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:
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.
panel.on({
element: 'body',
click: 'onBodyCLick'
});
panel.body.un({
click: 'onBodyCLick'
});
let element = document.body.querySelector('ExtDatepanel');
element.unAfter(eventName, fn, scope, options);
Removes a before-event handler.
Same as removeListener with order
set to 'after'
.
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.
let element = document.body.querySelector('ExtDatepanel');
element.unBefore(eventName, fn, scope, options);
Removes a before-event handler.
Same as removeListener with order
set to 'before'
.
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.
let element = document.body.querySelector('ExtDatepanel');
let up = element.up(selector, limit);
Walks up the ownership hierarchy looking for an ancestor Component which matches the passed simple selector.
Example:
var owningTabPanel = grid.up('tabpanel');
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.
The matching ancestor Container (or undefined
if no match was found).
Override members of this class. Overridden methods can be invoked via Ext.Base#callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).
members : Object
The properties to add to this class. This should be specified as an object literal containing one or more properties.
this class
// Delcare in template tag
onActivate={this._onActivate}
// Declare in class
_onActivate = ({ newActiveItem, sender, oldActiveItem }) => { //... };
Fires whenever item within the Container is activated.
newActiveItem : Object
The new active item within the container.
this : Ext.Container
The Container instance.
oldActiveItem : Object
The old active item within the container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onActiveItemchange={this._onActiveItemchange}
// Declare in class
_onActiveItemchange = ({ sender, value, oldValue }) => { //... };
This event fires when activeItem
changes.
sender : Ext.Container
The instance firing this event.
value : Object/String/Number
The current value of activeItem
.
oldValue : Object/String/Number
The previous value of activeItem
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onAdd={this._onAdd}
// Declare in class
_onAdd = ({ sender, item, index }) => { //... };
Fires whenever item added to the Container.
this : Ext.Container
The Container instance.
item : Object
The item added to the Container.
index : Number
The index of the item within the Container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onAdded={this._onAdded}
// Declare in class
_onAdded = ({ sender, container, index }) => { //... };
Fires after a Component had been added to a Container.
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.
// Delcare in template tag
onBeforeactiveItemchange={this._onBeforeactiveItemchange}
// Declare in class
_onBeforeactiveItemchange = ({ sender, value, oldValue }) => { //... };
This event fires when activeItem
changes.
sender : Ext.Container
The instance firing this event.
value : Object/String/Number
The current value of activeItem
.
oldValue : Object/String/Number
The previous value of activeItem
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforebottomchange={this._onBeforebottomchange}
// Declare in class
_onBeforebottomchange = ({ sender, value, oldValue }) => { //... };
This event fires when bottom
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of bottom
.
oldValue : Number/String
The previous value of bottom
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforecenteredchange={this._onBeforecenteredchange}
// Declare in class
_onBeforecenteredchange = ({ sender, value, oldValue }) => { //... };
This event fires when centered
changes.
sender : Ext.Component
The instance firing this event.
value : Boolean
The current value of centered
.
oldValue : Boolean
The previous value of centered
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforecollapse={this._onBeforecollapse}
// Declare in class
_onBeforecollapse = ({ sender }) => { //... };
Fires before collapse starts. Return false
to cancel collapse.
Available since: 6.5.0
this : Ext.panel.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onBeforedisabledchange={this._onBeforedisabledchange}
// Declare in class
_onBeforedisabledchange = ({ sender, value, oldValue }) => { //... };
This event fires when disabled
changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of disabled
.
oldValue : Boolean
The previous value of disabled
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforedockedchange={this._onBeforedockedchange}
// Declare in class
_onBeforedockedchange = ({ sender, value, oldValue }) => { //... };
This event fires when docked
changes.
sender : Ext.Component
The instance firing this event.
value : String
The current value of docked
.
oldValue : String
The previous value of docked
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforeexpand={this._onBeforeexpand}
// Declare in class
_onBeforeexpand = ({ sender }) => { //... };
Fires before expand starts. Return false
to cancel expand.
Available since: 6.5.0
this : Ext.panel.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onBeforeheightchange={this._onBeforeheightchange}
// Declare in class
_onBeforeheightchange = ({ sender, value, oldValue }) => { //... };
This event fires when height
changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of height
.
oldValue : Number/String
The previous value of height
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforehiddenchange={this._onBeforehiddenchange}
// Declare in class
_onBeforehiddenchange = ({ sender, value, oldValue }) => { //... };
This event fires when hidden
changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of hidden
.
oldValue : Boolean
The previous value of hidden
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforehide={this._onBeforehide}
// Declare in class
_onBeforehide = ({ sender }) => { //... };
Fires before the Component is hidden. Hide may be vetoed by returning false
from a handler.
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onBeforeleftchange={this._onBeforeleftchange}
// Declare in class
_onBeforeleftchange = ({ sender, value, oldValue }) => { //... };
This event fires when left
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of left
.
oldValue : Number/String
The previous value of left
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforemaxHeightchange={this._onBeforemaxHeightchange}
// Declare in class
_onBeforemaxHeightchange = ({ sender, value, oldValue }) => { //... };
This event fires when maxHeight
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxHeight
.
oldValue : Number/String
The previous value of maxHeight
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforemaxWidthchange={this._onBeforemaxWidthchange}
// Declare in class
_onBeforemaxWidthchange = ({ sender, value, oldValue }) => { //... };
This event fires when maxWidth
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxWidth
.
oldValue : Number/String
The previous value of maxWidth
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforeminHeightchange={this._onBeforeminHeightchange}
// Declare in class
_onBeforeminHeightchange = ({ sender, value, oldValue }) => { //... };
This event fires when minHeight
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minHeight
.
oldValue : Number/String
The previous value of minHeight
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforeminWidthchange={this._onBeforeminWidthchange}
// Declare in class
_onBeforeminWidthchange = ({ sender, value, oldValue }) => { //... };
This event fires when minWidth
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minWidth
.
oldValue : Number/String
The previous value of minWidth
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforeresizedragstart={this._onBeforeresizedragstart}
// Declare in class
_onBeforeresizedragstart = ({ sender, context }) => { //... };
Fires before resize starts. Return false
to cancel dragging.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onBeforerightchange={this._onBeforerightchange}
// Declare in class
_onBeforerightchange = ({ sender, value, oldValue }) => { //... };
This event fires when right
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of right
.
oldValue : Number/String
The previous value of right
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforescrollablechange={this._onBeforescrollablechange}
// Declare in class
_onBeforescrollablechange = ({ sender, value, oldValue }) => { //... };
This event fires when scrollable
changes.
sender : Ext.Component
The instance firing this event.
value : Boolean/String/Object
The current value of scrollable
.
oldValue : Boolean/String/Object
The previous value of scrollable
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforeshow={this._onBeforeshow}
// Declare in class
_onBeforeshow = ({ sender }) => { //... };
Fires before the Component is shown. Show may be vetoed by returning false
from a handler.
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onBeforetofront={this._onBeforetofront}
// Declare in class
_onBeforetofront = ({ sender }) => { //... };
Fires before a cfg-floated component is brought to the front of the visual stack.
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onBeforetopchange={this._onBeforetopchange}
// Declare in class
_onBeforetopchange = ({ sender, value, oldValue }) => { //... };
This event fires when top
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of top
.
oldValue : Number/String
The previous value of top
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBeforewidthchange={this._onBeforewidthchange}
// Declare in class
_onBeforewidthchange = ({ sender, value, oldValue }) => { //... };
This event fires when width
changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of width
.
oldValue : Number/String
The previous value of width
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
Return false
to cancel the change.
// Delcare in template tag
onBlur={this._onBlur}
// Declare in class
_onBlur = ({ sender, event }) => { //... };
Fires when this Component's focusEl loses focus.
this : Ext.Component
event : Ext.event.Event
The blur event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onBottomchange={this._onBottomchange}
// Declare in class
_onBottomchange = ({ sender, value, oldValue }) => { //... };
This event fires when bottom
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of bottom
.
oldValue : Number/String
The previous value of bottom
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onCenteredchange={this._onCenteredchange}
// Declare in class
_onCenteredchange = ({ sender, value, oldValue }) => { //... };
This event fires when centered
changes.
sender : Ext.Component
The instance firing this event.
value : Boolean
The current value of centered
.
oldValue : Boolean
The previous value of centered
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onCollapse={this._onCollapse}
// Declare in class
_onCollapse = ({ sender }) => { //... };
Fires when the collapse starts.
Available since: 6.5.0
this : Ext.panel.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onDeactivate={this._onDeactivate}
// Declare in class
_onDeactivate = ({ oldActiveItem, sender, newActiveItem }) => { //... };
Fires whenever item within the Container is deactivated.
oldActiveItem : Object
The old active item within the container.
this : Ext.Container
The Container instance.
newActiveItem : Object
The new active item within the container.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onDestroy={this._onDestroy}
// Declare in class
_onDestroy = ({ }) => { //... };
Fires when the component is destroyed
// Delcare in template tag
onDisabledchange={this._onDisabledchange}
// Declare in class
_onDisabledchange = ({ sender, value, oldValue }) => { //... };
This event fires when disabled
changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of disabled
.
oldValue : Boolean
The previous value of disabled
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onDockedchange={this._onDockedchange}
// Declare in class
_onDockedchange = ({ sender, value, oldValue }) => { //... };
This event fires when docked
changes.
sender : Ext.Component
The instance firing this event.
value : String
The current value of docked
.
oldValue : String
The previous value of docked
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onDrawerhide={this._onDrawerhide}
// Declare in class
_onDrawerhide = ({ sender }) => { //... };
Fires then the drawer hides.
Available since: 6.5.0
this : Ext.panel.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onDrawershow={this._onDrawershow}
// Declare in class
_onDrawershow = ({ sender }) => { //... };
Fires then the drawer shows.
Available since: 6.5.0
this : Ext.panel.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onErased={this._onErased}
// Declare in class
_onErased = ({ sender }) => { //... };
Fires when the component is no longer displayed in the DOM. Listening to this event will degrade performance not recommend for general use.
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onExpand={this._onExpand}
// Declare in class
_onExpand = ({ sender }) => { //... };
Fires when the expand starts.
Available since: 6.5.0
this : Ext.panel.Panel
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onFocus={this._onFocus}
// Declare in class
_onFocus = ({ sender, event }) => { //... };
Fires when this Component's focusEl receives focus.
this : Ext.Component/Ext.Widget
event : Ext.event.Event
The focus event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onFocusenter={this._onFocusenter}
// Declare in class
_onFocusenter = ({ sender, event }) => { //... };
Fires when focus enters this Component's hierarchy.
this : Ext.Component
event : Ext.event.Event
The focusenter event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onFocusleave={this._onFocusleave}
// Declare in class
_onFocusleave = ({ sender, event }) => { //... };
Fires when focus leaves this Component's hierarchy.
this : Ext.Component
event : Ext.event.Event
The focusleave event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onFullscreen={this._onFullscreen}
// Declare in class
_onFullscreen = ({ sender }) => { //... };
Fires whenever a Component with the fullscreen config is instantiated
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onHeightchange={this._onHeightchange}
// Declare in class
_onHeightchange = ({ sender, value, oldValue }) => { //... };
This event fires when height
changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of height
.
oldValue : Number/String
The previous value of height
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onHiddenchange={this._onHiddenchange}
// Declare in class
_onHiddenchange = ({ sender, value, oldValue }) => { //... };
This event fires when hidden
changes.
sender : Ext.Widget
The instance firing this event.
value : Boolean
The current value of hidden
.
oldValue : Boolean
The previous value of hidden
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onHide={this._onHide}
// Declare in class
_onHide = ({ sender }) => { //... };
Fires whenever the Component is hidden
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onInitialize={this._onInitialize}
// Declare in class
_onInitialize = ({ sender }) => { //... };
Fires when the component has been initialized
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onLeftchange={this._onLeftchange}
// Declare in class
_onLeftchange = ({ sender, value, oldValue }) => { //... };
This event fires when left
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of left
.
oldValue : Number/String
The previous value of left
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onMaxHeightchange={this._onMaxHeightchange}
// Declare in class
_onMaxHeightchange = ({ sender, value, oldValue }) => { //... };
This event fires when maxHeight
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxHeight
.
oldValue : Number/String
The previous value of maxHeight
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onMaxWidthchange={this._onMaxWidthchange}
// Declare in class
_onMaxWidthchange = ({ sender, value, oldValue }) => { //... };
This event fires when maxWidth
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of maxWidth
.
oldValue : Number/String
The previous value of maxWidth
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onMinHeightchange={this._onMinHeightchange}
// Declare in class
_onMinHeightchange = ({ sender, value, oldValue }) => { //... };
This event fires when minHeight
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minHeight
.
oldValue : Number/String
The previous value of minHeight
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onMinWidthchange={this._onMinWidthchange}
// Declare in class
_onMinWidthchange = ({ sender, value, oldValue }) => { //... };
This event fires when minWidth
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of minWidth
.
oldValue : Number/String
The previous value of minWidth
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onMove={this._onMove}
// Declare in class
_onMove = ({ sender, item, toIndex, fromIndex }) => { //... };
Fires whenever item moved within the Container.
this : Ext.Container
The Container instance.
item : Object
The item moved within the Container.
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.
// Delcare in template tag
onMoved={this._onMoved}
// Declare in class
_onMoved = ({ sender, container, toIndex, fromIndex }) => { //... };
Fires when a component si moved within its Container.
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.
// Delcare in template tag
onPainted={this._onPainted}
// Declare in class
_onPainted = ({ element }) => { //... };
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.
element : Ext.dom.Element
The component's outer element (this.element)
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onPositionedchange={this._onPositionedchange}
// Declare in class
_onPositionedchange = ({ sender, positioned }) => { //... };
Fires whenever there is a change in the positioned status of a component
this : Ext.Component
The component instance
positioned : Boolean
The component's new positioned state. This becomes
true
is a component is positioned using the cfg-top, cfg-right,
cfg-bottom or cfg-left configs.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onRemove={this._onRemove}
// Declare in class
_onRemove = ({ sender, item, index }) => { //... };
Fires whenever item removed from the Container.
this : Ext.Container
The Container instance.
item : Object
The item removed from the Container.
index : Number
The index of the item that was removed.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onRemoved={this._onRemoved}
// Declare in class
_onRemoved = ({ sender, container, index }) => { //... };
Fires when a component is removed from a Container
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.
// Delcare in template tag
onResize={this._onResize}
// Declare in class
_onResize = ({ component, width, height, oldWidth, oldHeight }) => { //... };
Fires asynchronously after a browser layout caused by a component resize. This may be triggered for any or several of the following reasons:
component : Ext.Component
This Component.
width : String/Number
The new width.
height : String/Number
The new height.
oldWidth : String/Number
The previous width.
oldHeight : String/Number
The previous height.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onResizedrag={this._onResizedrag}
// Declare in class
_onResizedrag = ({ sender, context }) => { //... };
Fires for each tick while a drag is active.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
width : Number
The current resized width in pixels.
height : Number
The current resized height in pixels.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onResizedragcancel={this._onResizedragcancel}
// Declare in class
_onResizedragcancel = ({ sender, context }) => { //... };
Fires when the drag resize is cancelled.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onResizedragend={this._onResizedragend}
// Declare in class
_onResizedragend = ({ sender, context }) => { //... };
Fires when the drag resize is complete.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
width : Number
The final resized width in pixels.
height : Number
The final resized height in pixels.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onResizedragstart={this._onResizedragstart}
// Declare in class
_onResizedragstart = ({ sender, context }) => { //... };
Fires when the resize starts.
Available since: 6.5.0
this : Ext.Panel
context : Object
edge : String
The edge being resized.
event : Ext.event.Event
The event.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onRightchange={this._onRightchange}
// Declare in class
_onRightchange = ({ sender, value, oldValue }) => { //... };
This event fires when right
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of right
.
oldValue : Number/String
The previous value of right
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onScrollablechange={this._onScrollablechange}
// Declare in class
_onScrollablechange = ({ sender, value, oldValue }) => { //... };
This event fires when scrollable
changes.
sender : Ext.Component
The instance firing this event.
value : Boolean/String/Object
The current value of scrollable
.
oldValue : Boolean/String/Object
The previous value of scrollable
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onShow={this._onShow}
// Declare in class
_onShow = ({ sender }) => { //... };
Fires whenever the Component is shown
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onTofront={this._onTofront}
// Declare in class
_onTofront = ({ sender }) => { //... };
Fires when a cfg-floated component has been brought to the front of the visual stack.
this : Ext.Component
The component instance
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onTopchange={this._onTopchange}
// Declare in class
_onTopchange = ({ sender, value, oldValue }) => { //... };
This event fires when top
changes.
sender : Ext.Component
The instance firing this event.
value : Number/String
The current value of top
.
oldValue : Number/String
The previous value of top
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
// Delcare in template tag
onWidthchange={this._onWidthchange}
// Declare in class
_onWidthchange = ({ sender, value, oldValue }) => { //... };
This event fires when width
changes.
sender : Ext.Widget
The instance firing this event.
value : Number/String
The current value of width
.
oldValue : Number/String
The previous value of width
.
eOpts : Object
The options object passed to Ext.util.Observable.addListener.