Docs Help

Terms, Icons, and Labels

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

Access Levels

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

Member Types

Member Syntax

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

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

Member Flags

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

Class Icons

- Indicates a framework class

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

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

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

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

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

Class Member Quick-Nav Menu

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

Getter and Setter Methods

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

History Bar

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

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

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

Search and Filters

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

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

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

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

API Doc Class Metadata

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

Expanding and Collapsing Examples and Class Members

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

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

Desktop -vs- Mobile View

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

Viewing the Class Source

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

Ext JS 6.2.0 - Classic Toolkit


top

Ext.layout.container.VBox layout: layout.vbox

Summary

A layout that arranges items vertically down a Ext.container.Container. This layout optionally divides available vertical space between child items containing a numeric flex configuration.

This layout may also be used to set the widths of child items by configuring it with the align option. The vertical position of the child items may be set using the pack config.

The following example may be used to view the outcomes when combining the align and pack configs:

No members found using the current filters

configs

Optional Configs

align : String

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:

  • begin : Child items are aligned vertically at the top of the container.
  • middle : Child items are vertically centered in the container.
  • end : Child items are aligned vertically at the bottom of the container.
  • stretch : Child items are stretched vertically to fill the height of the container.
  • stretchmax : Child items are stretched vertically to the height of the largest item.

If vertical is true then this layout is behaving as an vbox and this config operates as follows:

  • begin : Child items are aligned horizontally at the left side of the container.
  • middle : Child items are horizontally centered in the container.
  • end : Child items are aligned horizontally at the right of the container.
  • stretch : Child items are stretched horizontally to fill the width of the container.
  • stretchmax : Child items are stretched horizontally to the size of the largest item.

For backwards compatibility, the following values are also recognized:

  • left : Same as begin.
  • top : Same as begin.
  • center : Same as middle.
  • right : Same as end.
  • bottom : Same as end.

Defaults to:

"begin"

getAlign : String

Returns the value of align

Returns

String

setAlign (align)

Sets the value of align

Parameters

align :  String

alignRoundingMethod : "round" / "floor" / "ceil"

The Math method to use for rounding fractional pixels when align:middle is used. The possible values are:

Defaults to:

'round'

getAlignRoundingMethod : "round" / "floor" / "ceil"

Returns the value of alignRoundingMethod

Returns

"round" / "floor" / "ceil"

setAlignRoundingMethod (alignRoundingMethod)

Sets the value of alignRoundingMethod

Parameters

alignRoundingMethod :  "round" / "floor" / "ceil"

animatePolicy : Object
protected pro

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

childEls : Object / String[] / Object[]

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:

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:

  • Performance: using selectors can be 10x slower than id lookup.
  • Over-selecting: selectors are applied after the DOM elements for all children have been rendered, so selectors can match elements from child components (including nested versions of the same component) accidentally.

This above issues are most important when using select since it returns multiple elements.

Defaults to:

{}

getChildEls : Object / String[] / Object[]

Returns the value of childEls

Returns

Object / String[] / Object[]

setChildEls (childEls)

Sets the value of childEls

Parameters

childEls :  Object / String[] / Object[]

constrainAlign : Boolean

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

getConstrainAlign : Boolean

Returns the value of constrainAlign

Returns

Boolean

setConstrainAlign (constrainAlign)

Sets the value of constrainAlign

Parameters

constrainAlign :  Boolean

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

getEnableSplitters : Boolean

Returns the value of enableSplitters

Returns

Boolean

setEnableSplitters (enableSplitters)

Sets the value of enableSplitters

Parameters

enableSplitters :  Boolean

itemCls : String

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.

overflowHandler : String / Ext.layout.container.boxOverflow.None

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

setOverflowHandler (overflowHandler)

Sets the value of overflowHandler

Parameters

overflowHandler :  String / Ext.layout.container.boxOverflow.None

pack : String

Controls how the child items of the container are packed together. Acceptable configuration values for this property are:

  • start - child items are packed together at left (HBox) or top (VBox) side of container (default*)
  • center - child items are packed together at mid-width (HBox) or mid-height (VBox) of container
  • end - child items are packed together at right (HBox) or bottom (VBox) side of container

Defaults to:

'start'

getPack : String

Returns the value of pack

Returns

String

setPack (pack)

Sets the value of pack

Parameters

pack :  String

padding : String

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:

  • If there is only one value, it applies to all sides.
  • If there are two values, the top and bottom borders are set to the first value and the right and left are set to the second.
  • If there are three values, the top is set to the first value, the left and right are set to the second, and the bottom is set to the third.
  • If there are four values, they apply to the top, right, bottom, and left, respectively.

Defaults to:

0

getPadding : String

Returns the value of padding

Returns

String

setPadding (padding)

Sets the value of padding

Parameters

padding :  String

stretchMaxPartner : String / Ext.Component

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

getStretchMaxPartner : String / Ext.Component

Returns the value of stretchMaxPartner

Returns

String / Ext.Component

setStretchMaxPartner (stretchMaxPartner)

Sets the value of stretchMaxPartner

Parameters

stretchMaxPartner :  String / Ext.Component

vertical : Boolean

Set to true to switch the layout to vbox.

Defaults to:

false

getVertical : Boolean

Returns the value of vertical

Returns

Boolean

setVertical (vertical)

Sets the value of vertical

Parameters

vertical :  Boolean

properties

Instance Properties

$className
private pri

Defaults to:

'Ext.Base'

$configPrefixed : Boolean
private pri

The value true causes config values to be stored on instances using a property name prefixed with an underscore ("_") character. A value of false stores config values as properties using their exact name (no prefix).

Defaults to:

true

Available since: 5.0.0

$configStrict : Boolean
private pri

The value true instructs the initConfig method to only honor values for properties declared in the config block of a class. When false, properties that are not declared in a config block will be placed on the instance.

Defaults to:

true

Available since: 5.0.0

activeItemCount
private pri

tracks the number of child items that do not use "liquid" CSS layout

Defaults to:

0

animatePolicy
private pri

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

beginCollapse
private pri

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

beginExpand
private pri

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

clearPropertiesOnDestroy : Boolean / "async"
protected pro

Setting this property to false will prevent nulling object references on a Class instance after destruction. Setting this to "async" will delay the clearing for approx 50ms.

Defaults to:

true

Available since: 6.2.0

clearPrototypeOnDestroy : Boolean
private pri

Setting this property to true will result in setting the object's prototype to null after the destruction sequence is fully completed. After that, most attempts at calling methods on the object instance will result in "method not defined" exception. This can be very helpful with tracking down otherwise hard to find bugs like runaway Ajax requests, timed functions not cleared on destruction, etc.

Note that this option can only work in browsers that support Object.setPrototypeOf method, and is only available in debugging mode.

Defaults to:

false

Available since: 6.2.0

destroyed : Boolean
protected pro

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

Defaults to:

false

done : Boolean

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.

factoryConfig : Object

If this property is specified by the target class of this mixin its properties are used to configure the created Ext.Factory.

isConfiguring : Boolean
readonly ro protected pro

This property is set to true during the call to initConfig.

Defaults to:

false

Available since: 5.0.0

isFirstInstance : Boolean
readonly ro protected pro

This property is set to true if this instance is the first of its class.

Defaults to:

false

Available since: 5.0.0

isInstance : Boolean
readonly ro protected pro

This value is true and is used to identify plain objects from instances of a defined class.

Defaults to:

true

isLayout : Boolean
readonly ro

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

Defaults to:

true

needsItemSize
private pri

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

self : Ext.Class
protected pro

Get the reference to the current class from which this object was instantiated. Unlike Ext.Base#statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base#statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Defaults to:

Base

setsItemSize
private pri

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

Static Properties

$onExtended
static sta private pri

Defaults to:

[]

methods

Instance Methods

addChildEl ( childEl )
private pri

Add a childEl specific to this instance. This must be called before render.

Available since: 6.0.0

Parameters

childEl :  Object

addDeprecations ( deprecations )
private pri

This method applies a versioned, deprecation declaration to this class. This is typically called by the deprecated config.

Parameters

deprecations :  Object

afterClassMixedIn ( targetClass )
private pri

Called after the mixin is applied. We need to see if childEls were used by the targetClass and apply them to the config.

Parameters

targetClass :  Ext.Class

afterCollapse ( owner, animated )
private pri

Called by an owning Panel after the Panel finishes its collapse process.

Parameters

owner :  Object

animated :  Object

afterExpand ( owner, animated )
private pri

Called by an owning Panel after the Panel finishes its expand process.

Parameters

owner :  Object

animated :  Object

afterRemove ( item )
protected pro

Removes layout's itemCls and owning Container's itemCls. Clears the managed dimensions flags

Parameters

item :  Object

attachChildEls ( el, owner )
private pri

Sets references to elements inside the component.

Parameters

el :  Object

owner :  Object

beginCollapse ( child )
private pri

Called by an owning Panel before the Panel begins its collapse process. Most layouts will not need to override the default Ext.emptyFn implementation.

Parameters

child :  Object

beginExpand ( child )
private pri

Called by an owning Panel before the Panel begins its expand process. Most layouts will not need to override the default Ext.emptyFn implementation.

Parameters

child :  Object

beginLayout ( ownerContext )

In addition to work done by our base classes, containers benefit from some extra cached data. The following properties are added to the ownerContext:

  • visibleItems: the result of getVisibleItems
  • childItems: the ContextItem[] for each visible item
  • targetContext: the ContextItem for the getTarget element

Parameters

ownerContext :  Object

beginLayoutCycle ( ownerContext )

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.

Parameters

ownerContext :  Ext.layout.ContextItem

The context item for the layout's owner component.

cacheFlexes ( ownerContext )
protected pro

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

Parameters

ownerContext :  Object

calculate ( ownerContext )
abstract abs

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.

Parameters

ownerContext :  Ext.layout.ContextItem

The context item for the layout's owner component.

callOverridden ( args ) : Object
deprecated dep protected pro

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

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

Parameters

args :  Array/Arguments

The arguments, either an array or the `arguments` object from the current method, for example: `this.callOverridden(arguments)`

Returns

:Object
Returns the result of calling the overridden method

Deprecated since version 4.1.0

callParent ( args ) : Object
protected pro

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext#define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static and private methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10));     // alerts 10
 alert(My.Derived2.method(10)); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     // privates: {
     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

To override a method and replace it and also call the superclass method, use method-callSuper. This is often done to patch a method to fix a bug.

Parameters

args :  Array/Arguments

The arguments, either an array or the `arguments` object from the current method, for example: `this.callParent(arguments)`

Returns

:Object
Returns the result of calling the parent method

callSuper ( args ) : Object
protected pro

This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     extend: 'Ext.some.Class',

     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an override:

 Ext.define('App.patches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

The patch method cannot use method-callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

Parameters

args :  Array/Arguments

The arguments, either an array or the `arguments` object from the current method, for example: `this.callSuper(arguments)`

Returns

:Object
Returns the result of calling the superclass method

completeLayout ( ownerContext )

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.

Parameters

ownerContext :  Ext.layout.ContextItem

The context item for the layout's owner component.

configureItem ( item )
protected pro

Adds layout's itemCls and owning Container's itemCls

Parameters

item :  Object

destroy
protected pro

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.

finalizeLayout ( ownerContext )

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.

Parameters

ownerContext :  Ext.layout.ContextItem

The context item for the layout's owner component.

finishedLayout ( ownerContext )

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.

Parameters

ownerContext :  Ext.layout.ContextItem

The context item for the layout's owner component.

getConfig ( [name], [peek] ) : Object

Returns a specified config property value. If the name parameter is not passed, all current configuration options will be returned as key value pairs.

Parameters

name :  String (optional)

The name of the config property to get.

peek :  Boolean (optional)

`true` to peek at the raw value without calling the getter.

Defaults to: false

Returns

:Object
The config property value.

getContainerSize ( ownerContext, [inDom] ) : Object
protected pro

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.

Parameters

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

Returns

:Object
The size

width :  Number

The width

height :  Number

The height

getElementTarget Ext.dom.Element

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

:Ext.dom.Element

getInitialConfig ( [name] ) : Object/Mixed

Returns the initial configuration passed to the constructor when instantiating this class.

Given this example Ext.button.Button definition and instance:

Ext.define('MyApp.view.Button', {
    extend: 'Ext.button.Button',
    xtype: 'mybutton',

    scale: 'large',
    enableToggle: true
});

var btn = Ext.create({
    xtype: 'mybutton',
    renderTo: Ext.getBody(),
    text: 'Test Button'
});

Calling btn.getInitialConfig() would return an object including the config options passed to the create method:

xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'

Calling btn.getInitialConfig('text')returns 'Test Button'.

Parameters

name :  String (optional)

Name of the config option to return.

Returns

:Object/Mixed
The full config object or a single config value when `name` parameter specified.

getItemLayoutEl ( item ) : HTMLElement
private pri

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

Parameters

item :  Ext.Component

Returns

:HTMLElement

getItemSizePolicy ( item ) : Ext.layout.SizePolicy
protected pro

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.

Parameters

item :  Ext.Component

Returns

:Ext.layout.SizePolicy
An object describing the sizing done by the layout for this item.

getLayoutItems Ext.Component[]

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

Returns

:Ext.Component[]
of child components

getRenderTarget Ext.dom.Element

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

:Ext.dom.Element

getRenderedItems Array
protected pro

Returns all items that are rendered

Returns

:Array
All matching items

getTarget Ext.dom.Element

Returns the owner component's resize element.

Returns

:Ext.dom.Element

getVisibleItems Array
protected pro

Returns all items that are both rendered and visible

Returns

:Array
All matching items

hasConfig ( name )
private pri

Parameters

name :  String

initConfig ( instanceConfig ) : Ext.Base
chainable ch protected pro

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Parameters

instanceConfig :  Object

Returns

:Ext.Base
this

initLayout
protected pro

A one-time initialization method called just before rendering.

insertSplitter ( item, index, hidden, splitterCfg )
private pri

Inserts the splitter for a given region. A reference to the splitter is also stored on the component as "splitter".

Parameters

item :  Object

index :  Object

hidden :  Object

splitterCfg :  Object

isValidParent ( item, target, position ) : Boolean
protected pro

Validates item is in the proper place in the dom.

Parameters

item :  Object

target :  Object

position :  Object

Returns

:Boolean

moveItem ( item, target, position )
private pri

Moves Component to the provided target instead.

Parameters

item :  Object

target :  Object

position :  Object

notifyOwner
private pri

Called for every layout in the layout context after all the layouts have been finally flushed

onContentChange ( child ) : Boolean

This method is called when a child item changes in some way. By default this calls Ext.Component#updateLayout on this layout's owner.

Parameters

child :  Ext.Component

The child item that has changed.

Returns

:Boolean
True if this layout has handled the content change.

renderItem ( item, target, position )
private pri

Renders the given Component into the target Element.

Parameters

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

renderItems ( items, target )
protected pro

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.

Parameters

items :  Object

target :  Object

setConfig ( name, [value] ) : Ext.Base
chainable ch

Sets a single/multiple configuration options.

Parameters

name :  String/Object

The name of the property to set, or a set of key value pairs to set.

value :  Object (optional)

The value to set for the name parameter.

Returns

:Ext.Base
this

setOwner ( owner )
private pri

Sets the layout owner

Parameters

owner :  Object

statics Ext.Class
protected pro

Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

Ext.define('My.Cat', {
    statics: {
        totalCreated: 0,
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        var statics = this.statics();

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

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

        statics.totalCreated++;
    },

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

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Returns

:Ext.Class
Static Methods

addConfig ( config, [mixinClass] )
static sta private pri

Adds new config properties to this class. This is called for classes when they are declared, then for any mixins that class may define and finally for any overrides defined that target the class.

Parameters

config :  Object

mixinClass :  Ext.Class (optional)

The mixin class if the configs are from a mixin.

addInheritableStatics ( members ) :
chainable ch static sta private pri

Parameters

members :  Object

Returns

:

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

Parameters

name :  Object

member :  Object

Returns

:

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

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat();
 kitty.meow();

Parameters

members :  Object

The members to add to this class.

isStatic :  Boolean (optional)

Pass `true` if the members are static.

Defaults to: false

privacy :  Boolean (optional)

Pass `true` if the members are private. This only has meaning in debug mode and only for methods.

Defaults to: false

Returns

:

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

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Parameters

members :  Object

Returns

:Ext.Base
this

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

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

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Parameters

fromClass :  Ext.Base

The class to borrow members from

members :  Array/String

The names of the members to borrow

Returns

:Ext.Base
this

callParent ( args )
static sta protected pro

Parameters

args :  Object

callSuper ( args )
static sta protected pro

Parameters

args :  Object

create Object
static sta

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Returns

:Object
the created instance.

createAlias ( alias, origin )
static sta

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Parameters

alias :  String/Object

The new method name, or an object to set multiple aliases. See flexSetter

origin :  String/Object

The original method name

extend ( parentClass )
static sta private pri

Parameters

parentClass :  Object

getConfigurator Ext.Configurator
static sta private pri

Returns the Ext.Configurator for this class.

Returns

:Ext.Configurator

getName String
static sta

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Returns

:String
className

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

Used internally by the mixins pre-processor

Parameters

name :  Object

mixinClass :  Object

Returns

:

onExtended ( fn, scope ) :
chainable ch static sta private pri

Parameters

fn :  Object

scope :  Object

Returns

:

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

Override members of this class. Overridden methods can be invoked via 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).

Parameters

members :  Object

The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

:Ext.Base
this class

triggerExtended
static sta private pri

theme mixins

extjs-box-scroller-ui ( ...list... )
private pri

Creates a visual theme for a Ext.layout.container.boxOverflow.Scroller

Parameters

$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

$border-color :  color (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-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: - `begin` - `middle` - `end` - `stretch`

Defaults 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

Ext JS 6.2.0 - Classic Toolkit