scratchfoundation/paper.js
1
0
Fork 0
mirror of https://github.com/scratchfoundation/paper.js.git synced 2025-03-13 16:33:28 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve documentation of added Base methods.

Browse source
This commit is contained in:
Jürg Lehni 2011-06-20 13:56:08 +01:00
parent 08571fd399
commit b9ebd12d22
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
src/core/Base.js
View file

@ -18,11 +18,24 @@
// this.Base, since bootstrap.js ommits that.
this.Base = Base.inject({
/**
* General purpose clone function that delegates cloning to the constructor
* that receives the object to be cloned as the first argument.
* Note: #clone() needs to be overridden in any class that requires other
* cloning behavior.
*/
clone: function() {
return new this.constructor(this);
},
statics: {
/**
* Reads arguments of the type of the class on which it is called on
* from the passed arguments list or array, at the given index, up to
* the specified length. This is used in argument conversion, e.g. by
* all basic types (Point, Size, Rectangle) and also higher classes such
* as Color and Segment.
*/
read: function(list, start, length) {
var start = start || 0,
length = length || list.length - start;
@ -38,6 +51,10 @@ this.Base = Base.inject({
: list) || obj;
},
/**
* Reads all readable arguments from the list, handling nested arrays
* seperately.
*/
readAll: function(list, start) {
var res = [], entry;
for (var i = start || 0, l = list.length; i < l; i++) {
@ -91,12 +108,18 @@ this.Base = Base.inject({
}
},
/**
* Capitalizes the passed string: hello world -> Hello World
*/
capitalize: function(str) {
return str.replace(/\b[a-z]/g, function(match) {
return match.toUpperCase();
});
},
/**
* Camelizes the passed string: caps-lock -> capsLock
*/
camelize: function(str) {
return str.replace(/-(\w)/g, function(all, chr) {
return chr.toUpperCase();