Many classes have shortcut names used when creating (instantiating) a class with a
configuration object. The shortcut name is referred to as an alias (or xtype if the
class extends Ext.Component). The alias/xtype is listed next to the class name of
applicable classes for quick reference.
Framework classes or their members may be specified as private or protected. Else,
the class / member is public. Public, protected, and private are access
descriptors used to convey how and when the class or class member should be used.
Public classes and class members are available for use by any other class or application code and may be relied upon as a stable and persistent within major product versions. Public classes and members may safely be extended via a subclass.
Protected class members are stable public members intended to be used by the
owning class or its subclasses. Protected members may safely be extended via a subclass.
Private classes and class members are used internally by the framework and are not intended to be used by application developers. Private classes and members may change or be omitted from the framework at any time without notice and should not be relied upon in application logic.
static label next to the
method name. *See Static below.Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).
Let's look at each part of the member row:
lookupComponent in this example)( item ) in this example)Ext.Component in this case). This may be omitted for methods that do not
return anything other than undefined or may display as multiple possible values
separated by a forward slash / signifying that what is returned may depend on the
results of the method call (i.e. a method may return a Component if a get method calls is
successful or false if unsuccessful which would be displayed as
Ext.Component/Boolean).PROTECTED in
this example - see the Flags section below)Ext.container.Container in this example). The source
class will be displayed as a blue link if the member originates from the current class
and gray if it is inherited from an ancestor or mixed-in class.view source in the example)item : Object in the example).undefined a "Returns" section
will note the type of class or object returned and a description (Ext.Component in the
example)Available since 3.4.0 - not pictured in
the example) just after the member descriptionDefaults to: false)The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.
classInstance.method1().method2().etc();false is returned from
an event handler- Indicates a framework class
- A singleton framework class. *See the singleton flag for more information
- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)
- Indicates that the class, member, or guide is new in the currently viewed version
- Indicates a class member of type config
- Indicates a class member of type property
- Indicates a class member of type
method
- Indicates a class member of type event
- Indicates a class member of type
theme variable
- Indicates a class member of type
theme mixin
- Indicates that the class, member, or guide is new in the currently viewed version
Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.
Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.
Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.
Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.
If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.
Both API docs and guides can be searched for using the search field at the top of the page.
On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.
The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.
Clicking on an empty search field will show your last 10 searches for quick navigation.
Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:
Ext.button.Button class has an alternate class name of Ext.Button). Alternate class
names are commonly maintained for backward compatibility.Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.
Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.
Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:
The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.
This is a layout that manages multiple Panels in an expandable accordion style such that by default only one Panel can be expanded at any given time (set multi config to have more open). Each Panel has built-in support for expanding and collapsing.
Note: Only Ext Panels and all subclasses of Ext.panel.Panel may be used in an accordion layout Container.
Ext.create('Ext.panel.Panel', {
title: 'Accordion Layout',
width: 300,
height: 300,
defaults: {
// applied to each contained panel
bodyStyle: 'padding:15px'
},
layout: {
// layout-specific configs go here
type: 'accordion',
titleCollapse: false,
animate: true,
activeOnTop: true
},
items: [{
title: 'Panel 1',
html: 'Panel content!'
},{
title: 'Panel 2',
html: 'Panel content!'
},{
title: 'Panel 3',
html: 'Panel content!'
}],
renderTo: Ext.getBody()
});
Only valid when multi is false and animate is false.
True to swap the position of each panel as it is expanded so that it becomes the first item in the container, false to keep the panels in the rendered order.
Defaults to:
false
Controls how the child items of the container are aligned. The value is used to
position items "perpendicularly". That is, for horizontal boxes (where vertical
is false), then this will position items vertically. Otherwise, this will position
items horizontally. The acceptable values for this property are best explained in
context with the value of vertical.
If vertical is false then this layout is behaving as an hbox and this config
operates as follows:
If vertical is true then this layout is behaving as an vbox and this config
operates as follows:
For backwards compatibility, the following values are also recognized:
Defaults to:
"begin"
The Math method
to use for rounding fractional pixels when align:middle is used.
The possible values are:
Defaults to:
'round'
Returns the value of alignRoundingMethod
"round" / "floor" / "ceil"
Sets the value of alignRoundingMethod
alignRoundingMethod : "round" / "floor" / "ceil"
True to slide the contained panels open and closed during expand/collapse using animation, false to open and close directly with no animation. Note: The layout performs animated collapsing and expanding, not the child Panels.
Defaults to:
true
An object that contains as keys the names of the properties that can be animated by child items as a consequence of a layout. This config is used internally by the Ext.layout.container.Accordion layout to cause the child panels to animate to their proper size and position after a collapse/expand event.
Available since: 4.1.0
Child Panels have their width actively managed to fit within the accordion's width.
This method has been REMOVED since This
The canonical form of childEls is an object keyed by child's property name
with values that are objects with the following properties.
itemId - The id to combine with the Component's id that is the id of the
child element.id - The id of the child element.leaf - Set to true to ignore content when scanning for childEls. This
should be set on things like the generated content for an Ext.view.View.select: A selector that will be passed to Ext.dom.Element#method-select.selectNode: A selector that will be passed to
Ext.dom.Element#method-selectNode.For example:
childEls: {
button: true,
buttonText: 'text',
buttonImage: {
itemId: 'image'
}
}
The above is translated into the following complete form:
childEls: {
button: {
name: 'button',
itemId: 'button'
},
buttonText: {
name: 'buttonText',
itemId: 'text'
},
buttonImage: {
name: 'buttonImage',
itemId: 'image'
}
}
The above can be provided as an array like so:
childEls: [
'button',
{ name: 'buttonText', itemId: 'text' },
{ name: 'buttonImage', itemId: 'image' }
}
For example, a Component which renders a title and body text:
Ext.create('Ext.Component', {
renderTo: Ext.getBody(),
renderTpl: [
'<h1 id="{id}-title" data-ref="title">{title}</h1>',
'<p>{msg}</p>',
],
renderData: {
title: "Error",
msg: "Something went wrong"
},
childEls: ["title"],
listeners: {
afterrender: function(cmp){
// After rendering the component will have a title property
cmp.title.setStyle({color: "red"});
}
}
});
Note: childEls in the renderTpl
must be referenced in a data-ref attribute. Notice in the above example
that the "title" childEl is set in the renderTpl using
data-ref="title".
When using select, the property will be an instance of Ext.CompositeElement.
In all other cases, the property will be an Ext.dom.Element or null
if not found.
Care should be taken when using select or selectNode to find child elements.
The following issues should be considered:
This above issues are most important when using select since it returns multiple
elements.
Defaults to:
{}
True to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in the contained Panels' title bars, false to render it last. By default, this will use the Ext.panel.Panel#collapseFirst setting on the panel. If the config option is specified on the layout, it will override the panel value.
Defaults to:
undefined
Limits the size of aligned components to the size of the container
under certain circumstances. Firstly, the container's height (for hbox) or width
(for vbox) must not be determined by the size of the child components. Secondly,
the child components must have shrinkwrap
enabled for this dimension.
Defaults to:
false
Sets the value of constrainAlign
constrainAlign : Boolean
This flag can be set to false to ignore the split config on box items. This is
set to false by Ext.layout.container.Accordion.
Defaults to:
true
Sets the value of enableSplitters
enableSplitters : Boolean
True to adjust the active item's height to fill the available space in the container, false to use the item's current height, or auto height if not explicitly set.
Defaults to:
true
True to hide the contained Panels' collapse/expand toggle buttons, false to display them. When set to true, titleCollapse is automatically set to true.
Defaults to:
false
An optional extra CSS class that will be added to the container. This can be useful for adding customized styles to the container or any of its children using standard CSS rules. See Ext.Component.componentCls also.
Set to true to enable multiple accordion items to be open at once.
Defaults to:
false
An overflow handler or config object for an overflow handler. This is typically specified as one of the following strings:
scroller - Scroller buttons are rendered before and after the content.menu - Overflowing items are rendered into a menu, and a button is rendered
after the items, which shows the menu when clicked.NOTE: This config is currently only supported when box layout is used by the following components:
Components where overflowHandler is not supported should use
scrollable:true if they have overflowing
content.
Defaults to:
null
Returns the value of overflowHandler
Sets the value of overflowHandler
overflowHandler : String / Ext.layout.container.boxOverflow.None
Controls how the child items of the container are packed together. Acceptable configuration values for this property are:
Defaults to:
'start'
Sets the padding to be applied to all child items managed by this layout.
This property must be specified as a string containing space-separated, numeric padding values. The order of the sides associated with each value matches the way CSS processes padding values:
Defaults to:
0
Allows stretchMax calculation to take into account the max perpendicular size (height for HBox layout and width for VBox layout) of another Box layout when calculating its maximum perpendicular child size.
If specified as a string, this may be either a known Container ID, or a
ComponentQuery selector which is rooted at this layout's Container (ie, to find
a sibling, use "^>#siblingItemId).
Defaults to:
undefined
Sets the value of stretchMaxPartner
stretchMaxPartner : String / Ext.Component
True to allow expand/collapse of each contained panel by clicking anywhere on the title bar, false to allow expand/collapse only when the toggle tool button is clicked. When set to false, hideCollapseTool should be false also. An explicit Ext.panel.Panel#titleCollapse declared on the panel will override this setting.
Defaults to:
true
When true, pressing Down or Right arrow key on the
focused last accordion panel header will navigate to the first panel; pressing Up
or Left arrow key on the focused first accordion panel header will navigate to the
last panel.
Set this to false to prevent keyboard navigation from wrapping over the edges.
Defaults to:
true
The value true causes config values to be stored on instances using a
property name prefixed with an underscore ("_") character. A value of false
stores config values as properties using their exact name (no prefix).
Defaults to:
true
Available since: 5.0.0
The value true instructs the initConfig method to only honor values for
properties declared in the config block of a class. When false, properties
that are not declared in a config block will be placed on the instance.
Defaults to:
true
Available since: 5.0.0
A prototype-chained object storing transform method names and priorities stored on the class prototype. On first instantiation, this object is converted into an array that is sorted by priority and stored on the constructor.
Defaults to:
{}
An object which contains boolean properties specifying which properties are to be animated upon flush of child Component ContextItems. For example, Accordion would have:
{
y: true,
height: true
}
Defaults to:
null
Called by an owning Panel before the Panel begins its collapse process. Most layouts will not need to override the default Ext.emptyFn implementation.
Defaults to:
Ext.emptyFn
Called by an owning Panel before the Panel begins its expand process. Most layouts will not need to override the default Ext.emptyFn implementation.
Defaults to:
Ext.emptyFn
Setting this property to false will prevent nulling object references
on a Class instance after destruction. Setting this to "async" will delay
the clearing for approx 50ms.
Defaults to:
true
Available since: 6.2.0
Setting this property to true will result in setting the object's
prototype to null after the destruction sequence is fully completed.
After that, most attempts at calling methods on the object instance
will result in "method not defined" exception. This can be very helpful
with tracking down otherwise hard to find bugs like runaway Ajax requests,
timed functions not cleared on destruction, etc.
Note that this option can only work in browsers that support Object.setPrototypeOf
method, and is only available in debugging mode.
Defaults to:
false
Available since: 6.2.0
This property is set to true after the destroy method is called.
Defaults to:
false
Used only during a layout run, this value indicates that a layout has finished its calculations. This flag is set to true prior to the call to calculate and should be set to false if this layout has more work to do.
If this property is specified by the target class of this mixin its properties are
used to configure the created Ext.Factory.
This property is set to true during the call to initConfig.
Defaults to:
false
Available since: 5.0.0
This property is set to true if this instance is the first of its class.
Defaults to:
false
Available since: 5.0.0
This value is true and is used to identify plain objects from instances of
a defined class.
Defaults to:
true
true in this class to identify an object as an instantiated Layout, or subclass thereof.
Defaults to:
true
true if this layout may need to incorporate the dimensions of individual child
items into its layout calculations. Layouts that handle the size of their children
as a group (autocontainer, form) can set this to false for an additional performance
optimization. When false the layout system will not recurse into the child
items if Ext.layout.container.Container#activeItemCount is 0, which will be
the case if all child items use "liquid" CSS layout, e.g. form fields.
(See Ext.Component#liquidLayout)
Defaults to:
true
Get the reference to the current class from which this object was instantiated. Unlike
Ext.Base#statics, this.self is scope-dependent and it's meant to be used
for dynamic inheritance. See Ext.Base#statics for a detailed comparison
Ext.define('My.Cat', {
statics: {
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
alert(this.self.speciesName); // dependent on 'this'
},
clone: function() {
return new this.self();
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
}
});
var cat = new My.Cat(); // alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
Defaults to:
Base
true if this layout may set the size of its child items. Layouts that do not
set the size of their child items (autocontainer, form) can set this to false
for an additional performance optimization. When true the layout system will
not create a context item for children that use liquid layout, because there is
no need for a context item if item size is neither read nor set by the owning layout.
Defaults to:
true
Add a childEl specific to this instance. This must be called before render.
Available since: 6.0.0
childEl : Object
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
deprecations : Object
Called after the mixin is applied. We need to see if childEls were used by
the targetClass and apply them to the config.
targetClass : Ext.Class
Called by an owning Panel after the Panel finishes its collapse process.
owner : Object
animated : Object
Called by an owning Panel after the Panel finishes its expand process.
owner : Object
animated : Object
Removes layout's itemCls and owning Container's itemCls. Clears the managed dimensions flags
item : Object
Sets references to elements inside the component.
el : Object
owner : Object
Called by an owning Panel before the Panel begins its collapse process. Most layouts will not need to override the default Ext.emptyFn implementation.
child : Object
Called by an owning Panel before the Panel begins its expand process. Most layouts will not need to override the default Ext.emptyFn implementation.
child : Object
In addition to work done by our base classes, containers benefit from some extra cached data. The following properties are added to the ownerContext:
ownerContext : Object
Called before any calculation cycles to reset DOM values and prepare for calculation.
This is a write phase and DOM reads should be strictly avoided when overridding this method.
ownerContext : Ext.layout.ContextItem
The context item for the layout's owner component.
This method is called to (re)cache our understanding of flexes. This happens during beginLayoutCycle and may need to be called again if the flexes are changed during the layout (e.g., like ColumnLayout).
ownerContext : Object
Called to perform the calculations for this layout. This method will be called at
least once and may be called repeatedly if the done property is cleared
before return to indicate that this layout is not yet done. The done property
is always set to true before entering this method.
This is a read phase and DOM writes should be strictly avoided in derived classes. Instead, DOM writes need to be written to Ext.layout.ContextItem objects to be flushed at the next opportunity.
ownerContext : Ext.layout.ContextItem
The context item for the layout's owner component.
Call the original method that was previously overridden with Ext.Base#override
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callOverridden();
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callOverridden(arguments)
Returns the result of calling the overridden method
Deprecated since version 4.1.0
Use method-callParent instead.
Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).
Ext.define('My.Base', {
constructor: function(x) {
this.x = x;
},
statics: {
method: function(x) {
return x;
}
}
});
Ext.define('My.Derived', {
extend: 'My.Base',
constructor: function() {
this.callParent([21]);
}
});
var obj = new My.Derived();
alert(obj.x); // alerts 21
This can be used with an override as follows:
Ext.define('My.DerivedOverride', {
override: 'My.Derived',
constructor: function(x) {
this.callParent([x*2]); // calls original My.Derived constructor
}
});
var obj = new My.Derived();
alert(obj.x); // now alerts 42
This also works with static and private methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
// privates: {
statics: {
method: function(x) {
return this.callParent([x*2]); // calls My.Base.method
}
}
});
alert(My.Base.method(10)); // alerts 10
alert(My.Derived2.method(10)); // alerts 20
Lastly, it also works with overridden static methods.
Ext.define('My.Derived2Override', {
override: 'My.Derived2',
// privates: {
statics: {
method: function(x) {
return this.callParent([x*2]); // calls My.Derived2.method
}
}
});
alert(My.Derived2.method(10); // now alerts 40
To override a method and replace it and also call the superclass method, use method-callSuper. This is often done to patch a method to fix a bug.
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callParent(arguments)
Returns the result of calling the parent method
This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.
Consider:
Ext.define('Ext.some.Class', {
method: function() {
console.log('Good');
}
});
Ext.define('Ext.some.DerivedClass', {
extend: 'Ext.some.Class',
method: function() {
console.log('Bad');
// ... logic but with a bug ...
this.callParent();
}
});
To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an
override:
Ext.define('App.patches.DerivedClass', {
override: 'Ext.some.DerivedClass',
method: function() {
console.log('Fixed');
// ... logic but with bug fixed ...
this.callSuper();
}
});
The patch method cannot use method-callParent to call the superclass
method since that would call the overridden method containing the bug. In
other words, the above patch would only produce "Fixed" then "Good" in the
console log, whereas, using callParent would produce "Fixed" then "Bad"
then "Good".
args : Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)
Returns the result of calling the superclass method
This method (if implemented) is called at the end of the cycle in which this layout
completes (by not setting done to false in calculate). It is
possible for the layout to complete and yet become invalid before the end of the cycle,
in which case, this method will not be called. It is also possible for this method to
be called and then later the layout becomes invalidated. This will result in
calculate being called again, followed by another call to this method.
This is a read phase and DOM writes should be strictly avoided in derived classes. Instead, DOM writes need to be written to Ext.layout.ContextItem objects to be flushed at the next opportunity.
This method need not be implemented by derived classes and, in fact, should only be implemented when needed.
ownerContext : Ext.layout.ContextItem
The context item for the layout's owner component.
Adds layout's itemCls and owning Container's itemCls
item : Object
Destroys this layout. This method removes a targetCls from the target
element and calls onDestroy.
A derived class can override either this method or onDestroy but in all
cases must call the base class versions of these methods to allow the base class to
perform its cleanup.
This method (or onDestroy) are overridden by subclasses most often to purge
event handlers or remove unmanged DOM nodes.
Destroys member properties by name.
If a property name is the name of a config, the getter is not invoked, so if the config has not been initialized, nothing will be done.
The property will be destroyed, and the corrected name (if the property is a config
and config names are prefixed) will set to null in this object's dictionary.
args : String...
One or more names of the properties to destroy and remove from the object.
This method (if implemented) is called after all layouts have completed. In most ways this is similar to completeLayout. This call can cause this (or any layout) to be become invalid (see Ext.layout.Context#invalidate), but this is best avoided. This method is intended to be where final reads are made and so it is best to avoid invalidating layouts at this point whenever possible. Even so, this method can be used to perform final checks that may require all other layouts to be complete and then invalidate some results.
This is a read phase and DOM writes should be strictly avoided in derived classes. Instead, DOM writes need to be written to Ext.layout.ContextItem objects to be flushed at the next opportunity.
This method need not be implemented by derived classes and, in fact, should only be implemented when needed.
ownerContext : Ext.layout.ContextItem
The context item for the layout's owner component.
This method is called after all layouts are complete and their calculations flushed
to the DOM. No further layouts will be run and this method is only called once per
layout run. The base component layout caches lastComponentSize.
This is a write phase and DOM reads should be avoided if possible when overridding this method.
This method need not be implemented by derived classes and, in fact, should only be implemented when needed.
ownerContext : Ext.layout.ContextItem
The context item for the layout's owner component.
Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.
name : String (optional)
The name of the config property to get.
peek : Boolean (optional)
true to peek at the raw value without calling the getter.
Defaults to: false
ifInitialized : Boolean (optional)
true to only return the initialized property
value, not the raw config value, and not to trigger initialization. Returns
undefined if the property has not yet been initialized.
Defaults to: false
The config property value.
Returns the container size (that of the target). Only the fixed-sized dimensions can be returned because the shrinkWrap dimensions are based on the contentWidth/Height as determined by the container layout.
ownerContext : Ext.layout.ContextItem
The owner's context item.
inDom : Boolean (optional)
True if the container size must be in the DOM.
Defaults to: false
The size
Returns the element into which extra functional DOM elements can be inserted. Defaults to the owner Component's encapsulating element.
May be overridden in Component layout managers which implement a component render target which must only contain child components.
Returns the initial configuration passed to the constructor when instantiating this class.
Given this example Ext.button.Button definition and instance:
Ext.define('MyApp.view.Button', {
extend: 'Ext.button.Button',
xtype: 'mybutton',
scale: 'large',
enableToggle: true
});
var btn = Ext.create({
xtype: 'mybutton',
renderTo: Ext.getBody(),
text: 'Test Button'
});
Calling btn.getInitialConfig() would return an object including the config
options passed to the create method:
xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'
Calling btn.getInitialConfig('text')returns 'Test Button'.
name : String (optional)
Name of the config option to return.
The full config object or a single config value
when name parameter specified.
For a given item, returns the element that participates in the childNodes array of the layout's target element. This is usually the component's "el", but can also be a wrapper
item : Ext.Component
Returns an object describing how this layout manages the size of the given component. This method must be implemented by any layout that manages components.
item : Ext.Component
An object describing the sizing done by the layout for this item.
Returns an array of child components either for a render phase (Performed in the beforeLayout method of the layout's base class), or the layout phase (onLayout).
of child components
Returns the element into which rendering must take place. Defaults to the owner Container's target element.
May be overridden in layout managers which implement an inner element.
Returns all items that are both rendered and visible
All matching items
Initialize configuration for this class. a typical example:
Ext.define('My.awesome.Class', {
// The default config
config: {
name: 'Awesome',
isAwesome: true
},
constructor: function(config) {
this.initConfig(config);
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
instanceConfig : Object
this
Inserts the splitter for a given region. A reference to the splitter is also stored on the component as "splitter".
item : Object
index : Object
: Object
splitterCfg : Object
Validates item is in the proper place in the dom.
item : Object
target : Object
position : Object
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy).
name : String
value : Object
The value passed.
Moves Component to the provided target instead.
item : Object
target : Object
position : Object
Called for every layout in the layout context after all the layouts have been finally flushed
This method is called when a child item changes in some way. By default this calls updateLayout on this layout's owner.
child : Ext.Component
The child item that has changed.
True if this layout has handled the content change.
Renders the given Component into the target Element.
item : Ext.Component
The Component to render
target : Ext.dom.Element
The target Element
position : Number
The position within the target to render the item to
Iterates over all passed items, ensuring they are rendered. If the items are already rendered, also determines if the items are in the proper place in the dom.
items : Object
target : Object
Sets a single/multiple configuration options.
name : String/Object
The name of the property to set, or a set of key value pairs to set.
value : Object (optional)
The value to set for the name parameter.
this
Get the reference to the class from which this object was instantiated. Note that unlike
Ext.Base#self, this.statics() is scope-independent and it always returns
the class from which it was called, regardless of what this points to during run-time
Ext.define('My.Cat', {
statics: {
totalCreated: 0,
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
var statics = this.statics();
// always equals to 'Cat' no matter what 'this' refers to
// equivalent to: My.Cat.speciesName
alert(statics.speciesName);
alert(this.self.speciesName); // dependent on 'this'
statics.totalCreated++;
},
clone: function() {
var cloned = new this.self(); // dependent on 'this'
// equivalent to: My.Cat.speciesName
cloned.groupName = this.statics().speciesName;
return cloned;
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
},
constructor: function() {
this.callParent();
}
});
var cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
alert(clone.groupName); // alerts 'Cat'
alert(My.Cat.totalCreated); // alerts 3
Destroys a given set of linked objects. This is only needed if
the linked object is being destroyed before this instance.
names : String[]
The names of the linked objects to destroy.
this
Watches config properties.
instance.watchConfig({
title: 'onTitleChange',
scope: me
});
Available since: 6.7.0
name : Object
fn : Object
scope : Object
Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.
config : Object
mixinClass : Ext.Class (optional)
The mixin class if the configs are from a mixin.
name : Object
member : Object
privacy : Object
Add methods / properties to the prototype of this class.
Ext.define('My.awesome.Cat', {
constructor: function() {
...
}
});
My.awesome.Cat.addMembers({
meow: function() {
alert('Meowww...');
}
});
var kitty = new My.awesome.Cat();
kitty.meow();
members : Object
The members to add to this class.
isStatic : Boolean (optional)
Pass true if the members are static.
Defaults to: false
privacy : Boolean (optional)
Pass true if the members are private. This
only has meaning in debug mode and only for methods.
Defaults to: false
Add / override static properties of this class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.addStatics({
someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'
method1: function() { ... }, // My.cool.Class.method1 = function() { ... };
method2: function() { ... } // My.cool.Class.method2 = function() { ... };
});
members : Object
this
Borrow another class' members to the prototype of this class.
Ext.define('Bank', {
money: '$$$',
printMoney: function() {
alert('$$$$$$$');
}
});
Ext.define('Thief', {
...
});
Thief.borrow(Bank, ['money', 'printMoney']);
var steve = new Thief();
alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'
fromClass : Ext.Base
The class to borrow members from
members : Array/String
The names of the members to borrow
this
Create a new instance of this Class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.create({
someConfig: true
});
All parameters are passed to the constructor of the class.
the created instance.
Create aliases for existing prototype methods. Example:
Ext.define('My.cool.Class', {
method1: function() { ... },
method2: function() { ... }
});
var test = new My.cool.Class();
My.cool.Class.createAlias({
method3: 'method1',
method4: 'method2'
});
test.method3(); // test.method1()
My.cool.Class.createAlias('method5', 'method3');
test.method5(); // test.method3() -> test.method1()
alias : String/Object
The new method name, or an object to set multiple aliases. See flexSetter
origin : String/Object
The original method name
Returns the Ext.Configurator for this class.
Get the current class' name in string format.
Ext.define('My.cool.Class', {
constructor: function() {
alert(this.self.getName()); // alerts 'My.cool.Class'
}
});
My.cool.Class.getName(); // 'My.cool.Class'
className
Used internally by the mixins pre-processor
name : Object
mixinClass : Object
Override members of this class. Overridden methods can be invoked via 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
The background-color of the Accordion layout element
Defaults to:
#fff
The background-color of the Accordion layout element
Defaults to:
#fff
The body border-width of Accordion layout element
Defaults to:
0
The body border-width of Accordion layout element
Defaults to:
0
The background-color of Accordion headers
Defaults to:
$base-color
The background-color of Accordion headers
Defaults to:
$base-color
The border-color of Accordion headers
Defaults to:
$panel-header-border-color
The border-color of Accordion headers
Defaults to:
$panel-header-border-color
The border-width of Accordion headers
Defaults to:
1px 0
The border-width of Accordion headers
Defaults to:
1px 0
The text color of Accordion headers
Defaults to:
$panel-header-color
The text color of Accordion headers
Defaults to:
$panel-header-color
The background color of Accordion panel title text when header is focused
Defaults to:
$panel-header-focus-background-color
The background color of Accordion panel title text when header is focused
Defaults to:
$panel-header-focus-background-color
The color of Accordion panel title text when header is focused
Defaults to:
$panel-header-focus-color
The color of Accordion panel title text when header is focused
Defaults to:
$panel-header-focus-color
The color of the outline around focused Accordion panel title
Defaults to:
$panel-header-focus-outline-color
The color of the outline around focused Accordion panel title
Defaults to:
$panel-header-focus-outline-color
The offset for focused Accordion panel title outline
Defaults to:
$panel-header-focus-outline-offset
The offset for focused Accordion panel title outline
Defaults to:
$panel-header-focus-outline-offset
The outline style of the focused Accordion panel title
Defaults to:
$panel-header-focus-outline-style
The outline style of the focused Accordion panel title
Defaults to:
$panel-header-focus-outline-style
The outline width of the focused Accordion panel title
Defaults to:
$panel-header-focus-outline-width
The outline width of the focused Accordion panel title
Defaults to:
$panel-header-focus-outline-width
The font-family of Accordion headers
Defaults to:
$font-family
The font-family of Accordion headers
Defaults to:
$font-family
The font-weight of Accordion headers
Defaults to:
$font-weight
The font-weight of Accordion headers
Defaults to:
$font-weight
The background-color of Accordion headers when hovered
Defaults to:
$accordion-header-background-color
The background-color of Accordion headers when hovered
Defaults to:
$accordion-header-background-color
The text-transform property of Accordion headers
Defaults to:
none
The text-transform property of Accordion headers
Defaults to:
none
The size of Ext.panel.Tool in Accordion headers
Defaults to:
$tool-size
The size of Ext.panel.Tool in Accordion headers
Defaults to:
$tool-size
The sprite image to use for Ext.panel.Tool in Accordion headers
Defaults to:
'tools/tool-sprites'
The sprite image to use for Ext.panel.Tool in Accordion headers
Defaults to:
'tools/tool-sprites'
Glyph for the Accordion's "collapse" tool icon when Global_CSS#$enable-font-icons is true.
Defaults to:
$fa-var-minus $accordion-tool-glyph-font-size $font-icon-font-family
Glyph for the Accordion's "collapse" tool icon when Global_CSS#$enable-font-icons is true.
Defaults to:
$fa-var-minus $accordion-tool-glyph-font-size $font-icon-font-family
Glyph for the Accordion's "expand" tool icon when Global_CSS#$enable-font-icons is true.
Defaults to:
$fa-var-plus $accordion-tool-glyph-font-size $font-icon-font-family
Glyph for the Accordion's "expand" tool icon when Global_CSS#$enable-font-icons is true.
Defaults to:
$fa-var-plus $accordion-tool-glyph-font-size $font-icon-font-family
The background color of focused Accordion panel header tool
Defaults to:
$panel-tool-focus-background-color
The background color of focused Accordion panel header tool
Defaults to:
$panel-tool-focus-background-color
The background image sprite to use for focused Accordion panel tools
Defaults to:
$panel-tool-focus-background-image
The background image sprite to use for focused Accordion panel tools
Defaults to:
$panel-tool-focus-background-image
The text color of focused Accordion panel header tool glyph
Defaults to:
$panel-tool-focus-color
The text color of focused Accordion panel header tool glyph
Defaults to:
$panel-tool-focus-color
The color of the outline around focused Accordion panel header tools
Defaults to:
$panel-tool-focus-outline-color
The color of the outline around focused Accordion panel header tools
Defaults to:
$panel-tool-focus-outline-color
The offset of the outline around focused Accordion panel header tools
Defaults to:
$panel-tool-focus-outline-offset
The offset of the outline around focused Accordion panel header tools
Defaults to:
$panel-tool-focus-outline-offset
The style of the outline around focused Accordion panel header tools
Defaults to:
$panel-tool-focus-outline-style
The style of the outline around focused Accordion panel header tools
Defaults to:
$panel-tool-focus-outline-style
The width of the outline around focused Accordion panel header tools
Defaults to:
$panel-tool-focus-outline-width
The width of the outline around focused Accordion panel header tools
Defaults to:
$panel-tool-focus-outline-width
The color to use for Accordion expand/collapse tool icons when Global_CSS#$enable-font-icons is true.
Defaults to:
$tool-glyph-color
The color to use for Accordion expand/collapse tool icons when Global_CSS#$enable-font-icons is true.
Defaults to:
$tool-glyph-color
The font size to use for Accordion expand/collapse tool icons when Global_CSS#$enable-font-icons is true.
Defaults to:
16px
The font size to use for Accordion expand/collapse tool icons when Global_CSS#$enable-font-icons is true.
Defaults to:
16px
Creates a visual theme for a Ext.layout.container.boxOverflow.Scroller
$ui : String
The name of the UI being created. Can not included spaces or special punctuation (used in CSS class names).
$type : String
The type of component that this box scroller will be used with. For example 'toolbar' or 'tab-bar'
$horizontal-width : Number (optional)
The width of horizontal scroller buttons
Defaults to: 16px
$horizontal-height : Number (optional)
The height of horizontal scroller buttons
Defaults to: 16px
$vertical-width : Number (optional)
The width of vertical scroller buttons
Defaults to: 16px
$vertical-height : Number (optional)
The height of vertical scroller buttons
Defaults to: 16px
$top-margin : Number/list (optional)
The margin of the "top" scroller button
Defaults to: 0
$right-margin : Number/list (optional)
The margin of the "right" scroller button
Defaults to: 0
$bottom-margin : Number/list (optional)
The margin of the "bottom" scroller button
Defaults to: 0
$left-margin : Number/list (optional)
The margin of the "left" scroller button
Defaults to: 0
$top-background-image : Number/list
The background-image of the "top" scroller button
$right-background-image : Number/list
The background-image of the "right" scroller button
$bottom-background-image : Number/list
The background-image of the "bottom" scroller button
$left-background-image : Number/list
The background-image of the "left" scroller button
$glyph-color : color
The color of the scroller button icons
$top-glyph : Number/list
The glyph for the "top" scroller button
$right-glyph : Number/list
The glyph for the "right" scroller button
$bottom-glyph : Number/list
The glyph for the "bottom" scroller button
$left-glyph : Number/list
The glyph for the "left" scroller button
$horizontal-border-color : Number (optional)
The border color of the scroller buttons
Defaults to: $base-color
$horizontal-border-width : Number (optional)
The border-width of the scroller buttons
Defaults to: 0
$vertical-border-color : Number (optional)
The border-width of the scroller buttons
Defaults to: $base-color
$vertical-border-width : Number (optional)
The border-width of the scroller buttons
Defaults to: 0
$container-padding : Number/list (optional)
The padding of the container that these scroller buttons will be used in. Used for setting margin offsets of the inner layout element to reserve space for the scrollers.
Defaults to: 0
$cursor : String (optional)
The type of cursor to display when the mouse is over a scroller button
Defaults to: pointer
$cursor-disabled : String (optional)
The type of cursor to display when the mouse is over a disabled scroller button
Defaults to: default
$align : String (optional)
Vertical alignment of the scroller buttons, or horizontal align of vertically oriented scroller buttons. Can be one of the following values:
beginmiddleendstretchDefaults to: middle
$align-offset : String (optional)
Number of pixels to offset the alignment of the scroller.
Only applicable when align is middle.
Defaults to: 0
$opacity : Number (optional)
The opacity of the scroller buttons. Only applicable when $classic is false.
Defaults to: 0.6
$opacity-over : Number (optional)
The opacity of hovered scroller buttons. Only applicable when $classic is false.
Defaults to: 0.8
$opacity-pressed : Number (optional)
The opacity of pressed scroller buttons. Only applicable when $classic is false.
Defaults to: 1
$opacity-disabled : Number (optional)
The opacity of disabled scroller buttons. Only applicable when $classic is false.
Defaults to: 0.25
$classic : Boolean (optional)
true to use classic-style scroller buttons. When true scroller buttons are given
their hover state by changing their background-position, When false scroller buttons
are given their hover state by applying opacity.
Defaults to: false
$include-horizontal : Boolean (optional)
true to include horizontal
Defaults to: true
$include-vertical : Boolean (optional)
true to include vertical
Defaults to: true
$include-background-images : Boolean (optional)
true to include background-images
Defaults to: true
Ext JS | Terms of Use