X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;ds=sidebyside;f=_source%2Fcore%2Ftools.js;h=a1bff9af0da81409fca280cd54ae3a24aff4b923;hb=e371ddf8abcb89013e20e6d0dd746adec344d0e5;hp=6fb417b8ed66fd956aa0123cb31eb01c515df9c5;hpb=941b0a9ba4e673e292510d80a5a86806994b8ea6;p=ckeditor.git

diff --git a/_source/core/tools.js b/_source/core/tools.js
index 6fb417b..a1bff9a 100644
--- a/_source/core/tools.js
+++ b/_source/core/tools.js
@@ -12,6 +12,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 {
 	var functions = [];
 
+	CKEDITOR.on( 'reset', function()
+		{
+			functions = [];
+		});
+
 	/**
 	 * Utility functions.
 	 * @namespace
@@ -215,6 +220,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			return ( !!object && object instanceof Array );
 		},
 
+		/**
+		 * Whether the object contains no properties of it's own.
+ 		 * @param object
+		 */
 		isEmpty : function ( object )
 		{
 			for ( var i in object )
@@ -224,6 +233,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			}
 			return true;
 		},
+
 		/**
 		 * Transforms a CSS property name to its relative DOM style name.
 		 * @param {String} cssName The CSS property name.
@@ -255,7 +265,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 		} )(),
 
 		/**
-		 * Build the HTML snippet of a set of <style>/<link>.
+		 * Build the HTML snippet of a set of &lt;style>/&lt;link>.
 		 * @param css {String|Array} Each of which are url (absolute) of a CSS file or
 		 * a trunk of style text.
 		 */
@@ -323,6 +333,19 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 		},
 
 		/**
+		 * Replace special HTML characters in HTMLElement's attribute with their relative HTML entity values.
+		 * @param {String} The attribute's value to be encoded.
+		 * @returns {String} The encode value.
+		 * @example
+		 * element.setAttribute( 'title', '<a " b >' );
+		 * alert( CKEDITOR.tools.htmlEncodeAttr( element.getAttribute( 'title' ) );  // "&gt;a &quot; b &lt;"
+		 */
+		htmlEncodeAttr : function( text )
+		{
+			return text.replace( /"/g, '&quot;' ).replace( /</g, '&lt;' ).replace( />/g, '&gt;' );
+		},
+
+		/**
 		 * Replace characters can't be represented through CSS Selectors string
 		 * by CSS Escape Notation where the character escape sequence consists
 		 * of a backslash character (\) followed by the orginal characters.
@@ -354,6 +377,20 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 		})(),
 
 		/**
+		 * Gets a unique ID for CKEditor's interface elements. It returns a
+		 * string with the "cke_" prefix and a progressive number.
+		 * @function
+		 * @returns {String} A unique ID.
+		 * @example
+		 * alert( CKEDITOR.tools.<b>getNextId()</b> );  // "cke_1" (e.g.)
+		 * alert( CKEDITOR.tools.<b>getNextId()</b> );  // "cke_2"
+		 */
+		getNextId : function()
+		{
+			return 'cke_' + this.getNextNumber();
+		},
+
+		/**
 		 * Creates a function override.
 		 * @param {Function} originalFunction The function to be overridden.
 		 * @param {Function} functionBuilder A function that returns the new
@@ -540,7 +577,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 		 * <li> Public (prototype) fields </li>
 		 * <li> Chainable base class constructor </li>
 		 * </ul>
-		 * @param {Object} definiton The class definiton object.
+		 * @param {Object} definition The class definition object.
 		 * @returns {Function} A class-like JavaScript function.
 		 */
 		createClass : function( definition )
@@ -619,6 +656,16 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 		},
 
 		/**
+		 * Removes the function reference created with {@see CKEDITOR.tools.addFunction}.
+		 * @param {Number} ref The function reference created with
+		 *		CKEDITOR.tools.addFunction.
+		 */
+		removeFunction : function( ref )
+		{
+			functions[ ref ] = null;
+		},
+
+		/**
 		 * Executes a function based on the reference created with
 		 * CKEDITOR.tools.addFunction.
 		 * @param {Number} ref The function reference created with
@@ -640,6 +687,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			return fn && fn.apply( window, Array.prototype.slice.call( arguments, 1 ) );
 		},
 
+		/**
+		 * Append the 'px' length unit to the size if it's missing.
+		 * @param length
+		 */
 		cssLength : (function()
 		{
 			var decimalRegex = /^\d+(?:\.\d+)?$/;
@@ -649,11 +700,20 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 			};
 		})(),
 
+		/**
+		 * String specified by {@param str} repeats {@param times} times.
+		 * @param str
+		 * @param times
+		 */
 		repeat : function( str, times )
 		{
 			return new Array( times + 1 ).join( str );
 		},
 
+		/**
+		 * Return the first successfully executed function's return value that
+		 * doesn't throw any exception.
+		 */
 		tryThese : function()
 		{
 			var returnValue;
@@ -668,6 +728,18 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 				catch (e) {}
 			}
 			return returnValue;
+		},
+
+		/**
+		 * Generate a combined key from a series of params.
+		 * @param {String} subKey One or more string used as sub keys.
+		 * @example
+		 * var key = CKEDITOR.tools.genKey( 'key1', 'key2', 'key3' );
+		 * alert( key );		// "key1-key2-key3".
+		 */
+		genKey : function()
+		{
+			return Array.prototype.slice.call( arguments ).join( '-' );
 		}
 	};
 })();