X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/3789b528d8dd8aad4558e38e22d775bcab1cbd36..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/Base3.html
diff --git a/docs/source/Base3.html b/docs/source/Base3.html
index ed5abbe8..7c55ec8c 100644
--- a/docs/source/Base3.html
+++ b/docs/source/Base3.html
@@ -3,8 +3,8 @@
The source code
-
-
+
+
@@ -20,9 +20,10 @@
* @docauthor Jacky Nguyen <jacky@sencha.com>
* @class Ext.Base
*
- * The root of all classes created with {@link Ext#define}
- * All prototype and static members of this class are inherited by any other class
+ * The root of all classes created with {@link Ext#define}.
*
+ * Ext.Base is the building block of all Ext classes. All classes in Ext inherit from Ext.Base.
+ * All prototype and static members of this class are inherited by all other classes.
*/
(function(flexSetter) {
@@ -67,23 +68,17 @@ var Base = Ext.Base = function() {};
* var clone = snowLeopard.clone();
* alert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'
*
- * @type Class
+ * @type Ext.Class
* @protected
- * @markdown
*/
self: Base,
- /**
- * Default constructor, simply returns `this`
- *
- * @constructor
- * @protected
- * @return {Object} this
- */
+ // Default constructor, simply returns `this`
constructor: function() {
return this;
},
+ //<feature classSystem.config>
/**
* Initialize configuration for this class. a typical example:
*
@@ -110,7 +105,6 @@ var Base = Ext.Base = function() {};
* @protected
* @param {Object} config
* @return {Object} mixins The mixin prototypes as key - value pairs
- * @markdown
*/
initConfig: function(config) {
if (!this.$configInited) {
@@ -145,6 +139,7 @@ var Base = Ext.Base = function() {};
return this;
}),
+ //</feature>
/**
* Call the parent's overridden method. For example:
@@ -183,8 +178,7 @@ var Base = Ext.Base = function() {};
* @protected
* @param {Array/Arguments} args The arguments, either an array or the `arguments` object
* from the current method, for example: `this.callParent(arguments)`
- * @return {Mixed} Returns the result from the superclass' method
- * @markdown
+ * @return {Object} Returns the result from the superclass' method
*/
callParent: function(args) {
var method = this.callParent.caller,
@@ -232,25 +226,25 @@ var Base = Ext.Base = function() {};
* 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++;
- *
+ *
* return this;
* },
- *
+ *
* clone: function() {
* var cloned = new this.self; // dependent on 'this'
- *
+ *
* cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName
- *
+ *
* return cloned;
* }
* });
@@ -258,11 +252,11 @@ var Base = Ext.Base = function() {};
*
* Ext.define('My.SnowLeopard', {
* extend: 'My.Cat',
- *
+ *
* statics: {
* speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'
* },
- *
+ *
* constructor: function() {
* this.callParent();
* }
@@ -279,8 +273,7 @@ var Base = Ext.Base = function() {};
* alert(My.Cat.totalCreated); // alerts 3
*
* @protected
- * @return {Class}
- * @markdown
+ * @return {Ext.Class}
*/
statics: function() {
var method = this.statics.caller,
@@ -299,7 +292,7 @@ var Base = Ext.Base = function() {};
* Ext.define('My.Cat', {
* constructor: function() {
* alert("I'm a cat!");
- *
+ *
* return this;
* }
* });
@@ -307,11 +300,11 @@ var Base = Ext.Base = function() {};
* My.Cat.override({
* constructor: function() {
* alert("I'm going to be a cat!");
- *
+ *
* var instance = this.callOverridden();
- *
+ *
* alert("Meeeeoooowwww");
- *
+ *
* return instance;
* }
* });
@@ -321,8 +314,8 @@ var Base = Ext.Base = function() {};
* // alerts "Meeeeoooowwww"
*
* @param {Array/Arguments} args The arguments, either an array or the `arguments` object
- * @return {Mixed} Returns the result after calling the overridden method
- * @markdown
+ * @return {Object} Returns the result after calling the overridden method
+ * @protected
*/
callOverridden: function(args) {
var method = this.callOverridden.caller;
@@ -354,45 +347,48 @@ var Base = Ext.Base = function() {};
// These static properties will be copied to every newly created class with {@link Ext#define}
Ext.apply(Ext.Base, {
- /**
+ /**
* Create a new instance of this Class.
*
* Ext.define('My.cool.Class', {
* ...
* });
- *
+ *
* My.cool.Class.create({
* someConfig: true
* });
*
- * @property create
+ * All parameters are passed to the constructor of the class.
+ *
+ * @return {Object} the created instance.
* @static
- * @type Function
- * @markdown
+ * @inheritable
*/
create: function() {
return Ext.create.apply(Ext, [this].concat(Array.prototype.slice.call(arguments, 0)));
},
- /**
+ /**
* @private
+ * @inheritable
*/
- own: flexSetter(function(name, value) {
- if (typeof value === 'function') {
+ own: function(name, value) {
+ if (typeof value == 'function') {
this.ownMethod(name, value);
}
else {
this.prototype[name] = value;
}
- }),
+ },
/**
* @private
+ * @inheritable
*/
ownMethod: function(name, fn) {
var originalFn;
- if (fn.$owner !== undefined && fn !== Ext.emptyFn) {
+ if (typeof fn.$owner !== 'undefined' && fn !== Ext.emptyFn) {
originalFn = fn;
fn = function() {
@@ -413,7 +409,7 @@ var Base = Ext.Base = function() {};
this.prototype[name] = fn;
},
- /**
+ /**
* Add / override static properties of this class.
*
* Ext.define('My.cool.Class', {
@@ -426,11 +422,10 @@ var Base = Ext.Base = function() {};
* method2: function() { ... } // My.cool.Class.method2 = function() { ... };
* });
*
- * @property addStatics
- * @static
- * @type Function
* @param {Object} members
- * @markdown
+ * @return {Ext.Base} this
+ * @static
+ * @inheritable
*/
addStatics: function(members) {
for (var name in members) {
@@ -442,7 +437,49 @@ var Base = Ext.Base = function() {};
return this;
},
- /**
+ /**
+ * @private
+ * @param {Object} members
+ */
+ addInheritableStatics: function(members) {
+ var inheritableStatics,
+ hasInheritableStatics,
+ prototype = this.prototype,
+ name, member;
+
+ inheritableStatics = prototype.$inheritableStatics;
+ hasInheritableStatics = prototype.$hasInheritableStatics;
+
+ if (!inheritableStatics) {
+ inheritableStatics = prototype.$inheritableStatics = [];
+ hasInheritableStatics = prototype.$hasInheritableStatics = {};
+ }
+
+ //<debug>
+ var className = Ext.getClassName(this);
+ //</debug>
+
+ for (name in members) {
+ if (members.hasOwnProperty(name)) {
+ member = members[name];
+ //<debug>
+ if (typeof member == 'function') {
+ member.displayName = className + '.' + name;
+ }
+ //</debug>
+ this[name] = member;
+
+ if (!hasInheritableStatics[name]) {
+ hasInheritableStatics[name] = true;
+ inheritableStatics.push(name);
+ }
+ }
+ }
+
+ return this;
+ },
+
+ /**
* Add methods / properties to the prototype of this class.
*
* Ext.define('My.awesome.Cat', {
@@ -460,15 +497,14 @@ var Base = Ext.Base = function() {};
* var kitty = new My.awesome.Cat;
* kitty.meow();
*
- * @property implement
- * @static
- * @type Function
* @param {Object} members
- * @markdown
+ * @static
+ * @inheritable
*/
implement: function(members) {
var prototype = this.prototype,
- name, i, member, previous;
+ enumerables = Ext.enumerables,
+ name, i, member;
//<debug>
var className = Ext.getClassName(this);
//</debug>
@@ -490,9 +526,7 @@ var Base = Ext.Base = function() {};
}
}
- if (Ext.enumerables) {
- var enumerables = Ext.enumerables;
-
+ if (enumerables) {
for (i = enumerables.length; i--;) {
name = enumerables[i];
@@ -506,7 +540,7 @@ var Base = Ext.Base = function() {};
}
},
- /**
+ /**
* Borrow another class' members to the prototype of this class.
*
* Ext.define('Bank', {
@@ -527,13 +561,11 @@ var Base = Ext.Base = function() {};
* alert(steve.money); // alerts '$$$'
* steve.printMoney(); // alerts '$$$$$$$'
*
- * @property borrow
- * @static
- * @type Function
* @param {Ext.Base} fromClass The class to borrow members from
- * @param {Array/String} members The names of the members to borrow
+ * @param {String/String[]} members The names of the members to borrow
* @return {Ext.Base} this
- * @markdown
+ * @static
+ * @inheritable
*/
borrow: function(fromClass, members) {
var fromPrototype = fromClass.prototype,
@@ -550,7 +582,7 @@ var Base = Ext.Base = function() {};
return this;
},
- /**
+ /**
* Override prototype members of this class. Overridden methods can be invoked via
* {@link Ext.Base#callOverridden}
*
@@ -578,17 +610,35 @@ var Base = Ext.Base = function() {};
* // alerts "I'm a cat!"
* // alerts "Meeeeoooowwww"
*
- * @property override
- * @static
- * @type Function
* @param {Object} members
* @return {Ext.Base} this
- * @markdown
+ * @static
+ * @inheritable
*/
override: function(members) {
var prototype = this.prototype,
+ enumerables = Ext.enumerables,
name, i, member, previous;
+ if (arguments.length === 2) {
+ name = members;
+ member = arguments[1];
+
+ if (typeof member == 'function') {
+ if (typeof prototype[name] == 'function') {
+ previous = prototype[name];
+ member.$previous = previous;
+ }
+
+ this.ownMethod(name, member);
+ }
+ else {
+ prototype[name] = member;
+ }
+
+ return this;
+ }
+
for (name in members) {
if (members.hasOwnProperty(name)) {
member = members[name];
@@ -607,14 +657,12 @@ var Base = Ext.Base = function() {};
}
}
- if (Ext.enumerables) {
- var enumerables = Ext.enumerables;
-
+ if (enumerables) {
for (i = enumerables.length; i--;) {
name = enumerables[i];
if (members.hasOwnProperty(name)) {
- if (prototype[name] !== undefined) {
+ if (typeof prototype[name] !== 'undefined') {
previous = prototype[name];
members[name].$previous = previous;
}
@@ -627,46 +675,60 @@ var Base = Ext.Base = function() {};
return this;
},
- /**
+ //<feature classSystem.mixins>
+ /**
* Used internally by the mixins pre-processor
* @private
+ * @inheritable
*/
- mixin: flexSetter(function(name, cls) {
+ mixin: function(name, cls) {
var mixin = cls.prototype,
my = this.prototype,
- i, fn;
+ key, fn;
- for (i in mixin) {
- if (mixin.hasOwnProperty(i)) {
- if (my[i] === undefined) {
- if (typeof mixin[i] === 'function') {
- fn = mixin[i];
+ for (key in mixin) {
+ if (mixin.hasOwnProperty(key)) {
+ if (typeof my[key] === 'undefined' && key !== 'mixins' && key !== 'mixinId') {
+ if (typeof mixin[key] === 'function') {
+ fn = mixin[key];
- if (fn.$owner === undefined) {
- this.ownMethod(i, fn);
+ if (typeof fn.$owner === 'undefined') {
+ this.ownMethod(key, fn);
}
else {
- my[i] = fn;
+ my[key] = fn;
}
}
else {
- my[i] = mixin[i];
+ my[key] = mixin[key];
}
}
- else if (i === 'config' && my.config && mixin.config) {
+ //<feature classSystem.config>
+ else if (key === 'config' && my.config && mixin.config) {
Ext.Object.merge(my.config, mixin.config);
}
+ //</feature>
}
}
- if (my.mixins === undefined) {
- my.mixins = {};
+ if (typeof mixin.onClassMixedIn !== 'undefined') {
+ mixin.onClassMixedIn.call(cls, this);
+ }
+
+ if (!my.hasOwnProperty('mixins')) {
+ if ('mixins' in my) {
+ my.mixins = Ext.Object.merge({}, my.mixins);
+ }
+ else {
+ my.mixins = {};
+ }
}
my.mixins[name] = mixin;
- }),
+ },
+ //</feature>
- /**
+ /**
* Get the current class' name in string format.
*
* Ext.define('My.cool.Class', {
@@ -678,13 +740,14 @@ var Base = Ext.Base = function() {};
* My.cool.Class.getName(); // 'My.cool.Class'
*
* @return {String} className
- * @markdown
+ * @static
+ * @inheritable
*/
getName: function() {
return Ext.getClassName(this);
},
- /**
+ /**
* Create aliases for existing prototype methods. Example:
*
* Ext.define('My.cool.Class', {
@@ -705,16 +768,17 @@ var Base = Ext.Base = function() {};
*
* test.method5(); // test.method3() -> test.method1()
*
- * @property createAlias
- * @static
- * @type Function
* @param {String/Object} alias The new method name, or an object to set multiple aliases. See
* {@link Ext.Function#flexSetter flexSetter}
* @param {String/Object} origin The original method name
- * @markdown
+ * @static
+ * @inheritable
+ * @method
*/
createAlias: flexSetter(function(alias, origin) {
- this.prototype[alias] = this.prototype[origin];
+ this.prototype[alias] = function() {
+ return this[origin].apply(this, arguments);
+ }
})
});