2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
7 * @fileOverview Defines the {@link CKEDITOR.dom.node} class which is the base
\r
8 * class for classes that represent DOM nodes.
\r
12 * Base class for classes representing DOM nodes. This constructor may return
\r
13 * an instance of a class that inherits from this class, like
\r
14 * {@link CKEDITOR.dom.element} or {@link CKEDITOR.dom.text}.
\r
15 * @augments CKEDITOR.dom.domObject
\r
16 * @param {Object} domNode A native DOM node.
\r
18 * @see CKEDITOR.dom.element
\r
19 * @see CKEDITOR.dom.text
\r
22 CKEDITOR.dom.node = function( domNode )
\r
26 switch ( domNode.nodeType )
\r
28 // Safari don't consider document as element node type. (#3389)
\r
29 case CKEDITOR.NODE_DOCUMENT :
\r
30 return new CKEDITOR.dom.document( domNode );
\r
32 case CKEDITOR.NODE_ELEMENT :
\r
33 return new CKEDITOR.dom.element( domNode );
\r
35 case CKEDITOR.NODE_TEXT :
\r
36 return new CKEDITOR.dom.text( domNode );
\r
39 // Call the base constructor.
\r
40 CKEDITOR.dom.domObject.call( this, domNode );
\r
46 CKEDITOR.dom.node.prototype = new CKEDITOR.dom.domObject();
\r
49 * Element node type.
\r
53 CKEDITOR.NODE_ELEMENT = 1;
\r
56 * Document node type.
\r
60 CKEDITOR.NODE_DOCUMENT = 9;
\r
67 CKEDITOR.NODE_TEXT = 3;
\r
70 * Comment node type.
\r
74 CKEDITOR.NODE_COMMENT = 8;
\r
76 CKEDITOR.NODE_DOCUMENT_FRAGMENT = 11;
\r
78 CKEDITOR.POSITION_IDENTICAL = 0;
\r
79 CKEDITOR.POSITION_DISCONNECTED = 1;
\r
80 CKEDITOR.POSITION_FOLLOWING = 2;
\r
81 CKEDITOR.POSITION_PRECEDING = 4;
\r
82 CKEDITOR.POSITION_IS_CONTAINED = 8;
\r
83 CKEDITOR.POSITION_CONTAINS = 16;
\r
85 CKEDITOR.tools.extend( CKEDITOR.dom.node.prototype,
\r
86 /** @lends CKEDITOR.dom.node.prototype */
\r
89 * Makes this node a child of another element.
\r
90 * @param {CKEDITOR.dom.element} element The target element to which
\r
91 * this node will be appended.
\r
92 * @returns {CKEDITOR.dom.element} The target element.
\r
94 * var p = new CKEDITOR.dom.element( 'p' );
\r
95 * var strong = new CKEDITOR.dom.element( 'strong' );
\r
96 * strong.appendTo( p );
\r
98 * // result: "<p><strong></strong></p>"
\r
100 appendTo : function( element, toStart )
\r
102 element.append( this, toStart );
\r
106 clone : function( includeChildren, cloneId )
\r
108 var $clone = this.$.cloneNode( includeChildren );
\r
110 var removeIds = function( node )
\r
112 if ( node.nodeType != CKEDITOR.NODE_ELEMENT )
\r
116 node.removeAttribute( 'id', false );
\r
117 node.removeAttribute( 'data-cke-expando', false );
\r
119 if ( includeChildren )
\r
121 var childs = node.childNodes;
\r
122 for ( var i=0; i < childs.length; i++ )
\r
123 removeIds( childs[ i ] );
\r
127 // The "id" attribute should never be cloned to avoid duplication.
\r
128 removeIds( $clone );
\r
130 return new CKEDITOR.dom.node( $clone );
\r
133 hasPrevious : function()
\r
135 return !!this.$.previousSibling;
\r
138 hasNext : function()
\r
140 return !!this.$.nextSibling;
\r
144 * Inserts this element after a node.
\r
145 * @param {CKEDITOR.dom.node} node The node that will precede this element.
\r
146 * @returns {CKEDITOR.dom.node} The node preceding this one after
\r
149 * var em = new CKEDITOR.dom.element( 'em' );
\r
150 * var strong = new CKEDITOR.dom.element( 'strong' );
\r
151 * strong.insertAfter( em );
\r
153 * // result: "<em></em><strong></strong>"
\r
155 insertAfter : function( node )
\r
157 node.$.parentNode.insertBefore( this.$, node.$.nextSibling );
\r
162 * Inserts this element before a node.
\r
163 * @param {CKEDITOR.dom.node} node The node that will succeed this element.
\r
164 * @returns {CKEDITOR.dom.node} The node being inserted.
\r
166 * var em = new CKEDITOR.dom.element( 'em' );
\r
167 * var strong = new CKEDITOR.dom.element( 'strong' );
\r
168 * strong.insertBefore( em );
\r
170 * // result: "<strong></strong><em></em>"
\r
172 insertBefore : function( node )
\r
174 node.$.parentNode.insertBefore( this.$, node.$ );
\r
178 insertBeforeMe : function( node )
\r
180 this.$.parentNode.insertBefore( node.$, this.$ );
\r
185 * Retrieves a uniquely identifiable tree address for this node.
\r
186 * The tree address returned is an array of integers, with each integer
\r
187 * indicating a child index of a DOM node, starting from
\r
188 * <code>document.documentElement</code>.
\r
190 * For example, assuming <code><body></code> is the second child
\r
191 * of <code><html></code> (<code><head></code> being the first),
\r
192 * and we would like to address the third child under the
\r
193 * fourth child of <code><body></code>, the tree address returned would be:
\r
196 * The tree address cannot be used for finding back the DOM tree node once
\r
197 * the DOM tree structure has been modified.
\r
199 getAddress : function( normalized )
\r
202 var $documentElement = this.getDocument().$.documentElement;
\r
205 while ( node && node != $documentElement )
\r
207 var parentNode = node.parentNode;
\r
211 // Get the node index. For performance, call getIndex
\r
212 // directly, instead of creating a new node object.
\r
213 address.unshift( this.getIndex.call( { $ : node }, normalized ) );
\r
223 * Gets the document containing this element.
\r
224 * @returns {CKEDITOR.dom.document} The document.
\r
226 * var element = CKEDITOR.document.getById( 'example' );
\r
227 * alert( <strong>element.getDocument().equals( CKEDITOR.document )</strong> ); // "true"
\r
229 getDocument : function()
\r
231 return new CKEDITOR.dom.document( this.$.ownerDocument || this.$.parentNode.ownerDocument );
\r
234 getIndex : function( normalized )
\r
236 // Attention: getAddress depends on this.$
\r
238 var current = this.$,
\r
241 while ( ( current = current.previousSibling ) )
\r
243 // When normalizing, do not count it if this is an
\r
244 // empty text node or if it's a text node following another one.
\r
245 if ( normalized && current.nodeType == 3 &&
\r
246 ( !current.nodeValue.length ||
\r
247 ( current.previousSibling && current.previousSibling.nodeType == 3 ) ) )
\r
258 getNextSourceNode : function( startFromSibling, nodeType, guard )
\r
260 // If "guard" is a node, transform it in a function.
\r
261 if ( guard && !guard.call )
\r
263 var guardNode = guard;
\r
264 guard = function( node )
\r
266 return !node.equals( guardNode );
\r
270 var node = ( !startFromSibling && this.getFirst && this.getFirst() ),
\r
273 // Guarding when we're skipping the current element( no children or 'startFromSibling' ).
\r
274 // send the 'moving out' signal even we don't actually dive into.
\r
277 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )
\r
279 node = this.getNext();
\r
282 while ( !node && ( parent = ( parent || this ).getParent() ) )
\r
284 // The guard check sends the "true" paramenter to indicate that
\r
285 // we are moving "out" of the element.
\r
286 if ( guard && guard( parent, true ) === false )
\r
289 node = parent.getNext();
\r
295 if ( guard && guard( node ) === false )
\r
298 if ( nodeType && nodeType != node.type )
\r
299 return node.getNextSourceNode( false, nodeType, guard );
\r
304 getPreviousSourceNode : function( startFromSibling, nodeType, guard )
\r
306 if ( guard && !guard.call )
\r
308 var guardNode = guard;
\r
309 guard = function( node )
\r
311 return !node.equals( guardNode );
\r
315 var node = ( !startFromSibling && this.getLast && this.getLast() ),
\r
318 // Guarding when we're skipping the current element( no children or 'startFromSibling' ).
\r
319 // send the 'moving out' signal even we don't actually dive into.
\r
322 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )
\r
324 node = this.getPrevious();
\r
327 while ( !node && ( parent = ( parent || this ).getParent() ) )
\r
329 // The guard check sends the "true" paramenter to indicate that
\r
330 // we are moving "out" of the element.
\r
331 if ( guard && guard( parent, true ) === false )
\r
334 node = parent.getPrevious();
\r
340 if ( guard && guard( node ) === false )
\r
343 if ( nodeType && node.type != nodeType )
\r
344 return node.getPreviousSourceNode( false, nodeType, guard );
\r
349 getPrevious : function( evaluator )
\r
351 var previous = this.$, retval;
\r
354 previous = previous.previousSibling;
\r
355 retval = previous && new CKEDITOR.dom.node( previous );
\r
357 while ( retval && evaluator && !evaluator( retval ) )
\r
362 * Gets the node that follows this element in its parent's child list.
\r
363 * @param {Function} evaluator Filtering the result node.
\r
364 * @returns {CKEDITOR.dom.node} The next node or null if not available.
\r
366 * var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b> <i>next</i></div>' );
\r
367 * var first = <strong>element.getFirst().getNext()</strong>;
\r
368 * alert( first.getName() ); // "i"
\r
370 getNext : function( evaluator )
\r
372 var next = this.$, retval;
\r
375 next = next.nextSibling;
\r
376 retval = next && new CKEDITOR.dom.node( next );
\r
378 while ( retval && evaluator && !evaluator( retval ) )
\r
383 * Gets the parent element for this node.
\r
384 * @returns {CKEDITOR.dom.element} The parent element.
\r
386 * var node = editor.document.getBody().getFirst();
\r
387 * var parent = node.<strong>getParent()</strong>;
\r
388 * alert( node.getName() ); // "body"
\r
390 getParent : function()
\r
392 var parent = this.$.parentNode;
\r
393 return ( parent && parent.nodeType == 1 ) ? new CKEDITOR.dom.node( parent ) : null;
\r
396 getParents : function( closerFirst )
\r
403 parents[ closerFirst ? 'push' : 'unshift' ]( node );
\r
405 while ( ( node = node.getParent() ) )
\r
410 getCommonAncestor : function( node )
\r
412 if ( node.equals( this ) )
\r
415 if ( node.contains && node.contains( this ) )
\r
418 var start = this.contains ? this : this.getParent();
\r
422 if ( start.contains( node ) )
\r
425 while ( ( start = start.getParent() ) );
\r
430 getPosition : function( otherNode )
\r
433 var $other = otherNode.$;
\r
435 if ( $.compareDocumentPosition )
\r
436 return $.compareDocumentPosition( $other );
\r
438 // IE and Safari have no support for compareDocumentPosition.
\r
441 return CKEDITOR.POSITION_IDENTICAL;
\r
443 // Only element nodes support contains and sourceIndex.
\r
444 if ( this.type == CKEDITOR.NODE_ELEMENT && otherNode.type == CKEDITOR.NODE_ELEMENT )
\r
448 if ( $.contains( $other ) )
\r
449 return CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING;
\r
451 if ( $other.contains( $ ) )
\r
452 return CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;
\r
455 if ( 'sourceIndex' in $ )
\r
457 return ( $.sourceIndex < 0 || $other.sourceIndex < 0 ) ? CKEDITOR.POSITION_DISCONNECTED :
\r
458 ( $.sourceIndex < $other.sourceIndex ) ? CKEDITOR.POSITION_PRECEDING :
\r
459 CKEDITOR.POSITION_FOLLOWING;
\r
463 // For nodes that don't support compareDocumentPosition, contains
\r
464 // or sourceIndex, their "address" is compared.
\r
466 var addressOfThis = this.getAddress(),
\r
467 addressOfOther = otherNode.getAddress(),
\r
468 minLevel = Math.min( addressOfThis.length, addressOfOther.length );
\r
470 // Determinate preceed/follow relationship.
\r
471 for ( var i = 0 ; i <= minLevel - 1 ; i++ )
\r
473 if ( addressOfThis[ i ] != addressOfOther[ i ] )
\r
475 if ( i < minLevel )
\r
477 return addressOfThis[ i ] < addressOfOther[ i ] ?
\r
478 CKEDITOR.POSITION_PRECEDING : CKEDITOR.POSITION_FOLLOWING;
\r
484 // Determinate contains/contained relationship.
\r
485 return ( addressOfThis.length < addressOfOther.length ) ?
\r
486 CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING :
\r
487 CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;
\r
491 * Gets the closest ancestor node of this node, specified by its name.
\r
492 * @param {String} reference The name of the ancestor node to search or
\r
493 * an object with the node names to search for.
\r
494 * @param {Boolean} [includeSelf] Whether to include the current
\r
495 * node in the search.
\r
496 * @returns {CKEDITOR.dom.node} The located ancestor node or null if not found.
\r
499 * // Suppose we have the following HTML structure:
\r
500 * // <div id="outer"><div id="inner"><p><b>Some text</b></p></div></div>
\r
501 * // If node == <b>
\r
502 * ascendant = node.getAscendant( 'div' ); // ascendant == <div id="inner">
\r
503 * ascendant = node.getAscendant( 'b' ); // ascendant == null
\r
504 * ascendant = node.getAscendant( 'b', true ); // ascendant == <b>
\r
505 * ascendant = node.getAscendant( { div: 1, p: 1} ); // Searches for the first 'div' or 'p': ascendant == <div id="inner">
\r
507 getAscendant : function( reference, includeSelf )
\r
512 if ( !includeSelf )
\r
517 if ( $.nodeName && ( name = $.nodeName.toLowerCase(), ( typeof reference == 'string' ? name == reference : name in reference ) ) )
\r
518 return new CKEDITOR.dom.node( $ );
\r
525 hasAscendant : function( name, includeSelf )
\r
529 if ( !includeSelf )
\r
534 if ( $.nodeName && $.nodeName.toLowerCase() == name )
\r
542 move : function( target, toStart )
\r
544 target.append( this.remove(), toStart );
\r
548 * Removes this node from the document DOM.
\r
549 * @param {Boolean} [preserveChildren] Indicates that the children
\r
550 * elements must remain in the document, removing only the outer
\r
553 * var element = CKEDITOR.dom.element.getById( 'MyElement' );
\r
554 * <strong>element.remove()</strong>;
\r
556 remove : function( preserveChildren )
\r
559 var parent = $.parentNode;
\r
563 if ( preserveChildren )
\r
565 // Move all children before the node.
\r
566 for ( var child ; ( child = $.firstChild ) ; )
\r
568 parent.insertBefore( $.removeChild( child ), $ );
\r
572 parent.removeChild( $ );
\r
578 replace : function( nodeToReplace )
\r
580 this.insertBefore( nodeToReplace );
\r
581 nodeToReplace.remove();
\r
593 while ( this.getFirst && ( child = this.getFirst() ) )
\r
595 if ( child.type == CKEDITOR.NODE_TEXT )
\r
597 var trimmed = CKEDITOR.tools.ltrim( child.getText() ),
\r
598 originalLength = child.getLength();
\r
605 else if ( trimmed.length < originalLength )
\r
607 child.split( originalLength - trimmed.length );
\r
609 // IE BUG: child.remove() may raise JavaScript errors here. (#81)
\r
610 this.$.removeChild( this.$.firstChild );
\r
620 while ( this.getLast && ( child = this.getLast() ) )
\r
622 if ( child.type == CKEDITOR.NODE_TEXT )
\r
624 var trimmed = CKEDITOR.tools.rtrim( child.getText() ),
\r
625 originalLength = child.getLength();
\r
632 else if ( trimmed.length < originalLength )
\r
634 child.split( trimmed.length );
\r
636 // IE BUG: child.getNext().remove() may raise JavaScript errors here.
\r
638 this.$.lastChild.parentNode.removeChild( this.$.lastChild );
\r
644 if ( !CKEDITOR.env.ie && !CKEDITOR.env.opera )
\r
646 child = this.$.lastChild;
\r
648 if ( child && child.type == 1 && child.nodeName.toLowerCase() == 'br' )
\r
650 // Use "eChildNode.parentNode" instead of "node" to avoid IE bug (#324).
\r
651 child.parentNode.removeChild( child ) ;
\r
657 * Checks if this node is read-only (should not be changed). Additionally
\r
658 * it returns the element that defines the read-only state of this node
\r
659 * (if present). It may be the node itself or any of its parent
\r
661 * @returns {CKEDITOR.dom.element|Boolean} An element containing
\r
662 * read-only attributes or "false" if none is found.
\r
665 * // For the following HTML:
\r
666 * // <div contenteditable="false">Some <b>text</b></div>
\r
668 * // If "ele" is the above <div>
\r
669 * ele.isReadOnly(); // the <div> element
\r
671 * // If "ele" is the above <b>
\r
672 * ele.isReadOnly(); // the <div> element
\r
674 isReadOnly : function()
\r
676 var current = this;
\r
679 if ( current.type == CKEDITOR.NODE_ELEMENT )
\r
681 if ( current.is( 'body' ) || !!current.data( 'cke-editable' ) )
\r
684 if ( current.getAttribute( 'contentEditable' ) == 'false' )
\r
686 else if ( current.getAttribute( 'contentEditable' ) == 'true' )
\r
689 current = current.getParent();
\r