Instance Methods
Adds a block.
name :
String
The name of the block list ('blocks' or 'domBlocks').
layout :
Ext.layout.Layout
The layout that is blocked.
propName :
String
The property name that blocked the layout (e.g., 'width').
This method applies a versioned, deprecation declaration to this class. This
is typically called by the deprecated config.
Adds x and y values from a props object to a styles object as "left" and "top" values.
Overridden to add the x property as "right" in rtl mode.
styles :
Object
A styles object for an Element
props :
Object
A ContextItem props object
:
Number
count The number of styles that were set.
Adds a trigger.
propName :
String
The property name that triggers the layout (e.g., 'width').
inDom :
Boolean
True if the trigger list is domTriggers, false if triggers.
Registers a layout in the block list for the given property. Once the property is
set in the Ext.layout.Context, the layout is unblocked.
layout :
Ext.layout.Layout
propName :
String
The property name that blocked the layout (e.g., 'width').
Call the original method that was previously overridden with Ext.Base#override
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callOverridden();
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
args :
Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callOverridden(arguments)
:
Object
Returns the result of calling the overridden method
Deprecated since version 4.1.0
Use method-callParent instead.
Call the "parent" method of the current method. That is the method previously
overridden by derivation or by an override (see Ext#define).
Ext.define('My.Base', {
constructor: function (x) {
this.x = x;
},
statics: {
method: function (x) {
return x;
}
}
});
Ext.define('My.Derived', {
extend: 'My.Base',
constructor: function () {
this.callParent([21]);
}
});
var obj = new My.Derived();
alert(obj.x); // alerts 21
This can be used with an override as follows:
Ext.define('My.DerivedOverride', {
override: 'My.Derived',
constructor: function (x) {
this.callParent([x*2]); // calls original My.Derived constructor
}
});
var obj = new My.Derived();
alert(obj.x); // now alerts 42
This also works with static and private methods.
Ext.define('My.Derived2', {
extend: 'My.Base',
// privates: {
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Base.method
}
}
});
alert(My.Base.method(10)); // alerts 10
alert(My.Derived2.method(10)); // alerts 20
Lastly, it also works with overridden static methods.
Ext.define('My.Derived2Override', {
override: 'My.Derived2',
// privates: {
statics: {
method: function (x) {
return this.callParent([x*2]); // calls My.Derived2.method
}
}
});
alert(My.Derived2.method(10); // now alerts 40
To override a method and replace it and also call the superclass method, use
method-callSuper. This is often done to patch a method to fix a bug.
args :
Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callParent(arguments)
:
Object
Returns the result of calling the parent method
This method is used by an override to call the superclass method but
bypass any overridden method. This is often done to "patch" a method that
contains a bug but for whatever reason cannot be fixed directly.
Consider:
Ext.define('Ext.some.Class', {
method: function () {
console.log('Good');
}
});
Ext.define('Ext.some.DerivedClass', {
extend: 'Ext.some.Class',
method: function () {
console.log('Bad');
// ... logic but with a bug ...
this.callParent();
}
});
To patch the bug in Ext.some.DerivedClass.method, the typical solution is to create an
override:
Ext.define('App.patches.DerivedClass', {
override: 'Ext.some.DerivedClass',
method: function () {
console.log('Fixed');
// ... logic but with bug fixed ...
this.callSuper();
}
});
The patch method cannot use method-callParent to call the superclass
method since that would call the overridden method containing the bug. In
other words, the above patch would only produce "Fixed" then "Good" in the
console log, whereas, using callParent would produce "Fixed" then "Bad"
then "Good".
args :
Array/Arguments
The arguments, either an array or the arguments object
from the current method, for example: this.callSuper(arguments)
:
Object
Returns the result of calling the superclass method
Removes any blocks on a property in the specified set. Any layouts that were blocked
by this property and are not still blocked (by other properties) will be rescheduled.
name :
String
The name of the block list ('blocks' or 'domBlocks').
propName :
String
The property name that blocked the layout (e.g., 'width').
clears the margin cache so that marginInfo get re-read from the dom on the next call to getMarginInfo()
This is needed in some special cases where the margins have changed since the last layout, making the cached
values invalid. For example collapsed window headers have different margin than expanded ones.
This method is called to cleanup an object and its resources. After calling
this method, the object should not be used any further in any way, including
access to its methods and properties.
To prevent potential memory leaks, all object references will be nulled
at the end of destruction sequence, unless clearPropertiesOnDestroy
is set to false.
Destroys member properties by name.
If a property name is the name of a config, the getter is not invoked, so
if the config has not been initialized, nothing will be done.
The property will be destroyed, and the corrected name (if the property is a config
and config names are prefixed) will set to null in this object's dictionary.
args :
String...
One or more names of the properties to destroy and remove from the object.
Registers a layout in the DOM block list for the given property. Once the property
flushed to the DOM by the Ext.layout.Context, the layout is unblocked.
layout :
Ext.layout.Layout
propName :
String
The property name that blocked the layout (e.g., 'width').
Reschedules any layouts associated with a given trigger.
name :
String
The name of the trigger list ('triggers' or 'domTriggers').
propName :
String
The property name that triggers the layout (e.g., 'width').
Flushes any updates in the dirty collection to the DOM. This is only called if there
are dirty entries because this object is only added to the flushQueue of the
Ext.layout.Context when entries become dirty.
Gets the border information for the element as an object with left, top, right and
bottom properties holding border size in pixels. This object is only read from the
DOM on first request and is cached.
:
Object
Returns a specified config property value. If the name parameter is not passed,
all current configuration options will be returned as key value pairs.
name :
String
(optional)
The name of the config property to get.
peek :
Boolean
(optional)
true to peek at the raw value without calling the getter.
Defaults to: false
ifInitialized :
Boolean
(optional)
true to only return the initialized property value,
not the raw config value, and not to trigger initialization. Returns undefined if the
property has not yet been initialized.
Defaults to: false
:
Object
The config property value.
Gets a property of this object if it is correct in the DOM. Also tracks the current
layout as dependent on this property so that DOM writes of it will trigger the
layout to be recalculated.
propName :
String
The property name (e.g., 'width').
:
Object
The property value or undefined if not yet set or is dirty.
Returns the context item for an owned element. This should only be called on a
component's item. The list of child items is used to manage invalidating calculated
results.
nameOrEl :
String/Ext.dom.Element
The element or the name of an owned element
owner :
Ext.layout.container.Container/Ext.Component
(optional)
The owner of the
named element if the passed "nameOrEl" parameter is a String. Defaults to this
ContextItem's "target" property. For more details on owned elements see
childEls and
renderSelectors
:
Ext.layout.ContextItem
Gets the "frame" information for the element as an object with left, top, right and
bottom properties holding border+framing size in pixels. This object is calculated
on first request and is cached.
:
Object
Returns the initial configuration passed to the constructor when
instantiating this class.
Given this example Ext.button.Button definition and instance:
Ext.define('MyApp.view.Button', {
extend: 'Ext.button.Button',
xtype: 'mybutton',
scale: 'large',
enableToggle: true
});
var btn = Ext.create({
xtype: 'mybutton',
renderTo: Ext.getBody(),
text: 'Test Button'
});
Calling btn.getInitialConfig() would return an object including the config
options passed to the create method:
xtype: 'mybutton',
renderTo: // The document body itself
text: 'Test Button'
Calling btn.getInitialConfig('text')returns 'Test Button'.
name :
String
(optional)
Name of the config option to return.
:
Object/Mixed
The full config object or a single config value
when name parameter specified.
Gets the margin information for the element as an object with left, top, right and
bottom properties holding margin size in pixels. This object is only read from the
DOM on first request and is cached.
:
Object
Gets the padding information for the element as an object with left, top, right and
bottom properties holding padding size in pixels. This object is only read from the
DOM on first request and is cached.
:
Object
Gets a property of this object. Also tracks the current layout as dependent on this
property so that changes to it will trigger the layout to be recalculated.
propName :
String
The property name that blocked the layout (e.g., 'width').
:
Object
The property value or undefined if not yet set.
Returns a style for this item. Each style is read from the DOM only once on first
request and is then cached. If the value is an integer, it is parsed automatically
(so '5px' is not returned, but rather 5).
:
Object
The value of the DOM style (parsed as necessary).
Returns styles for this item. Each style is read from the DOM only once on first
request and is then cached. If the value is an integer, it is parsed automatically
(so '5px' is not returned, but rather 5).
altNames :
String[]
(optional)
The alternate names for the returned styles. If given,
these names must correspond one-for-one to the styleNames.
:
Object
The values of the DOM styles (parsed as necessary).
Returns true if the given property is correct in the DOM. This is equivalent to
calling getDomProp and not getting an undefined result. In particular,
this call registers the current layout to be triggered by flushes of this property.
propName :
String
The property name (e.g., 'width').
:
Boolean
Returns true if the given property has been set. This is equivalent to calling
getProp and not getting an undefined result. In particular, this call
registers the current layout to be triggered by changes to this property.
propName :
String
The property name (e.g., 'width').
:
Boolean
Clears all properties on this object except (perhaps) those not calculated by this
component. This is more complex than it would seem because a layout can decide to
invalidate its results and run the component's layouts again, but since some of the
values may be calculated by the container, care must be taken to preserve those
values.
full :
Boolean
True if all properties are to be invalidated, false to keep
those calculated by the ownerCt.
:
Mixed
Initialize configuration for this class. a typical example:
Ext.define('My.awesome.Class', {
// The default config
config: {
name: 'Awesome',
isAwesome: true
},
constructor: function(config) {
this.initConfig(config);
}
});
var awesome = new My.awesome.Class({
name: 'Super Awesome'
});
alert(awesome.getName()); // 'Super Awesome'
:
Ext.Base
containerLayoutDone :
Object
Invalidates the component associated with this item. The layouts for this component
and all of its contained items will be re-run after first clearing any computed
values.
If state needs to be carried forward beyond the invalidation, the options parameter
can be used.
options :
Object
An object describing how to handle the invalidation.
state :
Object
An object to Ext#apply to the state
of this item after invalidation clears all other properties.
before :
Function
item :
Ext.layout.ContextItem
after :
Function
item :
Ext.layout.ContextItem
scope :
Object
The scope to use when calling the callback functions.
Adds a "destroyable" object to an internal list of objects that will be destroyed
when this instance is destroyed (via destroy).
:
Object
Recovers a property value from the last computation and restores its value and
dirty state.
propName :
String
The name of the property to recover.
oldProps :
Object
The old "props" object from which to recover values.
oldDirty :
Object
The old "dirty" object from which to recover state.
Removes a cached ContextItem that was created using getEl. It may be
necessary to call this method if the dom reference for owned element changes so
that getEl can be called again to reinitialize the ContextItem with the
new element.
nameOrEl :
String/Ext.dom.Element
The element or the name of an owned element
owner :
Ext.layout.container.Container/Ext.Component
(optional)
The owner of the
named element if the passed "nameOrEl" parameter is a String. Defaults to this
ContextItem's "target" property.
:
Queue the setting of a DOM attribute on this ContextItem's target when next flushed.
Sets a single/multiple configuration options.
name :
String/Object
The name of the property to set, or a set of key value pairs to set.
value :
Object
(optional)
The value to set for the name parameter.
:
Ext.Base
Sets the contentHeight property. If the component uses raw content, then only the
measured height is acceptable.
Calculated values can sometimes be NaN or undefined, which generally mean the
calculation is not done. To indicate that such as value was passed, 0 is returned.
Otherwise, 1 is returned.
If the caller is not measuring (i.e., they are calculating) and the component has raw
content, 1 is returned indicating that the caller is done.
:
Number
Sets the contentWidth and contentHeight properties. If the component uses raw content,
then only the measured values are acceptable.
Calculated values can sometimes be NaN or undefined, which generally means that the
calculation is not done. To indicate that either passed value was such a value, false
returned. Otherwise, true is returned.
If the caller is not measuring (i.e., they are calculating) and the component has raw
content, true is returned indicating that the caller is done.
Sets the contentWidth property. If the component uses raw content, then only the
measured width is acceptable.
Calculated values can sometimes be NaN or undefined, which generally means that the
calculation is not done. To indicate that such as value was passed, 0 is returned.
Otherwise, 1 is returned.
If the caller is not measuring (i.e., they are calculating) and the component has raw
content, 1 is returned indicating that the caller is done.
:
Number
Sets the height and constrains the height to min/maxHeight range.
dirty :
Boolean
(optional)
Specifies if the value is currently in the DOM. A
value of false indicates that the value is already in the DOM.
Defaults to: true
:
Number
The actual height after constraining.
Sets a property value. This will unblock and/or trigger dependent layouts if the
property value is being changed. Values of NaN and undefined are not accepted by
this method.
propName :
String
The property name (e.g., 'width').
value :
Object
The new value of the property.
dirty :
Boolean
Optionally specifies if the value is currently in the DOM
(default is true which indicates the value is not in the DOM and must be flushed
at some point).
:
Number
1 if this call specified the property value, 0 if not.
Sets the height and constrains the width to min/maxWidth range.
dirty :
Boolean
(optional)
Specifies if the value is currently in the DOM. A
value of false indicates that the value is already in the DOM.
Defaults to: true
:
Number
The actual width after constraining.
Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base#self,
this.statics() is scope-independent and it always returns the class from which it was called, regardless of what
this points to during run-time
Ext.define('My.Cat', {
statics: {
totalCreated: 0,
speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
},
constructor: function() {
var statics = this.statics();
alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to
// equivalent to: My.Cat.speciesName
alert(this.self.speciesName); // dependent on 'this'
statics.totalCreated++;
},
clone: function() {
var cloned = new this.self(); // dependent on 'this'
cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName
return cloned;
}
});
Ext.define('My.SnowLeopard', {
extend: 'My.Cat',
statics: {
speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
},
constructor: function() {
this.callParent();
}
});
var cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'
var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
var clone = snowLeopard.clone();
alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
alert(clone.groupName); // alerts 'Cat'
alert(My.Cat.totalCreated); // alerts 3
:
Ext.Class
Destroys a given set of linked objects. This is only needed if
the linked object is being destroyed before this instance.
names :
String[]
The names of the linked objects to destroy.
:
Ext.Base
Static Methods
Adds new config properties to this class. This is called for classes when they
are declared, then for any mixins that class may define and finally for any
overrides defined that target the class.
mixinClass :
Ext.Class
(optional)
The mixin class if the configs are from a mixin.
Add methods / properties to the prototype of this class.
Ext.define('My.awesome.Cat', {
constructor: function() {
...
}
});
My.awesome.Cat.addMembers({
meow: function() {
alert('Meowww...');
}
});
var kitty = new My.awesome.Cat();
kitty.meow();
members :
Object
The members to add to this class.
isStatic :
Boolean
(optional)
Pass true if the members are static.
Defaults to: false
privacy :
Boolean
(optional)
Pass true if the members are private. This
only has meaning in debug mode and only for methods.
Defaults to: false
:
Add / override static properties of this class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.addStatics({
someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'
method1: function() { ... }, // My.cool.Class.method1 = function() { ... };
method2: function() { ... } // My.cool.Class.method2 = function() { ... };
});
:
Ext.Base
Borrow another class' members to the prototype of this class.
Ext.define('Bank', {
money: '$$$',
printMoney: function() {
alert('$$$$$$$');
}
});
Ext.define('Thief', {
...
});
Thief.borrow(Bank, ['money', 'printMoney']);
var steve = new Thief();
alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'
fromClass :
Ext.Base
The class to borrow members from
members :
Array/String
The names of the members to borrow
:
Ext.Base
Create a new instance of this Class.
Ext.define('My.cool.Class', {
...
});
My.cool.Class.create({
someConfig: true
});
All parameters are passed to the constructor of the class.
:
Object
Create aliases for existing prototype methods. Example:
Ext.define('My.cool.Class', {
method1: function() { ... },
method2: function() { ... }
});
var test = new My.cool.Class();
My.cool.Class.createAlias({
method3: 'method1',
method4: 'method2'
});
test.method3(); // test.method1()
My.cool.Class.createAlias('method5', 'method3');
test.method5(); // test.method3() -> test.method1()
alias :
String/Object
The new method name, or an object to set multiple aliases. See
flexSetter
Get the current class' name in string format.
Ext.define('My.cool.Class', {
constructor: function() {
alert(this.self.getName()); // alerts 'My.cool.Class'
}
});
My.cool.Class.getName(); // 'My.cool.Class'
:
String
Used internally by the mixins pre-processor
:
Override members of this class. Overridden methods can be invoked via
callParent.
Ext.define('My.Cat', {
constructor: function() {
alert("I'm a cat!");
}
});
My.Cat.override({
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
// alerts "I'm a cat!"
// alerts "Meeeeoooowwww"
Direct use of this method should be rare. Use Ext.define
instead:
Ext.define('My.CatOverride', {
override: 'My.Cat',
constructor: function() {
alert("I'm going to be a cat!");
this.callParent(arguments);
alert("Meeeeoooowwww");
}
});
The above accomplishes the same result but can be managed by the Ext.Loader
which can properly order the override and its target class and the build process
can determine whether the override is needed based on the required state of the
target class (My.Cat).
members :
Object
The properties to add to this class. This should be
specified as an object literal containing one or more properties.
:
Ext.Base
Ext JS | Terms of Use
