defaultMargins : Object

If the individual contained items do not have a margins property specified or margin specified via CSS, the\ndefault m...

If the individual contained items do not have a margins property specified or margin specified via CSS, the\ndefault margins from this property will be applied to each item.

\n\n

This property may be specified as an object containing margins to apply in the format:

\n\n

{\n    top: (top margin),\n    right: (right margin),\n    bottom: (bottom margin),\n    left: (left margin)\n}\n

\n\n

This property may also be specified as a string containing space-separated, numeric margin values. The order of\nthe sides associated with each value matches the way CSS processes margin values:

\n\n

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\nset 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,\nand the bottom is set to the third.
If there are four values, they apply to the top, right, bottom, and left, respectively.

\n\n

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

flex : Number

This configuration option is to be applied to child items of the container managed by this layout. ...

This configuration option is to be applied to child items of the container managed by this layout. Each child\nitem with a flex property will be flexed (horizontally in hbox, vertically in vbox) according to each item's\nrelative flex value compared to the sum of all items with a flex value specified. Any child items that have\neither a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed).

itemCls : String

An optional extra CSS class that will be added to the container. ...

An optional extra CSS class that will be added to the container. This can be useful for\nadding customized styles to the container or any of its children using standard CSS\nrules. See Ext.Component.componentCls also.

Defaults to: Ext.baseCSSPrefix + 'box-item'

Overrides: Ext.layout.container.Container.itemCls

pack : String

Controls how the child items of the container are packed together. ...

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

\n\n

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

\n\n

Defaults to: 'start'

padding : String

Sets the padding to be applied to all child items managed by this layout. ...

Sets the padding to be applied to all child items managed by this layout.

\n\n

This property must be specified as a string containing space-separated, numeric padding values. The order of the\nsides associated with each value matches the way CSS processes padding values:

\n\n

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\nset 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,\nand the bottom is set to the third.
If there are four values, they apply to the top, right, bottom, and left, respectively.

\n\n

Defaults to: 0

stretchMaxPartner : String/Ext.Component

Allows stretchMax calculation to take into account the max perpendicular size (height for HBox layout and width\nfor V...

Allows stretchMax calculation to take into account the max perpendicular size (height for HBox layout and width\nfor VBox layout) of another Box layout when calculating its maximum perpendicular child size.

\n\n

If specified as a string, this may be either a known Container ID, or a ComponentQuery selector which is rooted\nat this layout's Container (ie, to find a sibling, use \"^>#siblingItemId).

Properties

Defined By

Instance Properties

$className : Stringprivate

...

Defaults to: 'Ext.Base'

_percentageRe : RegExpprivate

Matches: <spaces>digits[.digits]<spaces>%<spaces>\nCaptures: digits[.digits] ...

Matches: <spaces>digits[.digits]<spaces>%<spaces>\nCaptures: digits[.digits]

Defaults to: /^\\s*(\\d+(?:\\.\\d*)?)\\s*[%]\\s*$/

alignRoundingMethod : Stringprivate

...

Defaults to: 'round'

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}

availableSpaceOffset : Numberprivate

availableSpaceOffset is used to adjust the availableWidth, typically used\nto reserve space for a scrollbar ...

availableSpaceOffset is used to adjust the availableWidth, typically used\nto reserve space for a scrollbar

Defaults to: 0

calculateChildBox : Objectprivate

calculateChildBoxes : Objectprivate

childEls : Arrayprivate

...

Defaults to: ['innerCt', 'targetEl']

Overrides: Ext.layout.container.Container.childEls

configMap : Objectprivate

...

Defaults to: {}

createsInnerCt : Booleanprivate

...

Defaults to: true

Ext.layout.container.VBox
view source

direction : Stringprivate

...

Defaults to: 'vertical'

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

horizontal : Booleanprivate

...

Defaults to: false

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

initialized : Booleanprivate

...

Defaults to: false

innerCls : Stringprivate

...

Defaults to: Ext.baseCSSPrefix + 'box-inner'

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

manageMargins : Booleanprivate

...

Defaults to: true

Ext.layout.container.VBox
view source

names : Objectprivate

...

Defaults to: {beforeX: 'top', beforeScrollX: 'top', beforeScrollerSuffix: '-before-scroller', afterScrollerSuffix: '-after-scroller', leftCap: 'Top', afterX: 'bottom', width: 'height', contentWidth: 'contentHeight', minWidth: 'minHeight', maxWidth: 'maxHeight', widthCap: 'Height', widthModel: 'heightModel', widthIndex: 1, x: 'y', scrollLeft: 'scrollTop', overflowX: 'overflowY', hasOverflowX: 'hasOverflowY', invalidateScrollX: 'invalidateScrollY', parallelMargins: 'tb', center: 'center', beforeY: 'left', afterY: 'right', height: 'width', contentHeight: 'contentWidth', minHeight: 'minWidth', maxHeight: 'maxWidth', heightCap: 'Width', heightModel: 'widthModel', heightIndex: 0, y: 'x', overflowY: 'overflowX', hasOverflowY: 'hasOverflowX', invalidateScrollY: 'invalidateScrollX', perpendicularMargins: 'lr', getWidth: 'getHeight', getHeight: 'getWidth', setWidth: 'setHeight', setHeight: 'setWidth', gotWidth: 'gotHeight', gotHeight: 'gotWidth', setContentWidth: 'setContentHeight', setContentHeight: 'setContentWidth', setWidthInDom: 'setHeightInDom', setHeightInDom: 'setWidthInDom', getScrollLeft: 'getScrollTop', setScrollLeft: 'setScrollTop', scrollTo: 'scrollTo'}

overflowPadderEl : Ext.Element

The element used to correct body padding during overflow.

renderTpl : Arrayprivate

...

Defaults to: ['{%var oc,l=values.$comp.layout,oh=l.overflowHandler;', 'if (oh.getPrefixConfig!==Ext.emptyFn) {', 'if(oc=oh.getPrefixConfig())dh.generateMarkup(oc, out)', '}%}', '<div id="{ownerId}-innerCt" class="{[l.innerCls]} {[oh.getOverflowCls()]}" role="presentation">', '<div id="{ownerId}-targetEl" class="{targetElCls}">', '{%this.renderBody(out, values)%}', '</div>', '</div>', '{%if (oh.getSuffixConfig!==Ext.emptyFn) {', 'if(oc=oh.getSuffixConfig())dh.generateMarkup(oc, out)', '}%}', {disableFormats: true, definitions: 'var dh=Ext.DomHelper;'}]

Overrides: Ext.layout.container.Container.renderTpl

reserveOffset : Booleanprivate

whether or not to reserve the availableSpaceOffset in layout calculations ...

whether or not to reserve the availableSpaceOffset in layout calculations

Defaults to: true

running : Booleanprivate

...

Defaults to: false

scrollOffset : Numberprivate

...

Defaults to: 0

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

sizePolicy : Objectprivate

...

Defaults to: {flex: {'': {readsWidth: 1, readsHeight: 0, setsWidth: 0, setsHeight: 1}, stretch: {readsWidth: 0, readsHeight: 0, setsWidth: 1, setsHeight: 1}, stretchmax: {readsWidth: 1, readsHeight: 0, setsWidth: 1, setsHeight: 1}}, '': {readsWidth: 1, readsHeight: 1, setsWidth: 0, setsHeight: 0}, stretch: {readsWidth: 0, readsHeight: 1, setsWidth: 1, setsHeight: 0}, stretchmax: {readsWidth: 1, readsHeight: 1, setsWidth: 1, setsHeight: 0}}

targetCls : Stringprivate

...

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

targetElCls : Stringprivate

...

Defaults to: Ext.baseCSSPrefix + 'box-target'

Ext.layout.container.VBox
view source

type : Stringprivate

...

Defaults to: 'vbox'

Overrides: Ext.layout.container.Box.type

updateChildBoxes : Objectprivate

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.VBox( config ) : Ext.layout.container.Box

...

Parameters

config : Object
\n

Returns

Ext.layout.container.Box
\n

Overrides: Ext.layout.container.Container.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

beginCollapse( child )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.

Parameters

child : Object
\n

Overrides: Ext.layout.container.Container.beginCollapse

beginExpand( child )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.

Parameters

child : Object
\n

Overrides: Ext.layout.container.Container.beginExpand

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.container.Container.beginLayoutCycle

cacheChildItems( ownerContext )private

...

Parameters

ownerContext : Object
\n

cacheElements( )private

...

cacheFlexes( ownerContext )protected

This method is called to (re)cache our understanding of flexes. ...

This method is called to (re)cache our understanding of flexes. This happens during beginLayout and may need to\nbe called again if the flexes are changed during the layout (e.g., like ColumnLayout).

Parameters

ownerContext : Object
\n

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

calculateParallel( ownerContext, names, plan )private

...

Parameters

ownerContext : Object
\n
names : Object
\n
plan : Object
\n

calculatePerpendicular( ownerContext, names, plan )private

...

Parameters

ownerContext : Object
\n
names : Object
\n
plan : Object
\n

calculateStretchMax( ownerContext, names, plan )private

...

Parameters

ownerContext : Object
\n
names : Object
\n
plan : 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\n

Overrides: Ext.layout.Layout.completeLayout

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.layout.container.Container.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

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\n\n\n

Overrides: Ext.layout.Layout.finishedLayout

flexSort( a, b )private

...

Parameters

a : Object
\n
b : Object
\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

Overridden method from Ext.layout.container.Container. ...

Overridden method from Ext.layout.container.Container.\nUsed by Container classes to insert special DOM elements which must exist in addition to the child components

\n\n

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

Overrides: Ext.layout.container.Container.getElementTarget

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

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\n

Overrides: Ext.layout.Layout.getItemSizePolicy

getItemsRenderTree( items, renderCfgs )private

...

Parameters

items : Object
\n
renderCfgs : Object
\n

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\n

Overrides: Ext.layout.Layout.getLayoutItems

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

...

Overrides: Ext.layout.container.Container.getRenderData

getRenderTarget( ) : Ext.Element

Overridden method from Ext.layout.container.Container. ...

Overridden method from Ext.layout.container.Container.\nUsed in the beforeLayout method to render all items into.

\n\n

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

Overrides: Ext.layout.container.Container.getRenderTarget

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

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.

initOverflowHandler( )private

...

isItemBoxParent( itemContext )private

...

Parameters

itemContext : Object
\n

Overrides: Ext.layout.Layout.isItemBoxParent

isItemLayoutRoot( item )private

...

Parameters

item : Object
\n

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

onAdd( item )private

...

Parameters

item : Object
\n

onAfterConstrainInvalidateChild( childContext, options )private

...

Parameters

childContext : Object
\n
options : Object
\n

onAfterStretchMaxInvalidateChild( childContext, options )private

...

Parameters

childContext : Object
\n
options : Object
\n

onBeforeConstrainInvalidateChild( childContext, options )private

...

Parameters

childContext : Object
\n
options : Object
\n

onBeforeStretchMaxInvalidateChild( childContext, options )private

...

Parameters

childContext : Object
\n
options : Object
\n

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

onDestroy( )private

...

onRemove( comp )private

...

Parameters

comp : Object
\n

Overrides: Ext.layout.Layout.onRemove

prune( childEls, shared )private

...

Parameters

childEls : Object
\n
shared : Object
\n

publishInnerCtSize( ownerContext, reservedSpace )private

...

Parameters

ownerContext : Object
\n
reservedSpace : 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

roundFlex( width )private

...

Parameters

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

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