2 Copyright (c) 2003-2010, 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 * and instance of classes that inherits 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 case CKEDITOR.NODE_ELEMENT :
\r
29 return new CKEDITOR.dom.element( domNode );
\r
31 case CKEDITOR.NODE_TEXT :
\r
32 return new CKEDITOR.dom.text( domNode );
\r
35 // Call the base constructor.
\r
36 CKEDITOR.dom.domObject.call( this, domNode );
\r
42 CKEDITOR.dom.node.prototype = new CKEDITOR.dom.domObject();
\r
45 * Element node type.
\r
49 CKEDITOR.NODE_ELEMENT = 1;
\r
56 CKEDITOR.NODE_TEXT = 3;
\r
59 * Comment node type.
\r
63 CKEDITOR.NODE_COMMENT = 8;
\r
65 CKEDITOR.NODE_DOCUMENT_FRAGMENT = 11;
\r
67 CKEDITOR.POSITION_IDENTICAL = 0;
\r
68 CKEDITOR.POSITION_DISCONNECTED = 1;
\r
69 CKEDITOR.POSITION_FOLLOWING = 2;
\r
70 CKEDITOR.POSITION_PRECEDING = 4;
\r
71 CKEDITOR.POSITION_IS_CONTAINED = 8;
\r
72 CKEDITOR.POSITION_CONTAINS = 16;
\r
74 CKEDITOR.tools.extend( CKEDITOR.dom.node.prototype,
\r
75 /** @lends CKEDITOR.dom.node.prototype */
\r
78 * Makes this node child of another element.
\r
79 * @param {CKEDITOR.dom.element} element The target element to which append
\r
81 * @returns {CKEDITOR.dom.element} The target element.
\r
83 * var p = new CKEDITOR.dom.element( 'p' );
\r
84 * var strong = new CKEDITOR.dom.element( 'strong' );
\r
85 * strong.appendTo( p );
\r
87 * // result: "<p><strong></strong></p>"
\r
89 appendTo : function( element, toStart )
\r
91 element.append( this, toStart );
\r
95 clone : function( includeChildren, cloneId )
\r
97 var $clone = this.$.cloneNode( includeChildren );
\r
101 var removeIds = function( node )
\r
103 if ( node.nodeType != CKEDITOR.NODE_ELEMENT )
\r
106 node.removeAttribute( 'id', false ) ;
\r
107 node.removeAttribute( '_cke_expando', false ) ;
\r
109 var childs = node.childNodes;
\r
110 for ( var i=0 ; i < childs.length ; i++ )
\r
111 removeIds( childs[ i ] );
\r
114 // The "id" attribute should never be cloned to avoid duplication.
\r
115 removeIds( $clone );
\r
118 return new CKEDITOR.dom.node( $clone );
\r
121 hasPrevious : function()
\r
123 return !!this.$.previousSibling;
\r
126 hasNext : function()
\r
128 return !!this.$.nextSibling;
\r
132 * Inserts this element after a node.
\r
133 * @param {CKEDITOR.dom.node} node The that will preceed this element.
\r
134 * @returns {CKEDITOR.dom.node} The node preceeding this one after
\r
137 * var em = new CKEDITOR.dom.element( 'em' );
\r
138 * var strong = new CKEDITOR.dom.element( 'strong' );
\r
139 * strong.insertAfter( em );
\r
141 * // result: "<em></em><strong></strong>"
\r
143 insertAfter : function( node )
\r
145 node.$.parentNode.insertBefore( this.$, node.$.nextSibling );
\r
150 * Inserts this element before a node.
\r
151 * @param {CKEDITOR.dom.node} node The that will be after this element.
\r
152 * @returns {CKEDITOR.dom.node} The node being inserted.
\r
154 * var em = new CKEDITOR.dom.element( 'em' );
\r
155 * var strong = new CKEDITOR.dom.element( 'strong' );
\r
156 * strong.insertBefore( em );
\r
158 * // result: "<strong></strong><em></em>"
\r
160 insertBefore : function( node )
\r
162 node.$.parentNode.insertBefore( this.$, node.$ );
\r
166 insertBeforeMe : function( node )
\r
168 this.$.parentNode.insertBefore( node.$, this.$ );
\r
173 * Retrieves a uniquely identifiable tree address for this node.
\r
174 * The tree address returns is an array of integers, with each integer
\r
175 * indicating a child index of a DOM node, starting from
\r
176 * document.documentElement.
\r
178 * For example, assuming <body> is the second child from <html> (<head>
\r
179 * being the first), and we'd like to address the third child under the
\r
180 * fourth child of body, the tree address returned would be:
\r
183 * The tree address cannot be used for finding back the DOM tree node once
\r
184 * the DOM tree structure has been modified.
\r
186 getAddress : function( normalized )
\r
189 var $documentElement = this.getDocument().$.documentElement;
\r
192 while ( node && node != $documentElement )
\r
194 var parentNode = node.parentNode;
\r
195 var currentIndex = -1;
\r
197 for ( var i = 0 ; i < parentNode.childNodes.length ; i++ )
\r
199 var candidate = parentNode.childNodes[i];
\r
202 candidate.nodeType == 3 &&
\r
203 candidate.previousSibling &&
\r
204 candidate.previousSibling.nodeType == 3 )
\r
211 if ( candidate == node )
\r
215 address.unshift( currentIndex );
\r
217 node = node.parentNode;
\r
224 * Gets the document containing this element.
\r
225 * @returns {CKEDITOR.dom.document} The document.
\r
227 * var element = CKEDITOR.document.getById( 'example' );
\r
228 * alert( <b>element.getDocument().equals( CKEDITOR.document )</b> ); // "true"
\r
230 getDocument : function()
\r
232 var document = new CKEDITOR.dom.document( this.$.ownerDocument || this.$.parentNode.ownerDocument );
\r
236 this.getDocument = function()
\r
242 getIndex : function()
\r
246 var currentNode = $.parentNode && $.parentNode.firstChild;
\r
247 var currentIndex = -1;
\r
249 while ( currentNode )
\r
253 if ( currentNode == $ )
\r
254 return currentIndex;
\r
256 currentNode = currentNode.nextSibling;
\r
262 getNextSourceNode : function( startFromSibling, nodeType, guard )
\r
264 // If "guard" is a node, transform it in a function.
\r
265 if ( guard && !guard.call )
\r
267 var guardNode = guard;
\r
268 guard = function( node )
\r
270 return !node.equals( guardNode );
\r
274 var node = ( !startFromSibling && this.getFirst && this.getFirst() ),
\r
277 // Guarding when we're skipping the current element( no children or 'startFromSibling' ).
\r
278 // send the 'moving out' signal even we don't actually dive into.
\r
281 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )
\r
283 node = this.getNext();
\r
286 while ( !node && ( parent = ( parent || this ).getParent() ) )
\r
288 // The guard check sends the "true" paramenter to indicate that
\r
289 // we are moving "out" of the element.
\r
290 if ( guard && guard( parent, true ) === false )
\r
293 node = parent.getNext();
\r
299 if ( guard && guard( node ) === false )
\r
302 if ( nodeType && nodeType != node.type )
\r
303 return node.getNextSourceNode( false, nodeType, guard );
\r
308 getPreviousSourceNode : function( startFromSibling, nodeType, guard )
\r
310 if ( guard && !guard.call )
\r
312 var guardNode = guard;
\r
313 guard = function( node )
\r
315 return !node.equals( guardNode );
\r
319 var node = ( !startFromSibling && this.getLast && this.getLast() ),
\r
322 // Guarding when we're skipping the current element( no children or 'startFromSibling' ).
\r
323 // send the 'moving out' signal even we don't actually dive into.
\r
326 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )
\r
328 node = this.getPrevious();
\r
331 while ( !node && ( parent = ( parent || this ).getParent() ) )
\r
333 // The guard check sends the "true" paramenter to indicate that
\r
334 // we are moving "out" of the element.
\r
335 if ( guard && guard( parent, true ) === false )
\r
338 node = parent.getPrevious();
\r
344 if ( guard && guard( node ) === false )
\r
347 if ( nodeType && node.type != nodeType )
\r
348 return node.getPreviousSourceNode( false, nodeType, guard );
\r
353 getPrevious : function( evaluator )
\r
355 var previous = this.$, retval;
\r
358 previous = previous.previousSibling;
\r
359 retval = previous && new CKEDITOR.dom.node( previous );
\r
361 while ( retval && evaluator && !evaluator( retval ) )
\r
366 * Gets the node that follows this element in its parent's child list.
\r
367 * @param {Function} evaluator Filtering the result node.
\r
368 * @returns {CKEDITOR.dom.node} The next node or null if not available.
\r
370 * var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b> <i>next</i></div>' );
\r
371 * var first = <b>element.getFirst().getNext()</b>;
\r
372 * alert( first.getName() ); // "i"
\r
374 getNext : function( evaluator )
\r
376 var next = this.$, retval;
\r
379 next = next.nextSibling;
\r
380 retval = next && new CKEDITOR.dom.node( next );
\r
382 while ( retval && evaluator && !evaluator( retval ) )
\r
387 * Gets the parent element for this node.
\r
388 * @returns {CKEDITOR.dom.element} The parent element.
\r
390 * var node = editor.document.getBody().getFirst();
\r
391 * var parent = node.<b>getParent()</b>;
\r
392 * alert( node.getName() ); // "body"
\r
394 getParent : function()
\r
396 var parent = this.$.parentNode;
\r
397 return ( parent && parent.nodeType == 1 ) ? new CKEDITOR.dom.node( parent ) : null;
\r
400 getParents : function( closerFirst )
\r
407 parents[ closerFirst ? 'push' : 'unshift' ]( node );
\r
409 while ( ( node = node.getParent() ) )
\r
414 getCommonAncestor : function( node )
\r
416 if ( node.equals( this ) )
\r
419 if ( node.contains && node.contains( this ) )
\r
422 var start = this.contains ? this : this.getParent();
\r
426 if ( start.contains( node ) )
\r
429 while ( ( start = start.getParent() ) );
\r
434 getPosition : function( otherNode )
\r
437 var $other = otherNode.$;
\r
439 if ( $.compareDocumentPosition )
\r
440 return $.compareDocumentPosition( $other );
\r
442 // IE and Safari have no support for compareDocumentPosition.
\r
445 return CKEDITOR.POSITION_IDENTICAL;
\r
447 // Only element nodes support contains and sourceIndex.
\r
448 if ( this.type == CKEDITOR.NODE_ELEMENT && otherNode.type == CKEDITOR.NODE_ELEMENT )
\r
452 if ( $.contains( $other ) )
\r
453 return CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING;
\r
455 if ( $other.contains( $ ) )
\r
456 return CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;
\r
459 if ( 'sourceIndex' in $ )
\r
461 return ( $.sourceIndex < 0 || $other.sourceIndex < 0 ) ? CKEDITOR.POSITION_DISCONNECTED :
\r
462 ( $.sourceIndex < $other.sourceIndex ) ? CKEDITOR.POSITION_PRECEDING :
\r
463 CKEDITOR.POSITION_FOLLOWING;
\r
467 // For nodes that don't support compareDocumentPosition, contains
\r
468 // or sourceIndex, their "address" is compared.
\r
470 var addressOfThis = this.getAddress(),
\r
471 addressOfOther = otherNode.getAddress(),
\r
472 minLevel = Math.min( addressOfThis.length, addressOfOther.length );
\r
474 // Determinate preceed/follow relationship.
\r
475 for ( var i = 0 ; i <= minLevel - 1 ; i++ )
\r
477 if ( addressOfThis[ i ] != addressOfOther[ i ] )
\r
479 if ( i < minLevel )
\r
481 return addressOfThis[ i ] < addressOfOther[ i ] ?
\r
482 CKEDITOR.POSITION_PRECEDING : CKEDITOR.POSITION_FOLLOWING;
\r
488 // Determinate contains/contained relationship.
\r
489 return ( addressOfThis.length < addressOfOther.length ) ?
\r
490 CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING :
\r
491 CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;
\r
495 * Gets the closes ancestor node of a specified node name.
\r
496 * @param {String} name Node name of ancestor node.
\r
497 * @param {Boolean} includeSelf (Optional) Whether to include the current
\r
498 * node in the calculation or not.
\r
499 * @returns {CKEDITOR.dom.node} Ancestor node.
\r
501 getAscendant : function( name, includeSelf )
\r
505 if ( !includeSelf )
\r
510 if ( $.nodeName && $.nodeName.toLowerCase() == name )
\r
511 return new CKEDITOR.dom.node( $ );
\r
518 hasAscendant : function( name, includeSelf )
\r
522 if ( !includeSelf )
\r
527 if ( $.nodeName && $.nodeName.toLowerCase() == name )
\r
535 move : function( target, toStart )
\r
537 target.append( this.remove(), toStart );
\r
541 * Removes this node from the document DOM.
\r
542 * @param {Boolean} [preserveChildren] Indicates that the children
\r
543 * elements must remain in the document, removing only the outer
\r
546 * var element = CKEDITOR.dom.element.getById( 'MyElement' );
\r
547 * <b>element.remove()</b>;
\r
549 remove : function( preserveChildren )
\r
552 var parent = $.parentNode;
\r
556 if ( preserveChildren )
\r
558 // Move all children before the node.
\r
559 for ( var child ; ( child = $.firstChild ) ; )
\r
561 parent.insertBefore( $.removeChild( child ), $ );
\r
565 parent.removeChild( $ );
\r
571 replace : function( nodeToReplace )
\r
573 this.insertBefore( nodeToReplace );
\r
574 nodeToReplace.remove();
\r
586 while ( this.getFirst && ( child = this.getFirst() ) )
\r
588 if ( child.type == CKEDITOR.NODE_TEXT )
\r
590 var trimmed = CKEDITOR.tools.ltrim( child.getText() ),
\r
591 originalLength = child.getLength();
\r
598 else if ( trimmed.length < originalLength )
\r
600 child.split( originalLength - trimmed.length );
\r
602 // IE BUG: child.remove() may raise JavaScript errors here. (#81)
\r
603 this.$.removeChild( this.$.firstChild );
\r
613 while ( this.getLast && ( child = this.getLast() ) )
\r
615 if ( child.type == CKEDITOR.NODE_TEXT )
\r
617 var trimmed = CKEDITOR.tools.rtrim( child.getText() ),
\r
618 originalLength = child.getLength();
\r
625 else if ( trimmed.length < originalLength )
\r
627 child.split( trimmed.length );
\r
629 // IE BUG: child.getNext().remove() may raise JavaScript errors here.
\r
631 this.$.lastChild.parentNode.removeChild( this.$.lastChild );
\r
637 if ( !CKEDITOR.env.ie && !CKEDITOR.env.opera )
\r
639 child = this.$.lastChild;
\r
641 if ( child && child.type == 1 && child.nodeName.toLowerCase() == 'br' )
\r
643 // Use "eChildNode.parentNode" instead of "node" to avoid IE bug (#324).
\r
644 child.parentNode.removeChild( child ) ;
\r