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.

Properties

Defined By

Instance Properties

$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.Form
view source

childEls : Arrayprivate

...

Defaults to: ['formTable']

Overrides: Ext.layout.container.Container.childEls

configMap : Objectprivate

...

Defaults to: {}

Ext.layout.container.Form
view source

createsInnerCt : Booleanprivate

...

Defaults to: true

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

getScrollRangeFlags : Object

Returns flags indicating cross-browser handling of scrollHeight/Width. ...

Returns flags indicating cross-browser handling of scrollHeight/Width. In particular,\nIE has issues with padding-bottom in a scrolling element (it does not include that\npadding in the scrollHeight). Also, margin-bottom on a child in a scrolling element\ncan be lost.

\n\n

All browsers seem to ignore margin-right on children and padding-right on the parent\nelement (the one with the overflow)

\n\n

This method returns a number with the follow bit positions set based on things not\naccounted for in scrollHeight and scrollWidth:

\n\n

1: Scrolling element's padding-bottom is not included in scrollHeight.
2: Last child's margin-bottom is not included in scrollHeight.
4: Scrolling element's padding-right is not included in scrollWidth.
8: Child's margin-right is not included in scrollWidth.

\n\n\n

To work around the margin-bottom issue, it is sufficient to create a 0px tall last\nchild that will \"hide\" the margin. This can also be handled by wrapping the children\nin an element, again \"hiding\" the margin. Wrapping the elements is about the only\nway to preserve their right margins. This is the strategy used by Column layout.

\n\n

To work around the padding-bottom problem, since it is comes from a style on the\nparent element, about the only simple fix is to create a last child with height\nequal to padding-bottom. To preserve the right padding, the sizing element needs to\nhave a width that includes the right padding.

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

initialized : Booleanprivate

...

Defaults to: false

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

lastOverflowAdjust : Objectprivate

Begin with no previous adjustments ...

Begin with no previous adjustments

Defaults to: {width: 0, height: 0}

Ext.layout.container.Form
view source

manageOverflow : Booleanprivate

...

Defaults to: true

overflowPadderEl : Ext.Element

The element used to correct body padding during overflow.

Ext.layout.container.Form
view source

padRow : Stringprivate

...

Defaults to: '<tr><td class="' + Ext.baseCSSPrefix + 'form-item-pad" colspan="3"></td></tr>'

Ext.layout.container.Form
view source

renderTpl : Arrayprivate

...

Defaults to: ['<table id="{ownerId}-formTable" class="{tableCls}" style="width:100%" cellpadding="0">', '{%this.renderBody(out,values)%}', '</table>', '{%this.renderPadder(out,values)%}']

Overrides: Ext.layout.container.Container.renderTpl

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

tableCls : Stringprivate

End Definitions ...

End Definitions

Defaults to: Ext.baseCSSPrefix + 'form-layout-table'

Ext.layout.container.Form
view source

type : Stringprivate

...

Defaults to: 'form'

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.Form( ) : 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

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.

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.Layout.beginLayout

Ext.layout.container.Form
view source

beginLayoutCycle( ownerContext )

All of the below methods are old methods moved here from Container layout\nTODO: remove these methods once Form layout...

All of the below methods are old methods moved here from Container layout\nTODO: remove these methods once Form layout extends Auto layout

\n\n

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

...

Ext.layout.container.Form
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.Form
view source

calculateOverflow( ownerContext, containerSize, dimensions )

Handles overflow processing for a container. ...

Handles overflow processing for a container. This should be called once the layout\nhas determined contentWidth/Height. In addition to the ownerContext passed to the\ncalculate method, this method also needs the containerSize (the object\nreturned by getContainerSize).

Parameters

ownerContext : Ext.layout.ContextItem
\n
containerSize : Object
\n
dimensions : Number
A bit mask for the overflow managed dimensions. The 0-bit\nis for width and the 1-bit is for height. In other words, a value of 1 would be\nonly width, 2 would be only height and 3 would be both.
\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

Ext.layout.container.Form
view source

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

Ext.layout.container.Form
view source

doRenderPadder( out, renderData )

Creates an element that makes bottom/right body padding consistent across browsers. ...

Creates an element that makes bottom/right body padding consistent across browsers.\nThis element is sized based on the need for scrollbars in calculateOverflow.\nIf the manageOverflow option is false, this element is not created.

\n\n

See getScrollRangeFlags for more details.

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

getAnimatePolicy( )private

...

getChildEls( )private

...

getClassChildEls( cls )private

...

Parameters

cls : Object
\n

getConfig( name )private

...

Parameters

name : Object
\n

Ext.layout.container.Form
view source

getContainerSize( ownerContext, [inDom], [ignoreOverflow] ) : 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.

\n\n

If the calculateOverflow method is used and if manageOverflow is\ntrue, this may adjust the width/height by the size of scrollbars.

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
ignoreOverflow : Boolean (optional)
if true scrollbar size will not be\nsubtracted from container size.
\n
Defaults to: true

Returns

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

Overrides: Ext.layout.container.Container.getContainerSize

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

Ext.layout.container.Form
view source

getOverflowXStyle( ownerContext ) : Stringprotected

returns the overflow-x style of the render target ...

returns the overflow-x style of the render target

Parameters

ownerContext : Ext.layout.ContextItem
\n

Returns

String
\n

Ext.layout.container.Form
view source

getOverflowYStyle( ownerContext ) : Stringprotected

returns the overflow-y style of the render target ...

returns the overflow-y style of the render target

Parameters

ownerContext : Ext.layout.ContextItem
\n

Returns

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

Ext.layout.container.Form
view source

getRenderData( )private

...

Overrides: Ext.layout.container.Container.getRenderData

Ext.layout.container.Form
view source

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

Overrides: Ext.layout.container.Container.getRenderTarget

getRenderTpl( )private

...

Ext.layout.container.Form
view source

getRenderTree( )private

...

Overrides: Ext.layout.container.Container.getRenderTree

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

Ext.layout.container.Form
view source

initLayout( )protected

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

A one-time initialization method called just before rendering.

Overrides: Ext.layout.Layout.initLayout

isItemBoxParent( itemContext )private

...

Parameters

itemContext : Object
\n

isItemLayoutRoot( item )private

...

Parameters

item : Object
\n

Ext.layout.container.Form
view source

isItemShrinkWrap( item )private

...

Parameters

item : Object
\n

Overrides: Ext.layout.Layout.isItemShrinkWrap

isRunning( )private

...

Ext.layout.container.Form
view source

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

Overrides: Ext.layout.Layout.isValidParent

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

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( )private

...

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

Ext.layout.container.Form
view source

setupRenderTpl( renderTpl )private

...

Parameters

renderTpl : Object
\n

Overrides: Ext.layout.container.Container.setupRenderTpl

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

Ext.layout.container.Form
view source

transformItemRenderTree( item )private

...

Parameters

item : Object
\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