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 * 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 // 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 child of another element.
\r
90 * @param {CKEDITOR.dom.element} element The target element to which append
\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 that will preceed this element.
\r
146 * @returns {CKEDITOR.dom.node} The node preceeding 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 that will be after 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 returns is an array of integers, with each integer
\r
187 * indicating a child index of a DOM node, starting from
\r
188 * document.documentElement.
\r
190 * For example, assuming <body> is the second child from <html> (<head>
\r
191 * being the first), and we'd like to address the third child under the
\r
192 * fourth child of body, the tree address returned would be:
\r
195 * The tree address cannot be used for finding back the DOM tree node once
\r
196 * the DOM tree structure has been modified.
\r
198 getAddress : function( normalized )
\r
201 var $documentElement = this.getDocument().$.documentElement;
\r
204 while ( node && node != $documentElement )
\r
206 var parentNode = node.parentNode;
\r
210 // Get the node index. For performance, call getIndex
\r
211 // directly, instead of creating a new node object.
\r
212 address.unshift( this.getIndex.call( { $ : node }, normalized ) );
\r
222 * Gets the document containing this element.
\r
223 * @returns {CKEDITOR.dom.document} The document.
\r
225 * var element = CKEDITOR.document.getById( 'example' );
\r
226 * alert( <b>element.getDocument().equals( CKEDITOR.document )</b> ); // "true"
\r
228 getDocument : function()
\r
230 return new CKEDITOR.dom.document( this.$.ownerDocument || this.$.parentNode.ownerDocument );
\r
233 getIndex : function( normalized )
\r
235 // Attention: getAddress depends on this.$
\r
237 var current = this.$,
\r
240 while ( ( current = current.previousSibling ) )
\r
242 // When normalizing, do not count it if this is an
\r
243 // empty text node or if it's a text node following another one.
\r
244 if ( normalized && current.nodeType == 3 &&
\r
245 ( !current.nodeValue.length ||
\r
246 ( current.previousSibling && current.previousSibling.nodeType == 3 ) ) )
\r
257 getNextSourceNode : function( startFromSibling, nodeType, guard )
\r
259 // If "guard" is a node, transform it in a function.
\r
260 if ( guard && !guard.call )
\r
262 var guardNode = guard;
\r
263 guard = function( node )
\r
265 return !node.equals( guardNode );
\r
269 var node = ( !startFromSibling && this.getFirst && this.getFirst() ),
\r
272 // Guarding when we're skipping the current element( no children or 'startFromSibling' ).
\r
273 // send the 'moving out' signal even we don't actually dive into.
\r
276 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )
\r
278 node = this.getNext();
\r
281 while ( !node && ( parent = ( parent || this ).getParent() ) )
\r
283 // The guard check sends the "true" paramenter to indicate that
\r
284 // we are moving "out" of the element.
\r
285 if ( guard && guard( parent, true ) === false )
\r
288 node = parent.getNext();
\r
294 if ( guard && guard( node ) === false )
\r
297 if ( nodeType && nodeType != node.type )
\r
298 return node.getNextSourceNode( false, nodeType, guard );
\r
303 getPreviousSourceNode : function( startFromSibling, nodeType, guard )
\r
305 if ( guard && !guard.call )
\r
307 var guardNode = guard;
\r
308 guard = function( node )
\r
310 return !node.equals( guardNode );
\r
314 var node = ( !startFromSibling && this.getLast && this.getLast() ),
\r
317 // Guarding when we're skipping the current element( no children or 'startFromSibling' ).
\r
318 // send the 'moving out' signal even we don't actually dive into.
\r
321 if ( this.type == CKEDITOR.NODE_ELEMENT && guard && guard( this, true ) === false )
\r
323 node = this.getPrevious();
\r
326 while ( !node && ( parent = ( parent || this ).getParent() ) )
\r
328 // The guard check sends the "true" paramenter to indicate that
\r
329 // we are moving "out" of the element.
\r
330 if ( guard && guard( parent, true ) === false )
\r
333 node = parent.getPrevious();
\r
339 if ( guard && guard( node ) === false )
\r
342 if ( nodeType && node.type != nodeType )
\r
343 return node.getPreviousSourceNode( false, nodeType, guard );
\r
348 getPrevious : function( evaluator )
\r
350 var previous = this.$, retval;
\r
353 previous = previous.previousSibling;
\r
354 retval = previous && new CKEDITOR.dom.node( previous );
\r
356 while ( retval && evaluator && !evaluator( retval ) )
\r
361 * Gets the node that follows this element in its parent's child list.
\r
362 * @param {Function} evaluator Filtering the result node.
\r
363 * @returns {CKEDITOR.dom.node} The next node or null if not available.
\r
365 * var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b> <i>next</i></div>' );
\r
366 * var first = <b>element.getFirst().getNext()</b>;
\r
367 * alert( first.getName() ); // "i"
\r
369 getNext : function( evaluator )
\r
371 var next = this.$, retval;
\r
374 next = next.nextSibling;
\r
375 retval = next && new CKEDITOR.dom.node( next );
\r
377 while ( retval && evaluator && !evaluator( retval ) )
\r
382 * Gets the parent element for this node.
\r
383 * @returns {CKEDITOR.dom.element} The parent element.
\r
385 * var node = editor.document.getBody().getFirst();
\r
386 * var parent = node.<b>getParent()</b>;
\r
387 * alert( node.getName() ); // "body"
\r
389 getParent : function()
\r
391 var parent = this.$.parentNode;
\r
392 return ( parent && parent.nodeType == 1 ) ? new CKEDITOR.dom.node( parent ) : null;
\r
395 getParents : function( closerFirst )
\r
402 parents[ closerFirst ? 'push' : 'unshift' ]( node );
\r
404 while ( ( node = node.getParent() ) )
\r
409 getCommonAncestor : function( node )
\r
411 if ( node.equals( this ) )
\r
414 if ( node.contains && node.contains( this ) )
\r
417 var start = this.contains ? this : this.getParent();
\r
421 if ( start.contains( node ) )
\r
424 while ( ( start = start.getParent() ) );
\r
429 getPosition : function( otherNode )
\r
432 var $other = otherNode.$;
\r
434 if ( $.compareDocumentPosition )
\r
435 return $.compareDocumentPosition( $other );
\r
437 // IE and Safari have no support for compareDocumentPosition.
\r
440 return CKEDITOR.POSITION_IDENTICAL;
\r
442 // Only element nodes support contains and sourceIndex.
\r
443 if ( this.type == CKEDITOR.NODE_ELEMENT && otherNode.type == CKEDITOR.NODE_ELEMENT )
\r
447 if ( $.contains( $other ) )
\r
448 return CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING;
\r
450 if ( $other.contains( $ ) )
\r
451 return CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;
\r
454 if ( 'sourceIndex' in $ )
\r
456 return ( $.sourceIndex < 0 || $other.sourceIndex < 0 ) ? CKEDITOR.POSITION_DISCONNECTED :
\r
457 ( $.sourceIndex < $other.sourceIndex ) ? CKEDITOR.POSITION_PRECEDING :
\r
458 CKEDITOR.POSITION_FOLLOWING;
\r
462 // For nodes that don't support compareDocumentPosition, contains
\r
463 // or sourceIndex, their "address" is compared.
\r
465 var addressOfThis = this.getAddress(),
\r
466 addressOfOther = otherNode.getAddress(),
\r
467 minLevel = Math.min( addressOfThis.length, addressOfOther.length );
\r
469 // Determinate preceed/follow relationship.
\r
470 for ( var i = 0 ; i <= minLevel - 1 ; i++ )
\r
472 if ( addressOfThis[ i ] != addressOfOther[ i ] )
\r
474 if ( i < minLevel )
\r
476 return addressOfThis[ i ] < addressOfOther[ i ] ?
\r
477 CKEDITOR.POSITION_PRECEDING : CKEDITOR.POSITION_FOLLOWING;
\r
483 // Determinate contains/contained relationship.
\r
484 return ( addressOfThis.length < addressOfOther.length ) ?
\r
485 CKEDITOR.POSITION_CONTAINS + CKEDITOR.POSITION_PRECEDING :
\r
486 CKEDITOR.POSITION_IS_CONTAINED + CKEDITOR.POSITION_FOLLOWING;
\r
490 * Gets the closest ancestor node of this node, specified by its node name.
\r
491 * @param {String} name The node name of the ancestor node to search.
\r
492 * @param {Boolean} [includeSelf] Whether to include the current
\r
493 * node in the search.
\r
494 * @returns {CKEDITOR.dom.node} The located ancestor node or null if not found.
\r
496 * // Suppose we have the following HTML:
\r
497 * // <div id="outer"><div id="inner"><p><b>Some text</b></p></div></div>
\r
498 * // If node == <b>
\r
499 * ascendant = node.getAscendant( 'div' ); // ascendant == <div id="inner">
\r
500 * ascendant = node.getAscendant( 'b' ); // ascendant == null
\r
501 * ascendant = node.getAscendant( 'b', true ); // ascendant == <b>
\r
503 getAscendant : function( name, includeSelf )
\r
507 if ( !includeSelf )
\r
512 if ( $.nodeName && $.nodeName.toLowerCase() == name )
\r
513 return new CKEDITOR.dom.node( $ );
\r
520 hasAscendant : function( name, includeSelf )
\r
524 if ( !includeSelf )
\r
529 if ( $.nodeName && $.nodeName.toLowerCase() == name )
\r
537 move : function( target, toStart )
\r
539 target.append( this.remove(), toStart );
\r
543 * Removes this node from the document DOM.
\r
544 * @param {Boolean} [preserveChildren] Indicates that the children
\r
545 * elements must remain in the document, removing only the outer
\r
548 * var element = CKEDITOR.dom.element.getById( 'MyElement' );
\r
549 * <b>element.remove()</b>;
\r
551 remove : function( preserveChildren )
\r
554 var parent = $.parentNode;
\r
558 if ( preserveChildren )
\r
560 // Move all children before the node.
\r
561 for ( var child ; ( child = $.firstChild ) ; )
\r
563 parent.insertBefore( $.removeChild( child ), $ );
\r
567 parent.removeChild( $ );
\r
573 replace : function( nodeToReplace )
\r
575 this.insertBefore( nodeToReplace );
\r
576 nodeToReplace.remove();
\r
588 while ( this.getFirst && ( child = this.getFirst() ) )
\r
590 if ( child.type == CKEDITOR.NODE_TEXT )
\r
592 var trimmed = CKEDITOR.tools.ltrim( child.getText() ),
\r
593 originalLength = child.getLength();
\r
600 else if ( trimmed.length < originalLength )
\r
602 child.split( originalLength - trimmed.length );
\r
604 // IE BUG: child.remove() may raise JavaScript errors here. (#81)
\r
605 this.$.removeChild( this.$.firstChild );
\r
615 while ( this.getLast && ( child = this.getLast() ) )
\r
617 if ( child.type == CKEDITOR.NODE_TEXT )
\r
619 var trimmed = CKEDITOR.tools.rtrim( child.getText() ),
\r
620 originalLength = child.getLength();
\r
627 else if ( trimmed.length < originalLength )
\r
629 child.split( trimmed.length );
\r
631 // IE BUG: child.getNext().remove() may raise JavaScript errors here.
\r
633 this.$.lastChild.parentNode.removeChild( this.$.lastChild );
\r
639 if ( !CKEDITOR.env.ie && !CKEDITOR.env.opera )
\r
641 child = this.$.lastChild;
\r
643 if ( child && child.type == 1 && child.nodeName.toLowerCase() == 'br' )
\r
645 // Use "eChildNode.parentNode" instead of "node" to avoid IE bug (#324).
\r
646 child.parentNode.removeChild( child ) ;
\r
652 * Checks is this node is read-only (should not be changed). It
\r
653 * additionaly returns the element, if any, which defines the read-only
\r
654 * state of this node. It may be the node itself or any of its parent
\r
656 * @returns {CKEDITOR.dom.element|Boolean} An element containing
\r
657 * read-only attributes or "false" if none is found.
\r
660 * // For the following HTML:
\r
661 * // <div contenteditable="false">Some <b>text</b></div>
\r
663 * // If "ele" is the above <div>
\r
664 * ele.isReadOnly(); // the <div> element
\r
666 * // If "ele" is the above <b>
\r
667 * ele.isReadOnly(); // the <div> element
\r
669 isReadOnly : function()
\r
671 var current = this;
\r
674 if ( current.type == CKEDITOR.NODE_ELEMENT )
\r
676 if ( current.is( 'body' ) || !!current.data( 'cke-editable' ) )
\r
679 if ( current.getAttribute( 'contentEditable' ) == 'false' )
\r
681 else if ( current.getAttribute( 'contentEditable' ) == 'true' )
\r
684 current = current.getParent();
\r