Ext.data.JsonP.Ext_layout_ContextItem({"mixins":[],"code_type":"ext_define","inheritable":false,"component":false,"meta":{"private":true},"mixedInto":[],"uses":[],"aliases":{},"parentMixins":[],"superclasses":["Ext.Base"],"members":{"event":[],"property":[{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"$className","id":"property-S-className"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"configMap","id":"property-configMap"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"initConfigList","id":"property-initConfigList"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"initConfigMap","id":"property-initConfigMap"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"property","name":"isInstance","id":"property-isInstance"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"property","name":"self","id":"property-self"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"property","name":"state","id":"property-state"},{"meta":{"readonly":true},"owner":"Ext.layout.ContextItem","tagname":"property","name":"wrapsComponent","id":"property-wrapsComponent"}],"css_var":[],"method":[{"meta":{"private":true},"owner":"Ext.layout.ContextItem","tagname":"method","name":"addBlock","id":"method-addBlock"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"addCls","id":"method-addCls"},{"meta":{"private":true},"owner":"Ext.layout.ContextItem","tagname":"method","name":"addTrigger","id":"method-addTrigger"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"block","id":"method-block"},{"meta":{"deprecated":{"text":"as of 4.1. Use {@link #callParent} instead."},"protected":true},"owner":"Ext.Base","tagname":"method","name":"callOverridden","id":"method-callOverridden"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"callParent","id":"method-callParent"},{"meta":{"private":true},"owner":"Ext.layout.ContextItem","tagname":"method","name":"clearBlocks","id":"method-clearBlocks"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"clearMarginCache","id":"method-clearMarginCache"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"configClass","id":"method-configClass"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"destroy","id":"method-destroy"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"domBlock","id":"method-domBlock"},{"meta":{"private":true},"owner":"Ext.layout.ContextItem","tagname":"method","name":"fireTriggers","id":"method-fireTriggers"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"flush","id":"method-flush"},{"meta":{"private":true},"owner":"Ext.layout.ContextItem","tagname":"method","name":"flushAnimations","id":"method-flushAnimations"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getBorderInfo","id":"method-getBorderInfo"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getClassList","id":"method-getClassList"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"getConfig","id":"method-getConfig"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getDomProp","id":"method-getDomProp"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getEl","id":"method-getEl"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getFrameInfo","id":"method-getFrameInfo"},{"meta":{},"owner":"Ext.Base","tagname":"method","name":"getInitialConfig","id":"method-getInitialConfig"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getMarginInfo","id":"method-getMarginInfo"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getPaddingInfo","id":"method-getPaddingInfo"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getProp","id":"method-getProp"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getStyle","id":"method-getStyle"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"getStyles","id":"method-getStyles"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"hasConfig","id":"method-hasConfig"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"hasDomProp","id":"method-hasDomProp"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"hasProp","id":"method-hasProp"},{"meta":{"private":true},"owner":"Ext.layout.ContextItem","tagname":"method","name":"init","id":"method-init"},{"meta":{"private":true},"owner":"Ext.layout.ContextItem","tagname":"method","name":"initAnimation","id":"method-initAnimation"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"initConfig","id":"method-initConfig"},{"meta":{"private":true},"owner":"Ext.layout.ContextItem","tagname":"method","name":"initContinue","id":"method-initContinue"},{"meta":{"private":true},"owner":"Ext.layout.ContextItem","tagname":"method","name":"initDone","id":"method-initDone"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"invalidate","id":"method-invalidate"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"onConfigUpdate","id":"method-onConfigUpdate"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"recoverProp","id":"method-recoverProp"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"removeCls","id":"method-removeCls"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"setAttribute","id":"method-setAttribute"},{"meta":{"private":true},"owner":"Ext.Base","tagname":"method","name":"setConfig","id":"method-setConfig"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"setContentHeight","id":"method-setContentHeight"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"setContentSize","id":"method-setContentSize"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"setContentWidth","id":"method-setContentWidth"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"setHeight","id":"method-setHeight"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"setProp","id":"method-setProp"},{"meta":{},"owner":"Ext.layout.ContextItem","tagname":"method","name":"setWidth","id":"method-setWidth"},{"meta":{"protected":true},"owner":"Ext.Base","tagname":"method","name":"statics","id":"method-statics"}],"css_mixin":[],"cfg":[]},"tagname":"class","extends":"Ext.Base","private":true,"html":"
Hierarchy
Ext.Base
Ext.layout.ContextItem
Requires
Ext.layout.ClassList
Files
ContextItem.js

NOTE This is a private utility class for internal use by the framework. Don't rely on its existence.

This class manages state information for a component or element during a layout.

\n\n

Blocks

\n\n

A \"block\" is a required value that is preventing further calculation. When a layout has\nencountered a situation where it cannot possibly calculate results, it can associate\nitself with the context item and missing property so that it will not be rescheduled\nuntil that property is set.

\n\n

Blocks are a one-shot registration. Once the property changes, the block is removed.

\n\n

Be careful with blocks. If any further calculations can be made, a block is not the\nright choice.

\n\n

Triggers

\n\n

Whenever any call to getProp, getDomProp, hasProp or\nhasDomProp is made, the current layout is automatically registered as being\ndependent on that property in the appropriate state. Any changes to the property will\ntrigger the layout and it will be queued in the Ext.layout.Context.

\n\n

Triggers, once added, remain for the entire layout. Any changes to the property will\nreschedule all unfinished layouts in their trigger set.

\n

Properties

Defined By

Instance Properties

Ext.Base
view source
: Stringprivate
...
\n

Defaults to: "Ext.Base"

Ext.Base
view source
: Objectprivate
...
\n

Defaults to: {}

Ext.Base
view source
: Arrayprivate
...
\n

Defaults to: []

Ext.Base
view source
: Objectprivate
...
\n

Defaults to: {}

Ext.Base
view source
: Booleanprivate
...
\n

Defaults to: true

Ext.Base
view source
: 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
\n
Ext.layout.ContextItem
view source
: Object
State variables that are cleared when invalidated. ...

State variables that are cleared when invalidated. Only applies to component items.

\n

Defaults to: null

Ext.layout.ContextItem
view source
: Booleanreadonly
True if this item wraps a Component (rather than an Element). ...

True if this item wraps a Component (rather than an Element).

\n

Defaults to: false

Defined By

Static Properties

Ext.Base
view source
: Arrayprivatestatic
...
\n

Defaults to: []

Methods

Defined By

Instance Methods

Ext.layout.ContextItem
view source
( String name, Ext.layout.Layout layout, String propName )private
Adds a block. ...

Adds a block.

\n

Parameters

  • name : String

    The name of the block list ('blocks' or 'domBlocks').

    \n
  • layout : Ext.layout.Layout

    The layout that is blocked.

    \n
  • propName : String

    The property name that blocked the layout (e.g., 'width').

    \n
Ext.layout.ContextItem
view source
( Object newCls )
Queue the addition of a class name (or array of class names) to this ContextItem's target when next flushed. ...

Queue the addition of a class name (or array of class names) to this ContextItem's target when next flushed.

\n

Parameters

Ext.layout.ContextItem
view source
( String propName, Boolean inDom )private
Adds a trigger. ...

Adds a trigger.

\n

Parameters

  • propName : String

    The property name that triggers the layout (e.g., 'width').

    \n
  • inDom : Boolean

    True if the trigger list is domTriggers, false if triggers.

    \n
Ext.layout.ContextItem
view source
( Ext.layout.Layout layout, String propName )
Registers a layout in the block list for the given property. ...

Registers a layout in the block list for the given property. Once the property is\nset in the Ext.layout.Context, the layout is unblocked.

\n

Parameters

Ext.Base
view source
( 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
\n
\n

This method has been deprecated

\n

as of 4.1. Use callParent instead.

\n\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
Ext.Base
view source
( 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
\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
Ext.layout.ContextItem
view source
( String name, String propName )private
Removes any blocks on a property in the specified set. ...

Removes any blocks on a property in the specified set. Any layouts that were blocked\nby this property and are not still blocked (by other properties) will be rescheduled.

\n

Parameters

  • name : String

    The name of the block list ('blocks' or 'domBlocks').

    \n
  • propName : String

    The property name that blocked the layout (e.g., 'width').

    \n
Ext.layout.ContextItem
view source
( )
clears the margin cache so that marginInfo get re-read from the dom on the next call to getMarginInfo()\nThis is neede...

clears the margin cache so that marginInfo get re-read from the dom on the next call to getMarginInfo()\nThis is needed in some special cases where the margins have changed since the last layout, making the cached\nvalues invalid. For example collapsed window headers have different margin than expanded ones.

\n
Ext.Base
view source
( )private
...
\n
Ext.Base
view source
( )private
...
\n

Overrides: Ext.AbstractComponent.destroy, Ext.AbstractPlugin.destroy, Ext.layout.Layout.destroy

Ext.layout.ContextItem
view source
( Ext.layout.Layout layout, String propName )
Registers a layout in the DOM block list for the given property. ...

Registers a layout in the DOM block list for the given property. Once the property\nflushed to the DOM by the Ext.layout.Context, the layout is unblocked.

\n

Parameters

Ext.layout.ContextItem
view source
( String name, String propName )private
Reschedules any layouts associated with a given trigger. ...

Reschedules any layouts associated with a given trigger.

\n

Parameters

  • name : String

    The name of the trigger list ('triggers' or 'domTriggers').

    \n
  • propName : String

    The property name that triggers the layout (e.g., 'width').

    \n
Ext.layout.ContextItem
view source
( )
Flushes any updates in the dirty collection to the DOM. ...

Flushes any updates in the dirty collection to the DOM. This is only called if there\nare dirty entries because this object is only added to the flushQueue of the\nExt.layout.Context when entries become dirty.

\n
Ext.layout.ContextItem
view source
( )private
...
\n
Ext.layout.ContextItem
view source
( ) : Object
Gets the border information for the element as an object with left, top, right and\nbottom properties holding border s...

Gets the border information for the element as an object with left, top, right and\nbottom properties holding border size in pixels. This object is only read from the\nDOM on first request and is cached.

\n

Returns

Ext.layout.ContextItem
view source
( )
Returns a ClassList-like object to buffer access to this item's element's classes. ...

Returns a ClassList-like object to buffer access to this item's element's classes.

\n
Ext.Base
view source
( Object name )private
...
\n

Parameters

Ext.layout.ContextItem
view source
( String propName ) : Object
Gets a property of this object if it is correct in the DOM. ...

Gets a property of this object if it is correct in the DOM. Also tracks the current\nlayout as dependent on this property so that DOM writes of it will trigger the\nlayout to be recalculated.

\n

Parameters

  • propName : String

    The property name (e.g., 'width').

    \n

Returns

  • Object

    The property value or undefined if not yet set or is dirty.

    \n
Ext.layout.ContextItem
view source
( Object nameOrEl, Object owner )
Returns the context item for an owned element. ...

Returns the context item for an owned element. This should only be called on a\ncomponent's item. The list of child items is used to manage invalidating calculated\nresults.

\n

Parameters

Ext.layout.ContextItem
view source
( ) : Object
Gets the \"frame\" information for the element as an object with left, top, right and\nbottom properties holding border+...

Gets the \"frame\" information for the element as an object with left, top, right and\nbottom properties holding border+framing size in pixels. This object is calculated\non first request and is cached.

\n

Returns

Ext.Base
view source
( [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.

\n

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.ContextItem
view source
( ) : Object
Gets the margin information for the element as an object with left, top, right and\nbottom properties holding margin s...

Gets the margin information for the element as an object with left, top, right and\nbottom properties holding margin size in pixels. This object is only read from the\nDOM on first request and is cached.

\n

Returns

Ext.layout.ContextItem
view source
( ) : Object
Gets the padding information for the element as an object with left, top, right and\nbottom properties holding padding...

Gets the padding information for the element as an object with left, top, right and\nbottom properties holding padding size in pixels. This object is only read from the\nDOM on first request and is cached.

\n

Returns

Ext.layout.ContextItem
view source
( String propName ) : Object
Gets a property of this object. ...

Gets a property of this object. Also tracks the current layout as dependent on this\nproperty so that changes to it will trigger the layout to be recalculated.

\n

Parameters

  • propName : String

    The property name that blocked the layout (e.g., 'width').

    \n

Returns

  • Object

    The property value or undefined if not yet set.

    \n
Ext.layout.ContextItem
view source
( String styleName ) : Object
Returns a style for this item. ...

Returns a style for this item. Each style is read from the DOM only once on first\nrequest and is then cached. If the value is an integer, it is parsed automatically\n(so '5px' is not returned, but rather 5).

\n

Parameters

  • styleName : String

    The CSS style name.

    \n

Returns

  • Object

    The value of the DOM style (parsed as necessary).

    \n
Ext.layout.ContextItem
view source
( String[] styleNames, [String[] altNames] ) : Object
Returns styles for this item. ...

Returns styles for this item. Each style is read from the DOM only once on first\nrequest and is then cached. If the value is an integer, it is parsed automatically\n(so '5px' is not returned, but rather 5).

\n

Parameters

  • styleNames : String[]

    The CSS style names.

    \n
  • altNames : String[] (optional)

    The alternate names for the returned styles. If given,\nthese names must correspond one-for-one to the styleNames.

    \n

Returns

  • Object

    The values of the DOM styles (parsed as necessary).

    \n
Ext.Base
view source
( Object config )private
...
\n

Parameters

Ext.layout.ContextItem
view source
( String propName ) : Boolean
Returns true if the given property is correct in the DOM. ...

Returns true if the given property is correct in the DOM. This is equivalent to\ncalling getDomProp and not getting an undefined result. In particular,\nthis call registers the current layout to be triggered by flushes of this property.

\n

Parameters

  • propName : String

    The property name (e.g., 'width').

    \n

Returns

Ext.layout.ContextItem
view source
( String propName ) : Boolean
Returns true if the given property has been set. ...

Returns true if the given property has been set. This is equivalent to calling\ngetProp and not getting an undefined result. In particular, this call\nregisters the current layout to be triggered by changes to this property.

\n

Parameters

  • propName : String

    The property name (e.g., 'width').

    \n

Returns

Ext.layout.ContextItem
view source
( Boolean full ) : Mixedprivate
Clears all properties on this object except (perhaps) those not calculated by this\ncomponent. ...

Clears all properties on this object except (perhaps) those not calculated by this\ncomponent. This is more complex than it would seem because a layout can decide to\ninvalidate its results and run the component's layouts again, but since some of the\nvalues may be calculated by the container, care must be taken to preserve those\nvalues.

\n

Parameters

  • full : Boolean

    True if all properties are to be invalidated, false to keep\nthose calculated by the ownerCt.

    \n

Returns

  • Mixed

    A value to pass as the first argument to initContinue.

    \n
Ext.layout.ContextItem
view source
( )private
...
\n
Ext.Base
view source
( 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
\n

Parameters

Returns

Ext.layout.ContextItem
view source
( Object full )private
...
\n

Parameters

Ext.layout.ContextItem
view source
( Object full, Object componentChildrenDone, Object containerChildrenDone, Object containerLayoutDone )private
...
\n

Parameters

Ext.layout.ContextItem
view source
( Object options )
Invalidates the component associated with this item. ...

Invalidates the component associated with this item. The layouts for this component\nand all of its contained items will be re-run after first clearing any computed\nvalues.

\n\n

If state needs to be carried forward beyond the invalidation, the options parameter\ncan be used.

\n

Parameters

Ext.Base
view source
( Object names, Object callback, Object scope )private
...
\n

Parameters

Ext.layout.ContextItem
view source
( String propName, Object oldProps, Object oldDirty )
Recovers a property value from the last computation and restores its value and\ndirty state. ...

Recovers a property value from the last computation and restores its value and\ndirty state.

\n

Parameters

  • propName : String

    The name of the property to recover.

    \n
  • oldProps : Object

    The old \"props\" object from which to recover values.

    \n
  • oldDirty : Object

    The old \"dirty\" object from which to recover state.

    \n
Ext.layout.ContextItem
view source
( Object removeCls )
Queue the removal of a class name (or array of class names) from this ContextItem's target when next flushed. ...

Queue the removal of a class name (or array of class names) from this ContextItem's target when next flushed.

\n

Parameters

Ext.layout.ContextItem
view source
( Object name, Object value )
Queue the setting of a DOM attribute on this ContextItem's target when next flushed. ...

Queue the setting of a DOM attribute on this ContextItem's target when next flushed.

\n

Parameters

Ext.Base
view source
( Object config, Object applyIfNotSet )private
...
\n

Parameters

Ext.layout.ContextItem
view source
( Object height, Object measured )
Sets the contentHeight property. ...

Sets the contentHeight property. If the component uses raw content, then only the\nmeasured height is acceptable.

\n\n

Calculated values can sometimes be NaN or undefined, which generally mean the\ncalculation is not done. To indicate that such as value was passed, 0 is returned.\nOtherwise, 1 is returned.

\n\n

If the caller is not measuring (i.e., they are calculating) and the component has raw\ncontent, 1 is returned indicating that the caller is done.

\n

Parameters

Ext.layout.ContextItem
view source
( Object width, Object height, Object measured )
Sets the contentWidth and contentHeight properties. ...

Sets the contentWidth and contentHeight properties. If the component uses raw content,\nthen only the measured values are acceptable.

\n\n

Calculated values can sometimes be NaN or undefined, which generally means that the\ncalculation is not done. To indicate that either passed value was such a value, false\nreturned. Otherwise, true is returned.

\n\n

If the caller is not measuring (i.e., they are calculating) and the component has raw\ncontent, true is returned indicating that the caller is done.

\n

Parameters

Ext.layout.ContextItem
view source
( Object width, Object measured )
Sets the contentWidth property. ...

Sets the contentWidth property. If the component uses raw content, then only the\nmeasured width is acceptable.

\n\n

Calculated values can sometimes be NaN or undefined, which generally means that the\ncalculation is not done. To indicate that such as value was passed, 0 is returned.\nOtherwise, 1 is returned.

\n\n

If the caller is not measuring (i.e., they are calculating) and the component has raw\ncontent, 1 is returned indicating that the caller is done.

\n

Parameters

Ext.layout.ContextItem
view source
( Number height, [Boolean dirty] ) : Number
Sets the height and constrains the height to min/maxHeight range. ...

Sets the height and constrains the height to min/maxHeight range.

\n

Parameters

  • height : Number

    The height.

    \n
  • dirty : Boolean (optional)

    Specifies if the value is currently in the DOM. A\nvalue of false indicates that the value is already in the DOM.

    \n

    Defaults to: true

Returns

  • Number

    The actual height after constraining.

    \n
Ext.layout.ContextItem
view source
( String propName, Object value, Boolean dirty ) : Number
Sets a property value. ...

Sets a property value. This will unblock and/or trigger dependent layouts if the\nproperty value is being changed. Values of NaN and undefined are not accepted by\nthis method.

\n

Parameters

  • propName : String

    The property name (e.g., 'width').

    \n
  • value : Object

    The new value of the property.

    \n
  • dirty : Boolean

    Optionally specifies if the value is currently in the DOM\n (default is true which indicates the value is not in the DOM and must be flushed\n at some point).

    \n

Returns

  • Number

    1 if this call specified the property value, 0 if not.

    \n
Ext.layout.ContextItem
view source
( Number width, [Boolean dirty] ) : Number
Sets the height and constrains the width to min/maxWidth range. ...

Sets the height and constrains the width to min/maxWidth range.

\n

Parameters

  • width : Number

    The width.

    \n
  • dirty : Boolean (optional)

    Specifies if the value is currently in the DOM. A\nvalue of false indicates that the value is already in the DOM.

    \n

    Defaults to: true

Returns

  • Number

    The actual width after constraining.

    \n
Ext.Base
view source
( ) : 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
\n

Returns

Defined By

Static Methods

Ext.Base
view source
( Object config )privatestatic
...
\n

Parameters

Ext.Base
view source
( Object members )privatestatic
...
\n

Parameters

Ext.Base
view source
( Object name, Object member )privatestatic
...
\n

Parameters

Ext.Base
view source
( 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
\n

Parameters

Ext.Base
view source
( 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
\n

Parameters

Returns

Ext.Base
view source
( Object xtype )privatestatic
...
\n

Parameters

Ext.Base
view source
( 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
\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
view source
( ) : 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.

\n

Returns

Ext.Base
view source
( 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
\n

Parameters

Ext.Base
view source
( Object config )privatestatic
...
\n

Parameters

Ext.Base
view source
( ) : 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
\n

Returns

Ext.Base
view source
( )deprecatedstatic
Adds members to class. ...

Adds members to class.

\n
\n

This method has been deprecated since 4.1

\n

Use addMembers instead.

\n\n
\n
Ext.Base
view source
( Object name, Object mixinClass )privatestatic
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

\n

Parameters

Ext.Base
view source
( Object fn, Object scope )privatestatic
...
\n

Parameters

Ext.Base
view source
( 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).

\n
\n

This method has been deprecated since 4.1.0

\n

Use Ext.define instead

\n\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
view source
( )privatestatic
...
\n
","subclasses":[],"name":"Ext.layout.ContextItem","alternateClassNames":[],"inheritdoc":null,"files":[{"href":"ContextItem.html#Ext-layout-ContextItem","filename":"ContextItem.js"}],"html_meta":{"private":null},"singleton":false,"id":"class-Ext.layout.ContextItem","statics":{"property":[{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"property","name":"$onExtended","id":"static-property-S-onExtended"}],"event":[],"css_var":[],"method":[{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"addConfig","id":"static-method-addConfig"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"addInheritableStatics","id":"static-method-addInheritableStatics"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"addMember","id":"static-method-addMember"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"addMembers","id":"static-method-addMembers"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"addStatics","id":"static-method-addStatics"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"addXtype","id":"static-method-addXtype"},{"meta":{"private":true,"static":true},"owner":"Ext.Base","tagname":"method","name":"borrow","id":"static-method-borrow"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"create","id":"static-method-create"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"createAlias","id":"static-method-createAlias"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"extend","id":"static-method-extend"},{"meta":{"static":true},"owner":"Ext.Base","tagname":"method","name":"getName","id":"static-method-getName"},{"meta":{"deprecated":{"text":"Use {@link #addMembers} instead.","version":"4.1"},"static":true},"owner":"Ext.Base","tagname":"method","name":"implement","id":"static-method-implement"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"mixin","id":"static-method-mixin"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"onExtended","id":"static-method-onExtended"},{"meta":{"deprecated":{"text":"Use {@link Ext#define Ext.define} instead","version":"4.1.0"},"markdown":true,"static":true},"owner":"Ext.Base","tagname":"method","name":"override","id":"static-method-override"},{"meta":{"static":true,"private":true},"owner":"Ext.Base","tagname":"method","name":"triggerExtended","id":"static-method-triggerExtended"}],"css_mixin":[],"cfg":[]},"requires":["Ext.layout.ClassList"]});