Notes

$className : Stringprivate

...

Defaults to: 'Ext.Base'

animatePolicy : Objectprivate

An object which contains boolean properties specifying which properties are to be\nanimated upon flush of child Compon...

An object which contains boolean properties specifying which properties are to be\nanimated upon flush of child Component ContextItems. For example, Accordion would\nhave:

\n\n

 {\n     y: true,\n     height: true\n }\n

autoSizePolicy : Objectprivate

...

Defaults to: {readsWidth: 1, readsHeight: 1, setsWidth: 0, setsHeight: 0}

Ext.layout.container.Border
view source

axisProps : Objectprivate

Reused meta-data objects that describe axis properties. ...

Reused meta-data objects that describe axis properties.

Defaults to: {horz: {borderBegin: 'west', borderEnd: 'east', horizontal: true, posProp: 'x', sizeProp: 'width', sizePropCap: 'Width'}, vert: {borderBegin: 'north', borderEnd: 'south', horizontal: false, posProp: 'y', sizeProp: 'height', sizePropCap: 'Height'}}

Ext.layout.container.Border
view source

centerRegion : Objectprivate

childEls : Arrayprivate

...

Defaults to: ['overflowPadderEl']

Overrides: Ext.util.ElementContainer.childEls

configMap : Objectprivate

...

Defaults to: {}

done : Boolean

Used only during a layout run, this value indicates that a\nlayout has finished its calculations. ...

Used only during a layout run, this value indicates that a\nlayout has finished its calculations. This flag is set to true prior to the call to\ncalculate and should be set to false if this layout has more work to do.

Ext.layout.container.Border
view source

horzMarginProp : Stringprivate

...

Defaults to: 'left'

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

initialized : Booleanprivate

...

Defaults to: false

Ext.layout.container.Border
view source

isBorderLayout : Booleanprivate

...

Defaults to: true

isInstance : Booleanprivate

...

Defaults to: true

isLayout : Booleanreadonly

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

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

Defaults to: true

Ext.layout.container.Border
view source

manageMargins : Booleanprivate

...

Defaults to: true

overflowPadderEl : Ext.Element

The element used to correct body padding during overflow.

Ext.layout.container.Border
view source

padNotOnContainerProp : Stringprivate

...

Defaults to: 'right'

Ext.layout.container.Border
view source

padOnContainerProp : Stringprivate

...

Defaults to: 'left'

Ext.layout.container.Border
view source

panelCollapseAnimate : Booleanprivate

...

Defaults to: true

Ext.layout.container.Border
view source

panelCollapseMode : Stringprivate

...

Defaults to: 'placeholder'

Ext.layout.container.Border
view source

percentageRe : RegExpprivate

...

Defaults to: /(\\d+)%/

Ext.layout.container.Border
view source

regionFlags : Objectprivate

Flags and configs that get set of regions based on their region property. ...

Flags and configs that get set of regions based on their region property.

Defaults to: {center: {isCenter: true, isHorz: false, isVert: false}, north: {isCenter: false, isHorz: false, isVert: true, collapseDirection: 'top'}, south: {isCenter: false, isHorz: false, isVert: true, collapseDirection: 'bottom'}, west: {isCenter: false, isHorz: true, isVert: false, collapseDirection: 'left'}, east: {isCenter: false, isHorz: true, isVert: false, collapseDirection: 'right'}}

Ext.layout.container.Border
view source

regionMeta : Objectprivate

\n\n

Misc

\n\n

Misc

renderTpl : Arrayprivate

...

Defaults to: ['{%this.renderBody(out,values)%}']

running : Booleanprivate

...

Defaults to: false

self : Ext.Classprotected

Get the reference to the current class from which this object was instantiated. ...

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

\n\n

Ext.define('My.Cat', {\n    statics: {\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        alert(this.self.speciesName); // dependent on 'this'\n    },\n\n    clone: function() {\n        return new this.self();\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n    statics: {\n        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'\n    }\n});\n\nvar cat = new My.Cat();                     // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'\n

Ext.layout.container.Border
view source

sizePolicies : Objectprivate

...

Defaults to: {vert: {readsWidth: 0, readsHeight: 1, setsWidth: 1, setsHeight: 0}, horz: {readsWidth: 1, readsHeight: 0, setsWidth: 0, setsHeight: 1}, flexAll: {readsWidth: 0, readsHeight: 0, setsWidth: 1, setsHeight: 1}}

Ext.layout.container.Border
view source

targetCls : Stringprivate

...

Defaults to: Ext.baseCSSPrefix + 'border-layout-ct'

Ext.layout.container.Border
view source

touchedRegions : Objectprivate

Lists the regions that would consider an interior region a neighbor. ...

Lists the regions that would consider an interior region a neighbor. For example,\na north region would consider an east or west region its neighbords (as well as\nan inner north region).

Defaults to: {center: ['north', 'south', 'east', 'west'], north: ['north', 'east', 'west'], south: ['south', 'east', 'west'], east: ['east', 'north', 'south'], west: ['west', 'north', 'south']}

Ext.layout.container.Border
view source

type : Stringprivate

...

Defaults to: 'border'

Overrides: Ext.layout.container.Container.type

usesContainerHeight : Booleanprivate

...

Defaults to: true

usesContainerWidth : Booleanprivate

...

Defaults to: true

usesHeight : Booleanprivate

...

Defaults to: true

usesWidth : Booleanprivate

...

Defaults to: true

Defined By

Static Properties

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

newExt.layout.container.Border( ) : Ext.layout.container.Container

...

Returns

Ext.layout.container.Container
\n

Overrides: Ext.util.ElementContainer.constructor

addChildEls( )

Adds each argument passed to this method to the childEls array. ...

Adds each argument passed to this method to the childEls array.

afterRemove( item )protected

Removes layout's itemCls and owning Container's itemCls. ...

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

Parameters

item : Object
\n

afterRenderItem( )private

...

applyChildEls( el, id )private

Sets references to elements inside the component. ...

Sets references to elements inside the component.

Parameters

el : Object
\n
id : Object
\n

Ext.layout.container.Border
view source

beginAxis( ownerContext, regions, name )private

Creates the axis objects for the layout. ...

Creates the axis objects for the layout. These are only missing size information\nwhich is added during calculate.

Parameters

ownerContext : Object
\n
regions : Object
\n
name : Object
\n

beginCollapse( )private

Called by an owning Panel before the Panel begins its collapse process. ...

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

beginExpand( )private

Called by an owning Panel before the Panel begins its expand process. ...

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

Ext.layout.container.Border
view source

beginLayout( ownerContext )

In addition to work done by our base classes, containers benefit from some extra\ncached data. ...

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

\n\n

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

\n\n

Parameters

ownerContext : Object
\n

Overrides: Ext.layout.container.Container.beginLayout

beginLayoutCycle( ownerContext )

Called before any calculation cycles to reset DOM values and prepare for calculation. ...

Called before any calculation cycles to reset DOM values and prepare for calculation.

\n\n

This is a write phase and DOM reads should be strictly avoided when overridding\nthis method.

Parameters

ownerContext : Ext.layout.ContextItem
The context item for the layout's owner\ncomponent.
\n\n\n\n

Overrides: Ext.layout.Layout.beginLayoutCycle

cacheChildItems( ownerContext )private

...

Parameters

ownerContext : Object
\n

cacheElements( )private

...

Ext.layout.container.Border
view source

calculate( ownerContext )abstract

Called to perform the calculations for this layout. ...

Called to perform the calculations for this layout. This method will be called at\nleast once and may be called repeatedly if the done property is cleared\nbefore return to indicate that this layout is not yet done. The done property\nis always set to true before entering this method.

\n\n

This is a read phase and DOM writes should be strictly avoided in derived classes.\nInstead, DOM writes need to be written to Ext.layout.ContextItem objects to\n be flushed at the next opportunity.

Parameters

ownerContext : Ext.layout.ContextItem
The context item for the layout's owner\ncomponent.
\n\n\n\n

Overrides: Ext.layout.Layout.calculate

Ext.layout.container.Border
view source

calculateChildAxis( childContext, axis )private

Performs the calculations for a region on a specified axis. ...

Performs the calculations for a region on a specified axis.

Parameters

childContext : Object
\n
axis : Object
\n

callOverridden( args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

callParent( args ) : Objectprotected

Call the \"parent\" method of the current method. ...

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

\n\n

 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n

\n\n

This can be used with an override as follows:

\n\n

 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n

\n\n

This also works with static methods.

\n\n

 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n

\n\n

Lastly, it also works with overridden static methods.

\n\n

 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n

\n\n

To override a method and replace it and also call the superclass method, use\ncallSuper. 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\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

callSuper( args ) : Objectprotected

This method is used by an override to call the superclass method but bypass any\noverridden method. ...

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

\n\n

Consider:

\n\n

 Ext.define('Ext.some.Class', {\n     method: function () {\n         console.log('Good');\n     }\n });\n\n Ext.define('Ext.some.DerivedClass', {\n     method: function () {\n         console.log('Bad');\n\n         // ... logic but with a bug ...\n\n         this.callParent();\n     }\n });\n

\n\n

To patch the bug in DerivedClass.method, the typical solution is to create an\noverride:

\n\n

 Ext.define('App.paches.DerivedClass', {\n     override: 'Ext.some.DerivedClass',\n\n     method: function () {\n         console.log('Fixed');\n\n         // ... logic but with bug fixed ...\n\n         this.callSuper();\n     }\n });\n

\n\n

The patch method cannot use callParent to call the superclass method since\nthat would call the overridden method containing the bug. In other words, the\nabove patch would only produce \"Fixed\" then \"Good\" in the console log, whereas,\nusing callParent would produce \"Fixed\" then \"Bad\" then \"Good\".

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callSuper(arguments)
\n

Returns

Object
Returns the result of calling the superclass method
\n

completeLayout( ownerContext )

This method (if implemented) is called at the end of the cycle in which this layout\ncompletes (by not setting done to...

This method (if implemented) is called at the end of the cycle in which this layout\ncompletes (by not setting done to false in calculate). It is\npossible for the layout to complete and yet become invalid before the end of the cycle,\nin which case, this method will not be called. It is also possible for this method to\nbe called and then later the layout becomes invalidated. This will result in\ncalculate being called again, followed by another call to this method.

\n\n

This is a read phase and DOM writes should be strictly avoided in derived classes.\nInstead, DOM writes need to be written to Ext.layout.ContextItem objects to\nbe flushed at the next opportunity.

\n\n

This method need not be implemented by derived classes and, in fact, should only be\nimplemented when needed.

Parameters

ownerContext : Ext.layout.ContextItem
The context item for the layout's owner\ncomponent.
\n

configClass( )private

...

configureItem( item )protected

Adds layout's itemCls and owning Container's itemCls ...

Adds layout's itemCls and owning Container's itemCls

Parameters

item : Object
\n

Overrides: Ext.layout.Layout.configureItem

destroy( )private

...

Overrides: Ext.util.ElementContainer.destroy

doRenderBody( out, renderData )private

...

Parameters

out : Object
\n
renderData : Object
\n

doRenderContainer( out, renderData )private

...

Parameters

out : Object
\n
renderData : Object
\n

doRenderItems( out, renderData )private

...

Parameters

out : Object
\n
renderData : Object
\n

finalizeLayout( ownerContext )

This method (if implemented) is called after all layouts have completed. ...

This method (if implemented) is called after all layouts have completed. In most\nways this is similar to completeLayout. This call can cause this (or any\nlayout) to be become invalid (see Ext.layout.Context.invalidate), but this\nis best avoided. This method is intended to be where final reads are made and so it\nis best to avoid invalidating layouts at this point whenever possible. Even so, this\nmethod can be used to perform final checks that may require all other layouts to be\ncomplete and then invalidate some results.

\n\n

This is a read phase and DOM writes should be strictly avoided in derived classes.\nInstead, DOM writes need to be written to Ext.layout.ContextItem objects to\nbe flushed at the next opportunity.

\n\n

This method need not be implemented by derived classes and, in fact, should only be\nimplemented when needed.

Parameters

ownerContext : Ext.layout.ContextItem
The context item for the layout's owner\ncomponent.
\n

Ext.layout.container.Border
view source

finishAxis( ownerContext, axis )private

Finishes the calculations on an axis. ...

Finishes the calculations on an axis. This basically just assigns the remaining\nspace to the center region.

Parameters

ownerContext : Object
\n
axis : Object
\n

Ext.layout.container.Border
view source

finishPositions( childItems )private

Finishes by setting the positions on the child items. ...

Finishes by setting the positions on the child items.

Parameters

childItems : Object
\n

finishRender( )private

...

Overrides: Ext.layout.Layout.finishRender

finishRenderItems( target, items )private

...

Parameters

target : Object
\n
items : Object
\n

finishedLayout( ownerContext )

This method is called after all layouts are complete and their calculations flushed\nto the DOM. ...

This method is called after all layouts are complete and their calculations flushed\nto the DOM. No further layouts will be run and this method is only called once per\nlayout run. The base component layout caches lastComponentSize.

\n\n

This is a write phase and DOM reads should be avoided if possible when overridding\nthis method.

\n\n

This method need not be implemented by derived classes and, in fact, should only be\nimplemented when needed.

Parameters

ownerContext : Ext.layout.ContextItem
The context item for the layout's owner\ncomponent.
\n

getAnimatePolicy( )private

...

getChildEls( )private

...

getClassChildEls( cls )private

...

Parameters

cls : Object
\n

getConfig( name )private

...

Parameters

name : Object
\n

getContainerSize( ownerContext, [inDom] ) : Objectprotected

Returns the container size (that of the target). ...

Returns the container size (that of the target). Only the fixed-sized dimensions can\nbe returned because the shrinkWrap dimensions are based on the contentWidth/Height\nas determined by the container layout.

Parameters

ownerContext : Ext.layout.ContextItem
The owner's context item.
\n
inDom : Boolean (optional)
True if the container size must be in the DOM.
\n
Defaults to: false

Returns

Object
The size
\n
- width : Number
  The width
  \n
- height : Number
  The height
  \n

getContentTarget( )private

...

getElementTarget( ) : Ext.Element

Returns the element into which extra functional DOM elements can be inserted. ...

Returns the element into which extra functional DOM elements can be inserted. Defaults to the owner Component's encapsulating element.

\n\n

May be overridden in Component layout managers which implement a component render target which must only\ncontain child components.

Returns

Ext.Element
\n

getInitialConfig( [name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

Ext.layout.container.Border
view source

getItemSizePolicy( item ) : Ext.layout.SizePolicyprotected

Returns an object describing how this layout manages the size of the given component. ...

Returns an object describing how this layout manages the size of the given component.\nThis method must be implemented by any layout that manages components.

Parameters

item : Ext.Component
\n

Returns

Ext.layout.SizePolicy
An object describing the sizing done by the layout\nfor this item.
\n

Overrides: Ext.layout.Layout.getItemSizePolicy

getItemsRenderTree( items, renderCfgs )private

...

Parameters

items : Object
\n
renderCfgs : Object
\n

Ext.layout.container.Border
view source

getLayoutItems( ) : Ext.Component[]

Returns an array of child components either for a render phase (Performed in the beforeLayout\nmethod of the layout's ...

Returns an array of child components either for a render phase (Performed in the beforeLayout\nmethod of the layout's base class), or the layout phase (onLayout).

Returns

Ext.Component[]
of child components
\n

Overrides: Ext.layout.container.Container.getLayoutItems

Ext.layout.container.Border
view source

getPlaceholder( comp )private

...

Parameters

comp : Object
\n

getPositionOffset( position )private

This method is used to offset the DOM position when checking\nwhether the element is a certain child of the target. ...

This method is used to offset the DOM position when checking\nwhether the element is a certain child of the target. This is\nrequired in cases where the extra elements prepended to the target\nbefore any of the items. An example of this is when using labelAlign: 'top'\non a field. The label appears first in the DOM before any child items are\ncreated, so when we check the position we need to add an extra offset.\nContainers that create an innerCt are exempt because this new element\npreserves the order

Parameters

position : Object
\n

Overrides: Ext.layout.Layout.getPositionOffset

getRenderData( )private

...

getRenderTarget( ) : Ext.Element

Returns the element into which rendering must take place. ...

Returns the element into which rendering must take place. Defaults to the owner Container's\ntarget element.

\n\n

May be overridden in layout managers which implement an inner element.

Returns

Ext.Element
\n

getRenderTpl( )private

...

getRenderTree( )private

...

getRenderedItems( ) : Arrayprotected

Returns all items that are rendered ...

Returns all items that are rendered

Returns

Array
All matching items
\n

getScrollbarsNeeded( width, height, contentWidth, contentHeight )private

...

Parameters

width : Object
\n
height : Object
\n
contentWidth : Object
\n
contentHeight : Object
\n

Ext.layout.container.Border
view source

getSplitterTarget( splitter )private

...

Parameters

splitter : Object
\n

getTarget( ) : Ext.Element

Returns the owner component's resize element. ...

Returns the owner component's resize element.

Returns

Ext.Element
\n

getVisibleItems( ) : Arrayprotected

Returns all items that are both rendered and visible ...

Returns all items that are both rendered and visible

Returns

Array
All matching items
\n

hasConfig( config )private

...

Parameters

config : Object
\n

initConfig( config ) : Ext.Basechainableprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

initLayout( )protected

A one-time initialization method called just before rendering. ...

A one-time initialization method called just before rendering.

Ext.layout.container.Border
view source

insertSplitter( item, index, hidden, splitterCfg )private

Inserts the splitter for a given region. ...

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

Parameters

item : Object
\n
index : Object
\n
hidden : Object
\n
splitterCfg : Object
\n

Ext.layout.container.Border
view source

isItemBoxParent( itemContext )private

...

Parameters

itemContext : Object
\n

Overrides: Ext.layout.Layout.isItemBoxParent

isItemLayoutRoot( item )private

...

Parameters

item : Object
\n

Ext.layout.container.Border
view source

isItemShrinkWrap( item )private

...

Parameters

item : Object
\n

Overrides: Ext.layout.Layout.isItemShrinkWrap

isRunning( )private

...

isValidParent( item, target, position )protected

Validates item is in the proper place in the dom. ...

Validates item is in the proper place in the dom.

Parameters

item : Object
\n
target : Object
\n
position : Object
\n

moveItem( item, target, position )private

Moves Component to the provided target instead. ...

Moves Component to the provided target instead.

Parameters

item : Object
\n
target : Object
\n
position : Object
\n

notifyOwner( )private

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

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

Overrides: Ext.layout.Layout.notifyOwner

Ext.layout.container.Border
view source

onAdd( item, index )private

Called when a region (actually when any component) is added to the container. ...

Called when a region (actually when any component) is added to the container. The\nregion is decorated with some helpful properties (isCenter, isHorz, isVert) and its\nsplitter is added if its \"split\" property is true.

Parameters

item : Object
\n
index : Object
\n

Overrides: Ext.layout.Layout.onAdd

onConfigUpdate( names, callback, scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

onContentChange( child ) : Boolean

This method is called when a child item changes in some way. ...

This method is called when a child item changes in some way. By default this calls\nExt.AbstractComponent.updateLayout on this layout's owner.

Parameters

child : Ext.Component
The child item that has changed.
\n

Returns

Boolean
True if this layout has handled the content change.
\n

Ext.layout.container.Border
view source

onDestroy( )private

...

Overrides: Ext.layout.Layout.onDestroy

Ext.layout.container.Border
view source

onRemove( item )private

...

Parameters

item : Object
\n

Overrides: Ext.layout.Layout.onRemove

prune( childEls, shared )private

...

Parameters

childEls : Object
\n
shared : Object
\n

removeChildEls( testFn )

Removes items in the childEls array based on the return value of a supplied test\nfunction. ...

Removes items in the childEls array based on the return value of a supplied test\nfunction. The function is called with a entry in childEls and if the test function\nreturn true, that entry is removed. If false, that entry is kept.

Parameters

testFn : Function
The test function.
\n

renderChildren( )private

...

Overrides: Ext.layout.Layout.renderChildren

renderItem( item, target, position )private

Renders the given Component into the target Element. ...

Renders the given Component into the target Element.

Parameters

item : Ext.Component
The Component to render
\n
target : Ext.dom.Element
The target Element
\n
position : Number
The position within the target to render the item to
\n

renderItems( items, target )protected

Iterates over all passed items, ensuring they are rendered. ...

Iterates over all passed items, ensuring they are rendered. If the items are already rendered,\nalso determines if the items are in the proper place in the dom.

Parameters

items : Object
\n
target : Object
\n

setConfig( config, applyIfNotSet ) : Ext.Basechainableprivate

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Returns

Ext.Base
this
\n

setOwner( owner )private

Sets the layout owner ...

Sets the layout owner

Parameters

owner : Object
\n

setupRenderTpl( renderTpl )private

...

Parameters

renderTpl : Object
\n

Ext.layout.container.Border
view source

setupSplitterNeighbors( items )private

...

Parameters

items : Object
\n

sortWeightedItems( items, reverseProp )private

...

Parameters

items : Object
\n
reverseProp : Object
\n

statics( ) : Ext.Classprotected

Get the reference to the class from which this object was instantiated. ...

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

\n\n

Ext.define('My.Cat', {\n    statics: {\n        totalCreated: 0,\n        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n    },\n\n    constructor: function() {\n        var statics = this.statics();\n\n        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to\n                                        // equivalent to: My.Cat.speciesName\n\n        alert(this.self.speciesName);   // dependent on 'this'\n\n        statics.totalCreated++;\n    },\n\n    clone: function() {\n        var cloned = new this.self;                      // dependent on 'this'\n\n        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName\n\n        return cloned;\n    }\n});\n\n\nExt.define('My.SnowLeopard', {\n    extend: 'My.Cat',\n\n    statics: {\n        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'\n    },\n\n    constructor: function() {\n        this.callParent();\n    }\n});\n\nvar cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'\nalert(clone.groupName);                 // alerts 'Cat'\n\nalert(My.Cat.totalCreated);             // alerts 3\n

Returns

Ext.Class
\n

undoLayout( )private

...

Defined By

Static Methods

addConfig( config )privatestatic

...

Parameters

config : Object
\n

addInheritableStatics( members )chainableprivatestatic

...

Parameters

members : Object
\n

addMember( name, member )chainableprivatestatic

...

Parameters

name : Object
\n
member : Object
\n

addMembers( members )chainablestatic

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n

Parameters

members : Object
\n

addStatics( members ) : Ext.Basechainablestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

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

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

addXtype( xtype )chainableprivatestatic

...

Parameters

xtype : Object
\n

borrow( fromClass, members ) : Ext.Basechainableprivatestatic

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

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

\n\n

Ext.define('Bank', {\n    money: '$$$',\n    printMoney: function() {\n        alert('$$$$$$$');\n    }\n});\n\nExt.define('Thief', {\n    ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

create( ) : Objectstatic

Create a new instance of this Class. ...

Create a new instance of this Class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.create({\n    someConfig: true\n});\n

\n\n

All parameters are passed to the constructor of the class.

Returns

Object
the created instance.
\n

createAlias( alias, origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

extend( config )privatestatic

...

Parameters

config : Object
\n

getName( ) : Stringstatic

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n

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

Returns

String
className
\n

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

mixin( name, mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

onExtended( fn, scope )chainableprivatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( members ) : Ext.Basechainabledeprecatedstatic

Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n                          // alerts \"I'm a cat!\"\n                          // alerts \"Meeeeoooowwww\"\n

\n\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n

Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n

\n\n

The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n