ckeditor 3.4.2 → 3.4.3.pre

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/commanddefinition.js

@@ -11,15 +11,15 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 
 /**
  * (Virtual Class) Do not call this constructor. This class is not really part
- *		of the API. It just illustrates the features of command objects to be
- *		passed to the {@link CKEDITOR.editor.prototype.addCommand} function.
+ * of the API.
  * @name CKEDITOR.commandDefinition
- * @constructor
+ * @class Virtual class that illustrates the features of command objects to be
+ *		passed to the {@link CKEDITOR.editor.prototype.addCommand} function.
  * @example
  */
 
  /**
- * Executes the command.
+ * The function to be fired when the commend is executed.
  * @name CKEDITOR.commandDefinition.prototype.exec
  * @function
  * @param {CKEDITOR.editor} editor The editor within which run the command.
@@ -38,9 +38,9 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 
 /**
  * Whether the command need to be hooked into the redo/undo system.
- * @name  CKEDITOR.commandDefinition.canUndo
- * @type {Boolean} If not defined or 'true' both hook into undo system, set it
- *		to 'false' explicitly  keep it out.
+ * @name  CKEDITOR.commandDefinition.prototype.canUndo
+ * @type {Boolean}
+ * @default true
  * @field
  * @example
  * editorInstance.addCommand( 'alertName',
@@ -54,18 +54,23 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  */
 
 /**
- * Whether the command is asynchronous, which means the 'afterCommandExec' event
- * will be fired by the command itself manually, and the 'exec' function return value
- * of this command is not to be returned.
- * @name  CKEDITOR.commandDefinition.async
- * @type {Boolean} If defined as 'true', the command is asynchronous.
+ * Whether the command is asynchronous, which means that the
+ * {@link CKEDITOR.editor#event:afterCommandExec} event will be fired by the
+ * command itself manually, and that the return value of this command is not to
+ * be returned by the {@link CKEDITOR.command#exec} function.
+ * @name  CKEDITOR.commandDefinition.prototype.async
+ * @default false
+ * @type {Boolean}
  * @example
- * editorInstance.addCommand( 'alertName',
+ * editorInstance.addCommand( 'loadOptions',
  * {
  *     exec : function( editor )
  *     {
  *         // Asynchronous operation below.
- *         CKEDITOR.ajax.loadXml( 'data.xml' );
+ *         CKEDITOR.ajax.loadXml( 'data.xml', function()
+ *             {
+ *                 editor.fire( 'afterCommandExec' );
+ *             ));
  *     },
  *     async : true    // The command need some time to complete after exec function returns.
  * });
@@ -73,13 +78,16 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 
 /**
  * Whether the command should give focus to the editor before execution.
- * @name  CKEDITOR.commandDefinition.editorFocus
+ * @name  CKEDITOR.commandDefinition.prototype.editorFocus
  * @type {Boolean}
+ * @default true
+ * @see CKEDITOR.command#editorFocus
  * @example
  * editorInstance.addCommand( 'maximize',
  * {
  *     exec : function( editor )
  *     {
+ *         // ...
  *     },
  *     editorFocus : false    // The command doesn't require focusing the editing document.
  * });
@@ -88,7 +96,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 
 /**
  * Whether the command state should be set to {@link CKEDITOR.TRISTATE_DISABLED} on startup.
- * @name  CKEDITOR.commandDefinition.startDisabled
+ * @name  CKEDITOR.commandDefinition.prototype.startDisabled
  * @type {Boolean}
  * @default false
  * @example
@@ -96,7 +104,26 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * {
  *     exec : function( editor )
  *     {
+ *         // ...
  *     },
  *     startDisabled : true    // Command is unavailable until selection is inside a link.
  * });
  */
+
+/**
+ * The editor modes within which the command can be executed. The execution
+ * will have no action if the current mode is not listed in this property.
+ * @name  CKEDITOR.commandDefinition.prototype.modes
+ * @type Object
+ * @default { wysiwyg : 1 }
+ * @see CKEDITOR.command#modes
+ * @example
+ * editorInstance.addCommand( 'link',
+ * {
+ *     exec : function( editor )
+ *     {
+ *         // ...
+ *     },
+ *     modes : { wysiwyg : 1 }    // Command is available in wysiwyg mode only.
+ * });
+ */

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/config.js

@@ -8,19 +8,34 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * default configuration settings.
  */
 
+/**
+ * Used in conjuction with {@link CKEDITOR.config.enterMode} and
+ * {@link CKEDITOR.config.shiftEnterMode} to make the editor produce <p>
+ * tags when using the ENTER key.
+ * @constant
+ */
 CKEDITOR.ENTER_P	= 1;
+
+/**
+ * Used in conjuction with {@link CKEDITOR.config.enterMode} and
+ * {@link CKEDITOR.config.shiftEnterMode} to make the editor produce <br>
+ * tags when using the ENTER key.
+ * @constant
+ */
 CKEDITOR.ENTER_BR	= 2;
+
+/**
+ * Used in conjuction with {@link CKEDITOR.config.enterMode} and
+ * {@link CKEDITOR.config.shiftEnterMode} to make the editor produce <div>
+ * tags when using the ENTER key.
+ * @constant
+ */
 CKEDITOR.ENTER_DIV	= 3;
 
 /**
- * Holds the default configuration settings. Changes to this object are
+ * @namespace Holds the default configuration settings. Changes to this object are
  * reflected in all editor instances, if not specificaly specified for those
  * instances.
- * @namespace
- * @example
- * // All editor created after the following setting will not load custom
- * // configuration files.
- * CKEDITOR.config.customConfig = '';
  */
 CKEDITOR.config =
 {
@@ -56,7 +71,7 @@ CKEDITOR.config =
 	 * The base href URL used to resolve relative and absolute URLs in the
 	 * editor content.
 	 * @type String
-	 * @default '' (empty string)
+	 * @default '' (empty)
 	 * @example
 	 * config.baseHref = 'http://www.example.com/path/';
 	 */
@@ -194,19 +209,29 @@ CKEDITOR.config =
 
 	/**
 	 * Sets the "id" attribute to be used on the body element of the editing
-	 * area.
+	 * area. This can be useful when reusing the original CSS file you're using
+	 * on your live website and you want to assing to the editor the same id
+	 * you're using for the region that'll hold the contents. In this way,
+	 * id specific CSS rules will be enabled.
 	 * @since 3.1
 	 * @type String
-	 * @default ''
+	 * @default '' (empty)
+	 * @example
+	 * config.bodyId = 'contents_id';
 	 */
 	bodyId : '',
 
 	/**
 	 * Sets the "class" attribute to be used on the body element of the editing
-	 * area.
+	 * area. This can be useful when reusing the original CSS file you're using
+	 * on your live website and you want to assing to the editor the same class
+	 * name you're using for the region that'll hold the contents. In this way,
+	 * class specific CSS rules will be enabled.
 	 * @since 3.1
 	 * @type String
-	 * @default ''
+	 * @default '' (empty)
+	 * @example
+	 * config.bodyClass = 'contents';
 	 */
 	bodyClass : '',
 
@@ -387,10 +412,10 @@ CKEDITOR.config =
 };
 
 /**
- * Indicates that some of the editor features, like alignement and text
+ * Indicates that some of the editor features, like alignment and text
  * direction, should used the "computed value" of the feature to indicate it's
- * on/off state, instead of using the "real value".
- *
+ * on/off state, instead of using the "real value".<br />
+ * <br />
  * If enabled, in a left to right written document, the "Left Justify"
  * alignment button will show as active, even if the aligment style is not
  * explicitly applied to the current paragraph in the editor.

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/dataprocessor.js

@@ -15,18 +15,17 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * Generaly it will point to an instance of {@link CKEDITOR.htmlDataProcessor},
  * which handles HTML data. The editor may also handle other data formats by
  * using different data processors provided by specific plugins.
- * @name CKEDITOR.editor.dataProcessor
+ * @name CKEDITOR.editor.prototype.dataProcessor
  * @type CKEDITOR.dataProcessor
  */
 
 /**
- * Represents a data processor, which is responsible to translate and transform
- * the editor data on input and output.
- * This class is not really part of the API. It's here for documentation
- * purposes, and serves as the base ("interface") for data processors
+ * This class is here for documentation purposes only and is not really part of
+ * the API. It serves as the base ("interface") for data processors
  * implementation.
  * @name CKEDITOR.dataProcessor
- * @contructor
+ * @class Represents a data processor, which is responsible to translate and
+ *        transform the editor data on input and output.
  * @example
  */
 

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/dom.js

@@ -9,10 +9,9 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  */
 
 /**
- * DOM manipulation objects and function.<br /><br />
+ * @namespace DOM manipulation objects, classes and functions.
  * @see CKEDITOR.dom.element
  * @see CKEDITOR.dom.node
- * @namespace
  * @example
  */
 CKEDITOR.dom =

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/dom/documentfragment.js

@@ -2,13 +2,13 @@
 Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
 For licensing, see LICENSE.html or http://ckeditor.com/license
 */
+
 /**
- * DocumentFragment is a "lightweight" or "minimal" Document object. It is
+ * @class DocumentFragment is a "lightweight" or "minimal" Document object. It is
  * commonly used to extract a portion of a document's tree or to create a new
  * fragment of a document. Various operations may take DocumentFragment objects
  * as arguments and results in all the child nodes of the DocumentFragment being
  * moved to the child list of this node.
- *
  * @param {Object} ownerDocument
  */
 CKEDITOR.dom.documentFragment = function( ownerDocument )

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/dom/domobject.js

@@ -84,10 +84,10 @@ CKEDITOR.dom.domObject.prototype = (function()
 			{
 				var listener = nativeListeners[ eventName ] = getNativeListener( this, eventName );
 
-				if ( this.$.addEventListener )
-					this.$.addEventListener( eventName, listener, !!CKEDITOR.event.useCapture );
-				else if ( this.$.attachEvent )
+				if ( this.$.attachEvent )
 					this.$.attachEvent( 'on' + eventName, listener );
+				else if ( this.$.addEventListener )
+					this.$.addEventListener( eventName, listener, !!CKEDITOR.event.useCapture );
 			}
 
 			// Call the original implementation.
@@ -107,10 +107,10 @@ CKEDITOR.dom.domObject.prototype = (function()
 				var listener = nativeListeners && nativeListeners[ eventName ];
 				if ( listener )
 				{
-					if ( this.$.removeEventListener )
-						this.$.removeEventListener( eventName, listener, false );
-					else if ( this.$.detachEvent )
+					if ( this.$.detachEvent )
 						this.$.detachEvent( 'on' + eventName, listener );
+					else if ( this.$.removeEventListener )
+						this.$.removeEventListener( eventName, listener, false );
 
 					delete nativeListeners[ eventName ];
 				}
@@ -128,10 +128,10 @@ CKEDITOR.dom.domObject.prototype = (function()
 			for ( var eventName in nativeListeners )
 			{
 				var listener = nativeListeners[ eventName ];
-				if ( this.$.removeEventListener )
-					this.$.removeEventListener( eventName, listener, false );
-				else if ( this.$.detachEvent )
+				if ( this.$.detachEvent )
 					this.$.detachEvent( 'on' + eventName, listener );
+				else if ( this.$.removeEventListener )
+					this.$.removeEventListener( eventName, listener, false );
 
 				delete nativeListeners[ eventName ];
 			}
@@ -238,7 +238,11 @@ CKEDITOR.dom.domObject.prototype = (function()
 	};
 
 	/**
-	 * @name CKEDITOR.dom.domObject.prototype.getCustomData
+	 * Gets an ID that can be used to identiquely identify this DOM object in
+	 * the running session.
+	 * @name CKEDITOR.dom.domObject.prototype.getUniqueId
+	 * @function
+	 * @returns {Number} A unique ID.
 	 */
 	domObjectProto.getUniqueId = function()
 	{

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/dom/element.js

@@ -88,7 +88,7 @@ CKEDITOR.dom.element.setMarker = function( database, element, name, value )
 CKEDITOR.dom.element.clearAllMarkers = function( database )
 {
 	for ( var i in database )
-		CKEDITOR.dom.element.clearMarkers( database, database[i], true );
+		CKEDITOR.dom.element.clearMarkers( database, database[i], 1 );
 };
 
 CKEDITOR.dom.element.clearMarkers = function( database, element, removeFromDatabase )
@@ -1170,13 +1170,13 @@ CKEDITOR.tools.extend( CKEDITOR.dom.element.prototype,
 				function()
 				{
 					this.$.style.MozUserSelect = 'none';
-					this.on( 'dragstart', function (evt) { evt.data.preventDefault(); } );
+					this.on( 'dragstart', function( evt ) { evt.data.preventDefault(); } );
 				}
 			: CKEDITOR.env.webkit ?
 				function()
 				{
 					this.$.style.KhtmlUserSelect = 'none';
-					this.on( 'dragstart', function (evt) { evt.data.preventDefault(); } );
+					this.on( 'dragstart', function( evt ) { evt.data.preventDefault(); } );
 				}
 			:
 				function()
@@ -1545,12 +1545,20 @@ CKEDITOR.tools.extend( CKEDITOR.dom.element.prototype,
 						if ( isBorderBox && !( CKEDITOR.env.ie && CKEDITOR.env.quirks ) )
 						{
 							var	adjustment = 0;
-							for ( var i = 0, len = sides [ type ].length; i < len; i++ )
-								adjustment += parseInt( this.getComputedStyle( sides [ type ][ i ] ) || 0, 10 );
+							for ( var i = 0, len = sides[ type ].length; i < len; i++ )
+								adjustment += parseInt( this.getComputedStyle( sides [ type ][ i ] ) || 0, 10 ) || 0;
 							size -= adjustment;
 						}
 						this.setStyle( type, size + 'px' );
 					}
 				};
-		})()
+		})(),
+
+		/**
+		 * Gets element's direction. Supports both CSS 'direction' prop and 'dir' attr.
+		 */
+		getDirection : function( useComputed )
+		{
+			return useComputed ? this.getComputedStyle( 'direction' ) : this.getStyle( 'direction' ) || this.getAttribute( 'dir' );
+		}
 	});

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/dom/elementpath.js

@@ -27,6 +27,9 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 		return false;
 	};
 
+	/**
+	 * @class
+	 */
 	CKEDITOR.dom.elementPath = function( lastNode )
 	{
 		var block = null;

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/dom/nodelist.js

@@ -3,6 +3,9 @@ Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
 For licensing, see LICENSE.html or http://ckeditor.com/license
 */
 
+/**
+ * @class
+ */
 CKEDITOR.dom.nodeList = function( nativeList )
 {
 	this.$ = nativeList;

data/{generators/ckeditor_install → lib/generators/ckeditor/base}/templates/ckeditor/_source/core/dom/range.js

@@ -3,6 +3,9 @@ Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.
 For licensing, see LICENSE.html or http://ckeditor.com/license
 */
 
+/**
+ * @class
+ */
 CKEDITOR.dom.range = function( document )
 {
 	this.startContainer	= null;
@@ -1300,7 +1303,8 @@ CKEDITOR.dom.range = function( document )
 					}
 				}
 
-				var walker = new CKEDITOR.dom.walker( walkerRange );
+				var walker = new CKEDITOR.dom.walker( walkerRange ),
+					isBookmark = CKEDITOR.dom.walker.bookmark();
 
 				walker.evaluator = function( node )
 				{
@@ -1311,6 +1315,9 @@ CKEDITOR.dom.range = function( document )
 				var currentElement;
 				walker.guard = function( node, movingOut )
 				{
+					if ( isBookmark( node ) )
+						return true;
+
 					// Stop when we're shrink in element mode while encountering a text node.
 					if ( mode == CKEDITOR.SHRINK_ELEMENT && node.type == CKEDITOR.NODE_TEXT )
 						return false;
@@ -1429,7 +1436,7 @@ CKEDITOR.dom.range = function( document )
 			// Fixing invalid range end inside dtd empty elements.
 			if( endNode.type == CKEDITOR.NODE_ELEMENT
 				&& CKEDITOR.dtd.$empty[ endNode.getName() ] )
-				endNode = endNode.getParent(), endOffset = endNode.getIndex() + 1;
+				endOffset = endNode.getIndex() + 1, endNode = endNode.getParent();
 
 			this.endContainer	= endNode;
 			this.endOffset		= endOffset;
@@ -1864,17 +1871,13 @@ CKEDITOR.ENLARGE_ELEMENT = 1;
 CKEDITOR.ENLARGE_BLOCK_CONTENTS = 2;
 CKEDITOR.ENLARGE_LIST_ITEM_CONTENTS = 3;
 
-/**
- * Check boundary types.
- * @see CKEDITOR.dom.range.prototype.checkBoundaryOfElement
- */
+// Check boundary types.
+// @see CKEDITOR.dom.range.prototype.checkBoundaryOfElement
 CKEDITOR.START = 1;
 CKEDITOR.END = 2;
 CKEDITOR.STARTEND = 3;
 
-/**
- * Shrink range types.
- * @see CKEDITOR.dom.range.prototype.shrink
- */
+// Shrink range types.
+// @see CKEDITOR.dom.range.prototype.shrink
 CKEDITOR.SHRINK_ELEMENT = 1;
 CKEDITOR.SHRINK_TEXT = 2;