$className : Stringprivate

...

Defaults to: "Ext.Base"

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.

elementId : Object

Error message displayed as content of an element with a given id elsewhere in the app

errorStrategies : Object

Collection of named strategies for laying out and adjusting insets to accommodate error messages. ...

Collection of named strategies for laying out and adjusting insets to accommodate error messages.\nAn appropriate one will be chosen based on the owner field's Ext.form.Labelable.msgTarget config.

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

isInstance : Booleanprivate

...

Defaults to: true

isLayout : Boolean

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

labelStrategies : Object

Collection of named strategies for laying out and adjusting labels to accommodate error messages. ...

Collection of named strategies for laying out and adjusting labels to accommodate error messages.\nAn appropriate one will be chosen based on the owner field's Ext.form.Labelable.labelAlign config.

left : Object

Label displayed to the left of the bodyEl

qtip : Object

Error displayed as QuickTip on hover of the field container

right : Object

Same as left, only difference is text-align in CSS

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

side : Object

Error displayed as icon (with QuickTip on hover) to right of the bodyEl

title : Object

Error displayed as title tip on hover of the field container

top : Object

Label displayed above the bodyEl

under : Object

Error message displayed underneath the bodyEl

Defined By

Static Properties

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

afterRemove( Object 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

beginLayout( Ext.layout.ContextItem ownerContext )

Called before any calculation cycles to prepare for layout. ...

Called before any calculation cycles to prepare for layout.

\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

beginLayoutCycle( Ext.layout.ContextItem 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

calculate( Ext.layout.ContextItem 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

callOverridden( Array/Arguments 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( Array/Arguments 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

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

completeLayout( Ext.layout.ContextItem 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( Ext.Component item )protected

Called before an item is rendered to allow the layout to configure the item. ...

Called before an item is rendered to allow the layout to configure the item.

Parameters

item : Ext.Component
The item to be configured
\n

destroy( )protected

Destroys this layout. ...

Destroys this layout. This method removes a targetCls from the target\nelement and calls onDestroy.

\n\n

A derived class can override either this method or onDestroy but in all\ncases must call the base class versions of these methods to allow the base class to\nperform its cleanup.

\n\n

This method (or onDestroy) are overridden by subclasses most often to purge\nevent handlers or remove unmanged DOM nodes.

Overrides: Ext.Base.destroy

finalizeLayout( Ext.layout.ContextItem 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

finishedLayout( Ext.layout.ContextItem 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

getConfig( Object name )private

...

Parameters

name : Object
\n

getErrorStrategy( )

Return the set of strategy functions from the errorStrategies collection\nthat is appropriate for the field's msgTarge...

Return the set of strategy functions from the errorStrategies collection\nthat is appropriate for the field's msgTarget config.

getInitialConfig( [String 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( Ext.Component item ) : Objectprotected

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

Object
An object describing the sizing done by the layout for this item or\nnull if the layout mimics the size policy of its ownerCt (e.g., 'fit' and 'card').
\n
- readsWidth : Boolean
  True if the natural/auto width of this component\nis used by the ownerLayout.
  \n
- readsHeight : Boolean
  True if the natural/auto height of this component\nis used by the ownerLayout.
  \n
- setsWidth : Boolean
  True if the ownerLayout set this component's width.
  \n
- setsHeight : Boolean
  True if the ownerLayout set this component's height.
  \n

getLabelStrategy( )

Return the set of strategy functions from the labelStrategies collection\nthat is appropriate for the field's labelAli...

Return the set of strategy functions from the labelStrategies collection\nthat is appropriate for the field's labelAlign config.

Ext.layout.component.Component
view source

getLayoutItems( )protected

Returns the set of items to layout (empty by default). ...

Returns the set of items to layout (empty by default).

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 Component's encapsulating element.

\n\n

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

Returns

Ext.Element
\n

Ext.layout.component.Component
view source

getTarget( ) : Ext.Element

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

Returns the owner component's resize element.

Returns

Ext.Element
\n

hasConfig( Object config )private

...

Parameters

config : Object
\n

initConfig( Object config ) : Ext.Baseprotected

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.

isValidParent( Object item, Object target, Object 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( Object item, Object target, Object 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( Ext.layout.ContextItem ownerContext )

This method (if implemented) is called after all layouts are finished, and all have\na lastComponentSize cached. ...

This method (if implemented) is called after all layouts are finished, and all have\na lastComponentSize cached. No further layouts will be run and this method is only\ncalled once per layout run. It is the bookend to beginLayout.

\n\n

This is a write phase and DOM reads should be avoided if possible when overridding\nthis method. This is the catch-all tail method to a layout and so the rules are more\nrelaxed. Even so, for performance reasons, it is best to avoid reading the DOM. If\na read is necessary, consider implementing a finalizeLayout method to do the\nrequired reads.

\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

onConfigUpdate( Object names, Object callback, Object scope )private

...

Parameters

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

onContentChange( Ext.Component 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

renderItem( Ext.Component item, Ext.dom.Element target, Number 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( Object items, Object 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( Object config, Object applyIfNotSet )private

...

Parameters

config : Object
\n
applyIfNotSet : 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

Defined By

Static Methods

addConfig( Object config )privatestatic

...

Parameters

config : Object
\n

addInheritableStatics( Object members )privatestatic

...

Parameters

members : Object
\n

addMember( Object name, Object member )privatestatic

...

Parameters

name : Object
\n
member : Object
\n

addMembers( Object members )static

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( Object members ) : Ext.Basestatic

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( Object xtype )privatestatic

...

Parameters

xtype : Object
\n

borrow( Ext.Base fromClass, Array/String members ) : Ext.Baseprivatestatic

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( String/Object alias, String/Object 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( Object 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( Object name, Object mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

onExtended( Object fn, Object scope )privatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( Object members ) : Ext.Basedeprecatedstatic

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