tinymce.util.Tools

This class contains various utlity functions. These are also exposed directly on the tinymce namespace.

Methods

name summary defined by
create() Creates a class, subclass or static singleton. More details on this method can be found in the Wiki. tinymce.util.Tools
createNS() Creates a namespace on a specific object. tinymce.util.Tools
each() Performs an iteration of all items in a collection such as an object or array. This method will execure the callback function for each item in the collection, if the callback returns false the iteration will terminate. The callback has the following format: cb(value, key_or_index). tinymce.util.Tools
explode() Splits a string but removes the whitespace before and after each value. tinymce.util.Tools
grep() Filters out items from the input array by calling the specified function for each item. If the function returns false the item will be excluded if it returns true it will be included. tinymce.util.Tools
inArray() Returns an index of the item or -1 if item is not present in the array. tinymce.util.Tools
is() Checks if a object is of a specific type for example an array. tinymce.util.Tools
isArray() Returns true/false if the object is an array or not. tinymce.util.Tools
makeMap() Makes a name/object map out of an array with names. tinymce.util.Tools
map() Creates a new array by the return value of each iteration function call. This enables you to convert one array list into another. tinymce.util.Tools
resolve() Resolves a string and returns the object from a specific structure. tinymce.util.Tools
toArray() Converts the specified object into a real JavaScript array. tinymce.util.Tools
trim() Removes whitespace from the beginning and end of a string. tinymce.util.Tools
walk() Executed the specified function for each item in a object tree. tinymce.util.Tools

Methods

create

create(s:String, p:Object, root:Object)

Creates a class, subclass or static singleton. More details on this method can be found in the Wiki.

Examples
// Creates a basic class
tinymce.create('tinymce.somepackage.SomeClass', {
    SomeClass: function() {
        // Class constructor
    },

    method: function() {
        // Some method
    }
});

// Creates a basic subclass class
tinymce.create('tinymce.somepackage.SomeSubClass:tinymce.somepackage.SomeClass', {
    SomeSubClass: function() {
        // Class constructor
        this.parent(); // Call parent constructor
    },

    method: function() {
        // Some method
        this.parent(); // Call parent method
    },

    'static': {
        staticMethod: function() {
            // Static method
        }
    }
});

// Creates a singleton/static class
tinymce.create('static tinymce.somepackage.SomeSingletonClass', {
    method: function() {
        // Some method
    }
});
Parameters

createNS

createNS(n:String, o:Object):Object

Creates a namespace on a specific object.

Examples
// Create some namespace
tinymce.createNS('tinymce.somepackage.subpackage');

// Add a singleton
var tinymce.somepackage.subpackage.SomeSingleton = {
    method: function() {
        // Some method
    }
};
Parameters
Return value

each

each(o:Object, cb:function, s:Object)

Performs an iteration of all items in a collection such as an object or array. This method will execure the callback function for each item in the collection, if the callback returns false the iteration will terminate. The callback has the following format: cb(value, key_or_index).

Examples
// Iterate an array
tinymce.each([1,2,3], function(v, i) {
    console.debug("Value: " + v + ", Index: " + i);
});

// Iterate an object
tinymce.each({a: 1, b: 2, c: 3], function(v, k) {
    console.debug("Value: " + v + ", Key: " + k);
});
Parameters

explode

explode(s:string, d:string)

Splits a string but removes the whitespace before and after each value.

Examples
// Split a string into an array with a,b,c
var arr = tinymce.explode('a, b,   c');
Parameters

grep

grep(a:Array, f:function):Array

Filters out items from the input array by calling the specified function for each item. If the function returns false the item will be excluded if it returns true it will be included.

Examples
// Filter out some items, this will return an array with 4 and 5
var items = tinymce.grep([1,2,3,4,5], function(v) {return v > 3;});
Parameters
Return value

inArray

inArray(item:any, arr:Array):Number

Returns an index of the item or -1 if item is not present in the array.

Parameters
Return value

is

is(obj:Object, type:string):Boolean

Checks if a object is of a specific type for example an array.

Parameters
Return value

isArray

isArray(obj:Object):boolean

Returns true/false if the object is an array or not.

Parameters
Return value

makeMap

makeMap(items:Array, delim:String, map:Object):Object

Makes a name/object map out of an array with names.

Parameters
Return value

map

map(array:Array, callback:function):Array

Creates a new array by the return value of each iteration function call. This enables you to convert one array list into another.

Parameters
Return value

resolve

resolve(n:String, o:Object):Object

Resolves a string and returns the object from a specific structure.

Examples
// Resolve a path into an object reference
var obj = tinymce.resolve('a.b.c.d');
Parameters
Return value

toArray

toArray(obj:Object):Array

Converts the specified object into a real JavaScript array.

Parameters
Return value

trim

trim(s:String):String

Removes whitespace from the beginning and end of a string.

Parameters
Return value

walk

walk(o:Object, f:function, n:String, s:String)

Executed the specified function for each item in a object tree.

Parameters

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.