2 Copyright (c) 2003-2013, 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 var type = domNode.nodeType == CKEDITOR.NODE_DOCUMENT ? 'document'
\r
27 : domNode.nodeType == CKEDITOR.NODE_ELEMENT ? 'element'
\r
28 : domNode.nodeType == CKEDITOR.NODE_TEXT ? 'text'
\r
29 : domNode.nodeType == CKEDITOR.NODE_COMMENT ? 'comment'
\r
30 : 'domObject'; // Call the base constructor otherwise.
\r
32 return new CKEDITOR.dom[ type ]( domNode );
\r
38 CKEDITOR.dom.node.prototype = new CKEDITOR.dom.domObject();
\r
41 * Element node type.
\r
45 CKEDITOR.NODE_ELEMENT = 1;
\r
48 * Document node type.
\r
52 CKEDITOR.NODE_DOCUMENT = 9;
\r
59 CKEDITOR.NODE_TEXT = 3;
\r
62 * Comment node type.
\r
66 CKEDITOR.NODE_COMMENT = 8;
\r
68 CKEDITOR.NODE_DOCUMENT_FRAGMENT = 11;
\r
70 CKEDITOR.POSITION_IDENTICAL = 0;
\r
71 CKEDITOR.POSITION_DISCONNECTED = 1;
\r
72 CKEDITOR.POSITION_FOLLOWING = 2;
\r
73 CKEDITOR.POSITION_PRECEDING = 4;
\r
74 CKEDITOR.POSITION_IS_CONTAINED = 8;
\r
75 CKEDITOR.POSITION_CONTAINS = 16;
\r
77 CKEDITOR.tools.extend( CKEDITOR.dom.node.prototype,
\r
78 /** @lends CKEDITOR.dom.node.prototype */
\r
81 * Makes this node a child of another element.
\r
82 * @param {CKEDITOR.dom.element} element The target element to which
\r
83 * this node will be appended.
\r
84 * @returns {CKEDITOR.dom.element} The target element.
\r
86 * var p = new CKEDITOR.dom.element( 'p' );
\r
87 * var strong = new CKEDITOR.dom.element( 'strong' );
\r
88 * strong.appendTo( p );
\r
90 * // result: "<p><strong></strong></p>"
\r
92 appendTo : function( element, toStart )
\r
94 element.append( this, toStart );
\r
98 clone : function( includeChildren, cloneId )
\r
100 var $clone = this.$.cloneNode( includeChildren );
\r
102 var removeIds = function( node )
\r
104 if ( node.nodeType != CKEDITOR.NODE_ELEMENT )
\r
108 node.removeAttribute( 'id', false );
\r
110 node[ 'data-cke-expando' ] = undefined;
\r
112 if ( includeChildren )
\r
114 var childs = node.childNodes;
\r
115 for ( var i=0; i < childs.length; i++ )
\r
116 removeIds( childs[ i ] );
\r
120 // The "id" attribute should never be cloned to avoid duplication.
\r
121 removeIds( $clone );
\r
123 return new CKEDITOR.dom.node( $clone );
\r
126 hasPrevious : function()
\r
128 return !!this.$.previousSibling;
\r
131 hasNext : function()
\r
133 return !!this.$.nextSibling;
\r
137 * Inserts this element after a node.
\r
138 * @param {CKEDITOR.dom.node} node The node that will precede this element.
\r
139 * @returns {CKEDITOR.dom.node} The node preceding this one after
\r
142 * var em = new CKEDITOR.dom.element( 'em' );
\r
143 * var strong = new CKEDITOR.dom.element( 'strong' );
\r
144 * strong.insertAfter( em );
\r
146 * // result: "<em></em><strong></strong>"
\r
148 insertAfter : function( node )
\r
150 node.$.parentNode.insertBefore( this.$, node.$.nextSibling );
\r
155 * Inserts this element before a node.
\r
156 * @param {CKEDITOR.dom.node} node The node that will succeed this element.
\r
157 * @returns {CKEDITOR.dom.node} The node being inserted.
\r
159 * var em = new CKEDITOR.dom.element( 'em' );
\r
160 * var strong = new CKEDITOR.dom.element( 'strong' );
\r
161 * strong.insertBefore( em );
\r
163 * // result: "<strong></strong><em></em>"
\r
165 insertBefore : function( node )
\r
167 node.$.parentNode.insertBefore( this.$, node.$ );
\r
171 insertBeforeMe : function( node )
\r
173 this.$.parentNode.insertBefore( node.$, this.$ );
\r
178 * Retrieves a uniquely identifiable tree address for this node.
\r
179 * The tree address returned is an array of integers, with each integer
\r
180 * indicating a child index of a DOM node, starting from
\r
181 * <code>document.documentElement</code>.
\r
183 * For example, assuming <code><body></code> is the second child
\r
184 * of <code><html></code> (<code><head></code> being the first),
\r
185 * and we would like to address the third child under the
\r
186 * fourth child of <code><body></code>, the tree address returned would be:
\r
189 * The tree address cannot be used for finding back the DOM tree node once
\r
190 * the DOM tree structure has been modified.
\r
192 getAddress : function( normalized )
\r
195 var $documentElement = this.getDocument().$.documentElement;
\r
198 while ( node && node != $documentElement )
\r
200 var parentNode = node.parentNode;
\r
204 // Get the node index. For performance, call getIndex
\r
205 // directly, instead of creating a new node object.
\r
206 address.unshift( this.getIndex.call( { $ : node }, normalized ) );
\r
216 * Gets the document containing this element.
\r
217 * @returns {CKEDITOR.dom.document} The document.
\r
219 * var element = CKEDITOR.document.getById( 'example' );
\r
220 * alert( <strong>element.getDocument().equals( CKEDITOR.document )</strong> ); // "true"
\r
222 getDocument : function()
\r
224 return new CKEDITOR.dom.document( this.$.ownerDocument || this.$.parentNode.ownerDocument );
\r
227 getIndex : function( normalized )
\r
229 // Attention: getAddress depends on this.$
\r
231 var current = this.$,
\r
234 while ( ( current = current.previousSibling ) )
\r
236 // When normalizing, do not count it if this is an
\r
237 // empty text node or if it's a text node following another one.
\r
238 if ( normalized && current.nodeType == 3 &&
\r
239 ( !current.nodeValue.length ||
\r
240 ( current.previousSibling && current.previousSibling.nodeType == 3 ) ) )
\r
251 getNextSourceNode : function( startFromSibling, nodeType, guard )
\r
253 // If "guard" is a node, transform it in a function.
\r
254 if ( guard && !guard.call )
\r
256 var guardNode = guard;
\r
257 guard = function( node )
\r
259 return !node.equals( guardNode );
\r
263 var node = ( !startFromSibling && this.getFirst && this.getFirst() ),
\r
266 // Guarding when we're skipping the current element( no children or 'startFromSibling' ).
\r
267 // send the 'moving out' signal even we don't actually dive into.
\r
270 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )
\r
272 node = this.getNext();
\r
275 while ( !node && ( parent = ( parent || this ).getParent() ) )
\r
277 // The guard check sends the "true" paramenter to indicate that
\r
278 // we are moving "out" of the element.
\r
279 if ( guard && guard( parent, true ) === false )
\r
282 node = parent.getNext();
\r
288 if ( guard && guard( node ) === false )
\r
291 if ( nodeType && nodeType != node.type )
\r
292 return node.getNextSourceNode( false, nodeType, guard );
\r
297 getPreviousSourceNode : function( startFromSibling, nodeType, guard )
\r
299 if ( guard && !guard.call )
\r
301 var guardNode = guard;
\r
302 guard = function( node )
\r
304 return !node.equals( guardNode );
\r
308 var node = ( !startFromSibling && this.getLast && this.getLast() ),
\r
311 // Guarding when we're skipping the current element( no children or 'startFromSibling' ).
\r
312 // send the 'moving out' signal even we don't actually dive into.
\r
315 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )
\r
317 node = this.getPrevious();
\r
320 while ( !node && ( parent = ( parent || this ).getParent() ) )
\r
322 // The guard check sends the "true" paramenter to indicate that
\r
323 // we are moving "out" of the element.
\r
324 if ( guard && guard( parent, true ) === false )
\r
327 node = parent.getPrevious();
\r
333 if ( guard && guard( node ) === false )
\r
336 if ( nodeType && node.type != nodeType )
\r
337 return node.getPreviousSourceNode( false, nodeType, guard );
\r
342 getPrevious : function( evaluator )
\r
344 var previous = this.$, retval;
\r
347 previous = previous.previousSibling;
\r
349 // Avoid returning the doc type node.
\r
350 // http://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#ID-412266927
\r
351 retval = previous && previous.nodeType != 10 && new CKEDITOR.dom.node( previous );
\r
353 while ( retval && evaluator && !evaluator( retval ) )
\r
358 * Gets the node that follows this element in its parent's child list.
\r
359 * @param {Function} evaluator Filtering the result node.
\r
360 * @returns {CKEDITOR.dom.node} The next node or null if not available.
\r
362 * var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b> <i>next</i></div>' );
\r
363 * var first = <strong>element.getFirst().getNext()</strong>;
\r
364 * alert( first.getName() ); // "i"
\r
366 getNext : function( evaluator )
\r
368 var next = this.$, retval;
\r
371 next = next.nextSibling;
\r
372 retval = next && new CKEDITOR.dom.node( next );
\r
374 while ( retval && evaluator && !evaluator( retval ) )
\r
379 * Gets the parent element for this node.
\r
380 * @returns {CKEDITOR.dom.element} The parent element.
\r
382 * var node = editor.document.getBody().getFirst();
\r
383 * var parent = node.<strong>getParent()</strong>;
\r
384 * alert( node.getName() ); // "body"
\r
386 getParent : function()
\r
388 var parent = this.$.parentNode;
\r
389 return ( parent && parent.nodeType == 1 ) ? new CKEDITOR.dom.node( parent ) : null;
\r
392 getParents : function( closerFirst )
\r
399 parents[ closerFirst ? 'push' : 'unshift' ]( node );
\r
401 while ( ( node = node.getParent() ) )
\r
406 getCommonAncestor : function( node )
\r
408 if ( node.equals( this ) )
\r
411 if ( node.contains && node.contains( this ) )
\r
414 var start = this.contains ? this : this.getParent();
\r
418 if ( start.contains( node ) )
\r
421 while ( ( start = start.getParent() ) );
\r
426 getPosition : function( otherNode )
\r
429 var $other = otherNode.$;
\r
431 if ( $.compareDocumentPosition )
\r
432 return $.compareDocumentPosition( $other );
\r
434 // IE and Safari have no support for compareDocumentPosition.
\r
437 return CKEDITOR.POSITION_IDENTICAL;
\r
439 // Only element nodes support contains and sourceIndex.
\r
440 if ( this.type == CKEDITOR.NODE_ELEMENT && otherNode.type == CKEDITOR.NODE_ELEMENT )
\r
444 if ( $.contains( $other ) )
\r
445 return CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING;
\r
447 if ( $other.contains( $ ) )
\r
448 return CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;
\r
451 if ( 'sourceIndex' in $ )
\r
453 return ( $.sourceIndex < 0 || $other.sourceIndex < 0 ) ? CKEDITOR.POSITION_DISCONNECTED :
\r
454 ( $.sourceIndex < $other.sourceIndex ) ? CKEDITOR.POSITION_PRECEDING :
\r
455 CKEDITOR.POSITION_FOLLOWING;
\r
459 // For nodes that don't support compareDocumentPosition, contains
\r
460 // or sourceIndex, their "address" is compared.
\r
462 var addressOfThis = this.getAddress(),
\r
463 addressOfOther = otherNode.getAddress(),
\r
464 minLevel = Math.min( addressOfThis.length, addressOfOther.length );
\r
466 // Determinate preceed/follow relationship.
\r
467 for ( var i = 0 ; i <= minLevel - 1 ; i++ )
\r
469 if ( addressOfThis[ i ] != addressOfOther[ i ] )
\r
471 if ( i < minLevel )
\r
473 return addressOfThis[ i ] < addressOfOther[ i ] ?
\r
474 CKEDITOR.POSITION_PRECEDING : CKEDITOR.POSITION_FOLLOWING;
\r
480 // Determinate contains/contained relationship.
\r
481 return ( addressOfThis.length < addressOfOther.length ) ?
\r
482 CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING :
\r
483 CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;
\r
487 * Gets the closest ancestor node of this node, specified by its name.
\r
488 * @param {String} reference The name of the ancestor node to search or
\r
489 * an object with the node names to search for.
\r
490 * @param {Boolean} [includeSelf] Whether to include the current
\r
491 * node in the search.
\r
492 * @returns {CKEDITOR.dom.node} The located ancestor node or null if not found.
\r
495 * // Suppose we have the following HTML structure:
\r
496 * // <div id="outer"><div id="inner"><p><b>Some text</b></p></div></div>
\r
497 * // If node == <b>
\r
498 * ascendant = node.getAscendant( 'div' ); // ascendant == <div id="inner">
\r
499 * ascendant = node.getAscendant( 'b' ); // ascendant == null
\r
500 * ascendant = node.getAscendant( 'b', true ); // ascendant == <b>
\r
501 * ascendant = node.getAscendant( { div: 1, p: 1} ); // Searches for the first 'div' or 'p': ascendant == <div id="inner">
\r
503 getAscendant : function( reference, includeSelf )
\r
508 if ( !includeSelf )
\r
513 if ( $.nodeName && ( name = $.nodeName.toLowerCase(), ( typeof reference == 'string' ? name == reference : name in reference ) ) )
\r
514 return new CKEDITOR.dom.node( $ );
\r
521 hasAscendant : function( name, includeSelf )
\r
525 if ( !includeSelf )
\r
530 if ( $.nodeName && $.nodeName.toLowerCase() == name )
\r
538 move : function( target, toStart )
\r
540 target.append( this.remove(), toStart );
\r
544 * Removes this node from the document DOM.
\r
545 * @param {Boolean} [preserveChildren] Indicates that the children
\r
546 * elements must remain in the document, removing only the outer
\r
549 * var element = CKEDITOR.dom.element.getById( 'MyElement' );
\r
550 * <strong>element.remove()</strong>;
\r
552 remove : function( preserveChildren )
\r
555 var parent = $.parentNode;
\r
559 if ( preserveChildren )
\r
561 // Move all children before the node.
\r
562 for ( var child ; ( child = $.firstChild ) ; )
\r
564 parent.insertBefore( $.removeChild( child ), $ );
\r
568 parent.removeChild( $ );
\r
574 replace : function( nodeToReplace )
\r
576 this.insertBefore( nodeToReplace );
\r
577 nodeToReplace.remove();
\r
589 while ( this.getFirst && ( child = this.getFirst() ) )
\r
591 if ( child.type == CKEDITOR.NODE_TEXT )
\r
593 var trimmed = CKEDITOR.tools.ltrim( child.getText() ),
\r
594 originalLength = child.getLength();
\r
601 else if ( trimmed.length < originalLength )
\r
603 child.split( originalLength - trimmed.length );
\r
605 // IE BUG: child.remove() may raise JavaScript errors here. (#81)
\r
606 this.$.removeChild( this.$.firstChild );
\r
616 while ( this.getLast && ( child = this.getLast() ) )
\r
618 if ( child.type == CKEDITOR.NODE_TEXT )
\r
620 var trimmed = CKEDITOR.tools.rtrim( child.getText() ),
\r
621 originalLength = child.getLength();
\r
628 else if ( trimmed.length < originalLength )
\r
630 child.split( trimmed.length );
\r
632 // IE BUG: child.getNext().remove() may raise JavaScript errors here.
\r
634 this.$.lastChild.parentNode.removeChild( this.$.lastChild );
\r
640 if ( !CKEDITOR.env.ie && !CKEDITOR.env.opera )
\r
642 child = this.$.lastChild;
\r
644 if ( child && child.type == 1 && child.nodeName.toLowerCase() == 'br' )
\r
646 // Use "eChildNode.parentNode" instead of "node" to avoid IE bug (#324).
\r
647 child.parentNode.removeChild( child ) ;
\r
653 * Checks if this node is read-only (should not be changed).
\r
654 * @returns {Boolean}
\r
657 * // For the following HTML:
\r
658 * // <div contenteditable="false">Some <b>text</b></div>
\r
660 * // If "ele" is the above <div>
\r
661 * ele.isReadOnly(); // true
\r
663 isReadOnly : function()
\r
665 var element = this;
\r
666 if ( this.type != CKEDITOR.NODE_ELEMENT )
\r
667 element = this.getParent();
\r
669 if ( element && typeof element.$.isContentEditable != 'undefined' )
\r
670 return ! ( element.$.isContentEditable || element.data( 'cke-editable' ) );
\r
673 // Degrade for old browsers which don't support "isContentEditable", e.g. FF3
\r
674 var current = element;
\r
677 if ( current.is( 'body' ) || !!current.data( 'cke-editable' ) )
\r
680 if ( current.getAttribute( 'contentEditable' ) == 'false' )
\r
682 else if ( current.getAttribute( 'contentEditable' ) == 'true' )
\r
685 current = current.getParent();
\r