2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
3 For licensing, see LICENSE.html or http://ckeditor.com/license
7 * @fileOverview Defines the {@link CKEDITOR.dom.element} class, which
8 * represents a DOM element.
12 * Represents a DOM element.
14 * @augments CKEDITOR.dom.node
15 * @param {Object|String} element A native DOM element or the element name for
17 * @param {CKEDITOR.dom.document} [ownerDocument] The document that will contain
18 * the element in case of element creation.
20 * // Create a new <span> element.
21 * var element = new CKEDITOR.dom.element( 'span' );
23 * // Create an element based on a native DOM element.
24 * var element = new CKEDITOR.dom.element( document.getElementById( 'myId' ) );
26 CKEDITOR.dom.element = function( element, ownerDocument )
28 if ( typeof element == 'string' )
29 element = ( ownerDocument ? ownerDocument.$ : document ).createElement( element );
31 // Call the base constructor (we must not call CKEDITOR.dom.node).
32 CKEDITOR.dom.domObject.call( this, element );
35 // PACKAGER_RENAME( CKEDITOR.dom.element )
38 * The the {@link CKEDITOR.dom.element} representing and element. If the
39 * element is a native DOM element, it will be transformed into a valid
40 * CKEDITOR.dom.element object.
41 * @returns {CKEDITOR.dom.element} The transformed element.
43 * var element = new CKEDITOR.dom.element( 'span' );
44 * alert( element == <b>CKEDITOR.dom.element.get( element )</b> ); "true"
46 * var element = document.getElementById( 'myElement' );
47 * alert( <b>CKEDITOR.dom.element.get( element )</b>.getName() ); e.g. "p"
49 CKEDITOR.dom.element.get = function( element )
51 return element && ( element.$ ? element : new CKEDITOR.dom.element( element ) );
54 CKEDITOR.dom.element.prototype = new CKEDITOR.dom.node();
57 * Creates an instance of the {@link CKEDITOR.dom.element} class based on the
58 * HTML representation of an element.
59 * @param {String} html The element HTML. It should define only one element in
60 * the "root" level. The "root" element can have child nodes, but not
62 * @returns {CKEDITOR.dom.element} The element instance.
64 * var element = <b>CKEDITOR.dom.element.createFromHtml( '<strong class="anyclass">My element</strong>' )</b>;
65 * alert( element.getName() ); // "strong"
67 CKEDITOR.dom.element.createFromHtml = function( html, ownerDocument )
69 var temp = new CKEDITOR.dom.element( 'div', ownerDocument );
72 // When returning the node, remove it from its parent to detach it.
73 return temp.getFirst().remove();
76 CKEDITOR.dom.element.setMarker = function( database, element, name, value )
78 var id = element.getCustomData( 'list_marker_id' ) ||
79 ( element.setCustomData( 'list_marker_id', CKEDITOR.tools.getNextNumber() ).getCustomData( 'list_marker_id' ) ),
80 markerNames = element.getCustomData( 'list_marker_names' ) ||
81 ( element.setCustomData( 'list_marker_names', {} ).getCustomData( 'list_marker_names' ) );
82 database[id] = element;
83 markerNames[name] = 1;
85 return element.setCustomData( name, value );
88 CKEDITOR.dom.element.clearAllMarkers = function( database )
90 for ( var i in database )
91 CKEDITOR.dom.element.clearMarkers( database, database[i], 1 );
94 CKEDITOR.dom.element.clearMarkers = function( database, element, removeFromDatabase )
96 var names = element.getCustomData( 'list_marker_names' ),
97 id = element.getCustomData( 'list_marker_id' );
98 for ( var i in names )
99 element.removeCustomData( i );
100 element.removeCustomData( 'list_marker_names' );
101 if ( removeFromDatabase )
103 element.removeCustomData( 'list_marker_id' );
108 CKEDITOR.tools.extend( CKEDITOR.dom.element.prototype,
109 /** @lends CKEDITOR.dom.element.prototype */
112 * The node type. This is a constant value set to
113 * {@link CKEDITOR.NODE_ELEMENT}.
117 type : CKEDITOR.NODE_ELEMENT,
120 * Adds a CSS class to the element. It appends the class to the
121 * already existing names.
122 * @param {String} className The name of the class to be added.
124 * var element = new CKEDITOR.dom.element( 'div' );
125 * element.addClass( 'classA' ); // <div class="classA">
126 * element.addClass( 'classB' ); // <div class="classA classB">
127 * element.addClass( 'classA' ); // <div class="classA classB">
129 addClass : function( className )
131 var c = this.$.className;
134 var regex = new RegExp( '(?:^|\\s)' + className + '(?:\\s|$)', '' );
135 if ( !regex.test( c ) )
136 c += ' ' + className;
138 this.$.className = c || className;
142 * Removes a CSS class name from the elements classes. Other classes
144 * @param {String} className The name of the class to remove.
146 * var element = new CKEDITOR.dom.element( 'div' );
147 * element.addClass( 'classA' ); // <div class="classA">
148 * element.addClass( 'classB' ); // <div class="classA classB">
149 * element.removeClass( 'classA' ); // <div class="classB">
150 * element.removeClass( 'classB' ); // <div>
152 removeClass : function( className )
154 var c = this.getAttribute( 'class' );
157 var regex = new RegExp( '(?:^|\\s+)' + className + '(?=\\s|$)', 'i' );
158 if ( regex.test( c ) )
160 c = c.replace( regex, '' ).replace( /^\s+/, '' );
163 this.setAttribute( 'class', c );
165 this.removeAttribute( 'class' );
170 hasClass : function( className )
172 var regex = new RegExp( '(?:^|\\s+)' + className + '(?=\\s|$)', '' );
173 return regex.test( this.getAttribute('class') );
177 * Append a node as a child of this element.
178 * @param {CKEDITOR.dom.node|String} node The node or element name to be
180 * @param {Boolean} [toStart] Indicates that the element is to be
181 * appended at the start.
182 * @returns {CKEDITOR.dom.node} The appended node.
184 * var p = new CKEDITOR.dom.element( 'p' );
186 * var strong = new CKEDITOR.dom.element( 'strong' );
187 * <b>p.append( strong );</b>
189 * var em = <b>p.append( 'em' );</b>
191 * // result: "<p><strong></strong><em></em></p>"
193 append : function( node, toStart )
195 if ( typeof node == 'string' )
196 node = this.getDocument().createElement( node );
199 this.$.insertBefore( node.$, this.$.firstChild );
201 this.$.appendChild( node.$ );
206 appendHtml : function( html )
208 if ( !this.$.childNodes.length )
209 this.setHtml( html );
212 var temp = new CKEDITOR.dom.element( 'div', this.getDocument() );
213 temp.setHtml( html );
214 temp.moveChildren( this );
219 * Append text to this element.
220 * @param {String} text The text to be appended.
221 * @returns {CKEDITOR.dom.node} The appended node.
223 * var p = new CKEDITOR.dom.element( 'p' );
224 * p.appendText( 'This is' );
225 * p.appendText( ' some text' );
227 * // result: "<p>This is some text</p>"
229 appendText : function( text )
231 if ( this.$.text != undefined )
234 this.append( new CKEDITOR.dom.text( text ) );
237 appendBogus : function()
239 var lastChild = this.getLast() ;
241 // Ignore empty/spaces text.
242 while ( lastChild && lastChild.type == CKEDITOR.NODE_TEXT && !CKEDITOR.tools.rtrim( lastChild.getText() ) )
243 lastChild = lastChild.getPrevious();
244 if ( !lastChild || !lastChild.is || !lastChild.is( 'br' ) )
246 var bogus = CKEDITOR.env.opera ?
247 this.getDocument().createText('') :
248 this.getDocument().createElement( 'br' );
250 CKEDITOR.env.gecko && bogus.setAttribute( 'type', '_moz' );
252 this.append( bogus );
257 * Breaks one of the ancestor element in the element position, moving
258 * this element between the broken parts.
259 * @param {CKEDITOR.dom.element} parent The anscestor element to get broken.
261 * // Before breaking:
262 * // <b>This <i>is some<span /> sample</i> test text</b>
263 * // If "element" is <span /> and "parent" is <i>:
264 * // <b>This <i>is some</i><span /><i> sample</i> test text</b>
265 * element.breakParent( parent );
267 * // Before breaking:
268 * // <b>This <i>is some<span /> sample</i> test text</b>
269 * // If "element" is <span /> and "parent" is <b>:
270 * // <b>This <i>is some</i></b><span /><b><i> sample</i> test text</b>
271 * element.breakParent( parent );
273 breakParent : function( parent )
275 var range = new CKEDITOR.dom.range( this.getDocument() );
277 // We'll be extracting part of this element, so let's use our
278 // range to get the correct piece.
279 range.setStartAfter( this );
280 range.setEndAfter( parent );
283 var docFrag = range.extractContents();
285 // Move the element outside the broken element.
286 range.insertNode( this.remove() );
288 // Re-insert the extracted piece after the element.
289 docFrag.insertAfterNode( this );
293 CKEDITOR.env.ie || CKEDITOR.env.webkit ?
298 return node.type != CKEDITOR.NODE_ELEMENT ?
299 $.contains( node.getParent().$ ) :
300 $ != node.$ && $.contains( node.$ );
305 return !!( this.$.compareDocumentPosition( node.$ ) & 16 );
309 * Moves the selection focus to this element.
311 * @param {Boolean} defer Whether to asynchronously defer the
312 * execution by 100 ms.
314 * var element = CKEDITOR.document.getById( 'myTextarea' );
315 * <b>element.focus()</b>;
321 // IE throws error if the element is not visible.
330 return function( defer )
333 CKEDITOR.tools.setTimeout( exec, 100, this );
340 * Gets the inner HTML of this element.
341 * @returns {String} The inner HTML of this element.
343 * var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b></div>' );
344 * alert( <b>p.getHtml()</b> ); // "<b>Example</b>"
348 var retval = this.$.innerHTML;
349 // Strip <?xml:namespace> tags in IE. (#3341).
350 return CKEDITOR.env.ie ? retval.replace( /<\?[^>]*>/g, '' ) : retval;
353 getOuterHtml : function()
355 if ( this.$.outerHTML )
357 // IE includes the <?xml:namespace> tag in the outerHTML of
358 // namespaced element. So, we must strip it here. (#3341)
359 return this.$.outerHTML.replace( /<\?[^>]*>/, '' );
362 var tmpDiv = this.$.ownerDocument.createElement( 'div' );
363 tmpDiv.appendChild( this.$.cloneNode( true ) );
364 return tmpDiv.innerHTML;
368 * Sets the inner HTML of this element.
369 * @param {String} html The HTML to be set for this element.
370 * @returns {String} The inserted HTML.
372 * var p = new CKEDITOR.dom.element( 'p' );
373 * <b>p.setHtml( '<b>Inner</b> HTML' );</b>
375 * // result: "<p><b>Inner</b> HTML</p>"
377 setHtml : function( html )
379 return ( this.$.innerHTML = html );
383 * Sets the element contents as plain text.
384 * @param {String} text The text to be set.
385 * @returns {String} The inserted text.
387 * var element = new CKEDITOR.dom.element( 'div' );
388 * element.setText( 'A > B & C < D' );
389 * alert( element.innerHTML ); // "A &gt; B &amp; C &lt; D"
391 setText : function( text )
393 CKEDITOR.dom.element.prototype.setText = ( this.$.innerText != undefined ) ?
396 return this.$.innerText = text;
400 return this.$.textContent = text;
403 return this.setText( text );
407 * Gets the value of an element attribute.
409 * @param {String} name The attribute name.
410 * @returns {String} The attribute value or null if not defined.
412 * var element = CKEDITOR.dom.element.createFromHtml( '<input type="text" />' );
413 * alert( <b>element.getAttribute( 'type' )</b> ); // "text"
415 getAttribute : (function()
417 var standard = function( name )
419 return this.$.getAttribute( name, 2 );
422 if ( CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.ie6Compat ) )
424 return function( name )
440 var tabIndex = standard.call( this, name );
442 // IE returns tabIndex=0 by default for all
443 // elements. For those elements,
444 // getAtrribute( 'tabindex', 2 ) returns 32768
445 // instead. So, we must make this check to give a
446 // uniform result among all browsers.
447 if ( tabIndex !== 0 && this.$.tabIndex === 0 )
455 var attr = this.$.attributes.getNamedItem( name ),
456 attrValue = attr.specified ? attr.nodeValue // For value given by parser.
457 : this.$.checked; // For value created via DOM interface.
459 return attrValue ? 'checked' : null;
464 return this.$[ name ];
467 // IE does not return inline styles via getAttribute(). See #2947.
468 return this.$.style.cssText;
471 return standard.call( this, name );
478 getChildren : function()
480 return new CKEDITOR.dom.nodeList( this.$.childNodes );
484 * Gets the current computed value of one of the element CSS style
487 * @param {String} propertyName The style property name.
488 * @returns {String} The property value.
490 * var element = new CKEDITOR.dom.element( 'span' );
491 * alert( <b>element.getComputedStyle( 'display' )</b> ); // "inline"
495 function( propertyName )
497 return this.$.currentStyle[ CKEDITOR.tools.cssStyleToDomStyle( propertyName ) ];
500 function( propertyName )
502 return this.getWindow().$.getComputedStyle( this.$, '' ).getPropertyValue( propertyName );
506 * Gets the DTD entries for this element.
507 * @returns {Object} An object containing the list of elements accepted
512 var dtd = CKEDITOR.dtd[ this.getName() ];
514 this.getDtd = function()
522 getElementsByTag : CKEDITOR.dom.document.prototype.getElementsByTag,
525 * Gets the computed tabindex for this element.
527 * @returns {Number} The tabindex value.
529 * var element = CKEDITOR.document.getById( 'myDiv' );
530 * alert( <b>element.getTabIndex()</b> ); // e.g. "-1"
536 var tabIndex = this.$.tabIndex;
538 // IE returns tabIndex=0 by default for all elements. In
539 // those cases we must check that the element really has
540 // the tabindex attribute set to zero, or it is one of
541 // those element that should have zero by default.
542 if ( tabIndex === 0 && !CKEDITOR.dtd.$tabIndex[ this.getName() ] && parseInt( this.getAttribute( 'tabindex' ), 10 ) !== 0 )
547 : CKEDITOR.env.webkit ?
550 var tabIndex = this.$.tabIndex;
552 // Safari returns "undefined" for elements that should not
553 // have tabindex (like a div). So, we must try to get it
554 // from the attribute.
555 // https://bugs.webkit.org/show_bug.cgi?id=20596
556 if ( tabIndex == undefined )
558 tabIndex = parseInt( this.getAttribute( 'tabindex' ), 10 );
560 // If the element don't have the tabindex attribute,
561 // then we should return -1.
562 if ( isNaN( tabIndex ) )
571 return this.$.tabIndex;
575 * Gets the text value of this element.
577 * Only in IE (which uses innerText), <br> will cause linebreaks,
578 * and sucessive whitespaces (including line breaks) will be reduced to
579 * a single space. This behavior is ok for us, for now. It may change
581 * @returns {String} The text value.
583 * var element = CKEDITOR.dom.element.createFromHtml( '<div>Same <i>text</i>.</div>' );
584 * alert( <b>element.getText()</b> ); // "Sample text."
588 return this.$.textContent || this.$.innerText || '';
592 * Gets the window object that contains this element.
593 * @returns {CKEDITOR.dom.window} The window object.
596 getWindow : function()
598 return this.getDocument().getWindow();
602 * Gets the value of the "id" attribute of this element.
603 * @returns {String} The element id, or null if not available.
605 * var element = CKEDITOR.dom.element.createFromHtml( '<p id="myId"></p>' );
606 * alert( <b>element.getId()</b> ); // "myId"
610 return this.$.id || null;
614 * Gets the value of the "name" attribute of this element.
615 * @returns {String} The element name, or null if not available.
617 * var element = CKEDITOR.dom.element.createFromHtml( '<input name="myName"></input>' );
618 * alert( <b>element.getNameAtt()</b> ); // "myName"
620 getNameAtt : function()
622 return this.$.name || null;
626 * Gets the element name (tag name). The returned name is guaranteed to
627 * be always full lowercased.
628 * @returns {String} The element name.
630 * var element = new CKEDITOR.dom.element( 'span' );
631 * alert( <b>element.getName()</b> ); // "span"
635 // Cache the lowercased name inside a closure.
636 var nodeName = this.$.nodeName.toLowerCase();
638 if ( CKEDITOR.env.ie && ! ( document.documentMode > 8 ) )
640 var scopeName = this.$.scopeName;
641 if ( scopeName != 'HTML' )
642 nodeName = scopeName.toLowerCase() + ':' + nodeName;
646 this.getName = function()
653 * Gets the value set to this element. This value is usually available
654 * for form field elements.
655 * @returns {String} The element value.
657 getValue : function()
663 * Gets the first child node of this element.
664 * @param {Function} evaluator Filtering the result node.
665 * @returns {CKEDITOR.dom.node} The first child node or null if not
668 * var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b></div>' );
669 * var first = <b>element.getFirst()</b>;
670 * alert( first.getName() ); // "b"
672 getFirst : function( evaluator )
674 var first = this.$.firstChild,
675 retval = first && new CKEDITOR.dom.node( first );
676 if ( retval && evaluator && !evaluator( retval ) )
677 retval = retval.getNext( evaluator );
683 * @param {Function} evaluator Filtering the result node.
685 getLast : function( evaluator )
687 var last = this.$.lastChild,
688 retval = last && new CKEDITOR.dom.node( last );
689 if ( retval && evaluator && !evaluator( retval ) )
690 retval = retval.getPrevious( evaluator );
695 getStyle : function( name )
697 return this.$.style[ CKEDITOR.tools.cssStyleToDomStyle( name ) ];
701 * Checks if the element name matches one or more names.
702 * @param {String} name[,name[,...]] One or more names to be checked.
703 * @returns {Boolean} true if the element name matches any of the names.
705 * var element = new CKEDITOR.element( 'span' );
706 * alert( <b>element.is( 'span' )</b> ); "true"
707 * alert( <b>element.is( 'p', 'span' )</b> ); "true"
708 * alert( <b>element.is( 'p' )</b> ); "false"
709 * alert( <b>element.is( 'p', 'div' )</b> ); "false"
713 var name = this.getName();
714 for ( var i = 0 ; i < arguments.length ; i++ )
716 if ( arguments[ i ] == name )
723 * Decide whether one element is able to receive cursor.
724 * @param {Boolean} [textCursor=true] Only consider element that could receive text child.
726 isEditable : function( textCursor )
728 var name = this.getName();
730 if ( this.isReadOnly()
731 || this.getComputedStyle( 'display' ) == 'none'
732 || this.getComputedStyle( 'visibility' ) == 'hidden'
733 || CKEDITOR.dtd.$nonEditable[ name ] )
738 if ( textCursor !== false )
740 // Get the element DTD (defaults to span for unknown elements).
741 var dtd = CKEDITOR.dtd[ name ] || CKEDITOR.dtd.span;
742 // In the DTD # == text node.
743 return ( dtd && dtd[ '#'] );
749 isIdentical : function( otherElement )
751 if ( this.getName() != otherElement.getName() )
754 var thisAttribs = this.$.attributes,
755 otherAttribs = otherElement.$.attributes;
757 var thisLength = thisAttribs.length,
758 otherLength = otherAttribs.length;
760 for ( var i = 0 ; i < thisLength ; i++ )
762 var attribute = thisAttribs[ i ];
764 if ( attribute.nodeName == '_moz_dirty' )
767 if ( ( !CKEDITOR.env.ie || ( attribute.specified && attribute.nodeName != 'data-cke-expando' ) ) && attribute.nodeValue != otherElement.getAttribute( attribute.nodeName ) )
771 // For IE, we have to for both elements, because it's difficult to
772 // know how the atttibutes collection is organized in its DOM.
773 if ( CKEDITOR.env.ie )
775 for ( i = 0 ; i < otherLength ; i++ )
777 attribute = otherAttribs[ i ];
778 if ( attribute.specified && attribute.nodeName != 'data-cke-expando'
779 && attribute.nodeValue != this.getAttribute( attribute.nodeName ) )
788 * Checks if this element is visible. May not work if the element is
789 * child of an element with visibility set to "hidden", but works well
790 * on the great majority of cases.
791 * @return {Boolean} True if the element is visible.
793 isVisible : function()
795 var isVisible = ( this.$.offsetHeight || this.$.offsetWidth ) && this.getComputedStyle( 'visibility' ) != 'hidden',
799 // Webkit and Opera report non-zero offsetHeight despite that
800 // element is inside an invisible iframe. (#4542)
801 if ( isVisible && ( CKEDITOR.env.webkit || CKEDITOR.env.opera ) )
803 elementWindow = this.getWindow();
805 if ( !elementWindow.equals( CKEDITOR.document.getWindow() )
806 && ( elementWindowFrame = elementWindow.$.frameElement ) )
808 isVisible = new CKEDITOR.dom.element( elementWindowFrame ).isVisible();
816 * Whether it's an empty inline elements which has no visual impact when removed.
818 isEmptyInlineRemoveable : function()
820 if ( !CKEDITOR.dtd.$removeEmpty[ this.getName() ] )
823 var children = this.getChildren();
824 for ( var i = 0, count = children.count(); i < count; i++ )
826 var child = children.getItem( i );
828 if ( child.type == CKEDITOR.NODE_ELEMENT && child.data( 'cke-bookmark' ) )
831 if ( child.type == CKEDITOR.NODE_ELEMENT && !child.isEmptyInlineRemoveable()
832 || child.type == CKEDITOR.NODE_TEXT && CKEDITOR.tools.trim( child.getText() ) )
841 * Checks if the element has any defined attributes.
843 * @returns {Boolean} True if the element has attributes.
845 * var element = CKEDITOR.dom.element.createFromHtml( '<div title="Test">Example</div>' );
846 * alert( <b>element.hasAttributes()</b> ); // "true"
848 * var element = CKEDITOR.dom.element.createFromHtml( '<div>Example</div>' );
849 * alert( <b>element.hasAttributes()</b> ); // "false"
852 CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.ie6Compat ) ?
855 var attributes = this.$.attributes;
857 for ( var i = 0 ; i < attributes.length ; i++ )
859 var attribute = attributes[i];
861 switch ( attribute.nodeName )
864 // IE has a strange bug. If calling removeAttribute('className'),
865 // the attributes collection will still contain the "class"
866 // attribute, which will be marked as "specified", even if the
867 // outerHTML of the element is not displaying the class attribute.
868 // Note : I was not able to reproduce it outside the editor,
869 // but I've faced it while working on the TC of #1391.
870 if ( this.getAttribute( 'class' ) )
873 // Attributes to be ignored.
874 case 'data-cke-expando' :
880 if ( attribute.specified )
890 var attrs = this.$.attributes,
891 attrsNum = attrs.length;
893 // The _moz_dirty attribute might get into the element after pasting (#5455)
894 var execludeAttrs = { 'data-cke-expando' : 1, _moz_dirty : 1 };
896 return attrsNum > 0 &&
898 !execludeAttrs[ attrs[0].nodeName ] ||
899 ( attrsNum == 2 && !execludeAttrs[ attrs[1].nodeName ] ) );
903 * Checks if the specified attribute is defined for this element.
904 * @returns {Boolean} True if the specified attribute is defined.
905 * @param {String} name The attribute name.
908 hasAttribute : (function()
910 function standard( name )
912 var $attr = this.$.attributes.getNamedItem( name );
913 return !!( $attr && $attr.specified );
916 return ( CKEDITOR.env.ie && CKEDITOR.env.version < 8 ) ?
919 // On IE < 8 the name attribute cannot be retrieved
920 // right after the element creation and setting the
921 // name with setAttribute.
922 if ( name == 'name' )
923 return !!this.$.name;
925 return standard.call( this, name );
932 * Hides this element (display:none).
934 * var element = CKEDITOR.dom.element.getById( 'myElement' );
935 * <b>element.hide()</b>;
939 this.setStyle( 'display', 'none' );
942 moveChildren : function( target, toStart )
954 while ( ( child = $.lastChild ) )
955 target.insertBefore( $.removeChild( child ), target.firstChild );
959 while ( ( child = $.firstChild ) )
960 target.appendChild( $.removeChild( child ) );
965 * Merges sibling elements that are identical to this one.<br>
967 * Identical child elements are also merged. For example:<br>
968 * <b><i></i></b><b><i></i></b> => <b><i></i></b>
970 * @param {Boolean} [inlineOnly] Allow only inline elements to be merged. Defaults to "true".
972 mergeSiblings : ( function()
974 function mergeElements( element, sibling, isNext )
976 if ( sibling && sibling.type == CKEDITOR.NODE_ELEMENT )
978 // Jumping over bookmark nodes and empty inline elements, e.g. <b><i></i></b>,
979 // queuing them to be moved later. (#5567)
980 var pendingNodes = [];
982 while ( sibling.data( 'cke-bookmark' )
983 || sibling.isEmptyInlineRemoveable() )
985 pendingNodes.push( sibling );
986 sibling = isNext ? sibling.getNext() : sibling.getPrevious();
987 if ( !sibling || sibling.type != CKEDITOR.NODE_ELEMENT )
991 if ( element.isIdentical( sibling ) )
993 // Save the last child to be checked too, to merge things like
994 // <b><i></i></b><b><i></i></b> => <b><i></i></b>
995 var innerSibling = isNext ? element.getLast() : element.getFirst();
997 // Move pending nodes first into the target element.
998 while( pendingNodes.length )
999 pendingNodes.shift().move( element, !isNext );
1001 sibling.moveChildren( element, !isNext );
1004 // Now check the last inner child (see two comments above).
1005 if ( innerSibling && innerSibling.type == CKEDITOR.NODE_ELEMENT )
1006 innerSibling.mergeSiblings();
1011 return function( inlineOnly )
1013 if ( ! ( inlineOnly === false
1014 || CKEDITOR.dtd.$removeEmpty[ this.getName() ]
1015 || this.is( 'a' ) ) ) // Merge empty links and anchors also. (#5567)
1020 mergeElements( this, this.getNext(), true );
1021 mergeElements( this, this.getPrevious() );
1026 * Shows this element (display it).
1028 * var element = CKEDITOR.dom.element.getById( 'myElement' );
1029 * <b>element.show()</b>;
1041 * Sets the value of an element attribute.
1042 * @param {String} name The name of the attribute.
1043 * @param {String} value The value to be set to the attribute.
1045 * @returns {CKEDITOR.dom.element} This element instance.
1047 * var element = CKEDITOR.dom.element.getById( 'myElement' );
1048 * <b>element.setAttribute( 'class', 'myClass' )</b>;
1049 * <b>element.setAttribute( 'title', 'This is an example' )</b>;
1051 setAttribute : (function()
1053 var standard = function( name, value )
1055 this.$.setAttribute( name, value );
1059 if ( CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.ie6Compat ) )
1061 return function( name, value )
1063 if ( name == 'class' )
1064 this.$.className = value;
1065 else if ( name == 'style' )
1066 this.$.style.cssText = value;
1067 else if ( name == 'tabindex' ) // Case sensitive.
1068 this.$.tabIndex = value;
1069 else if ( name == 'checked' )
1070 this.$.checked = value;
1072 standard.apply( this, arguments );
1076 else if ( CKEDITOR.env.ie8Compat && CKEDITOR.env.secure )
1078 return function( name, value )
1080 // IE8 throws error when setting src attribute to non-ssl value. (#7847)
1081 if ( name == 'src' && value.match( /^http:\/\// ) )
1082 try { standard.apply( this, arguments ); } catch( e ){}
1084 standard.apply( this, arguments );
1093 * Sets the value of several element attributes.
1094 * @param {Object} attributesPairs An object containing the names and
1095 * values of the attributes.
1096 * @returns {CKEDITOR.dom.element} This element instance.
1098 * var element = CKEDITOR.dom.element.getById( 'myElement' );
1099 * <b>element.setAttributes({
1100 * 'class' : 'myClass',
1101 * 'title' : 'This is an example' })</b>;
1103 setAttributes : function( attributesPairs )
1105 for ( var name in attributesPairs )
1106 this.setAttribute( name, attributesPairs[ name ] );
1111 * Sets the element value. This function is usually used with form
1113 * @param {String} value The element value.
1114 * @returns {CKEDITOR.dom.element} This element instance.
1116 setValue : function( value )
1118 this.$.value = value;
1123 * Removes an attribute from the element.
1124 * @param {String} name The attribute name.
1127 * var element = CKEDITOR.dom.element.createFromHtml( '<div class="classA"></div>' );
1128 * element.removeAttribute( 'class' );
1130 removeAttribute : (function()
1132 var standard = function( name )
1134 this.$.removeAttribute( name );
1137 if ( CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.ie6Compat ) )
1139 return function( name )
1141 if ( name == 'class' )
1143 else if ( name == 'tabindex' )
1145 standard.call( this, name );
1152 removeAttributes : function ( attributes )
1154 if ( CKEDITOR.tools.isArray( attributes ) )
1156 for ( var i = 0 ; i < attributes.length ; i++ )
1157 this.removeAttribute( attributes[ i ] );
1161 for ( var attr in attributes )
1162 attributes.hasOwnProperty( attr ) && this.removeAttribute( attr );
1167 * Removes a style from the element.
1168 * @param {String} name The style name.
1171 * var element = CKEDITOR.dom.element.createFromHtml( '<div style="display:none"></div>' );
1172 * element.removeStyle( 'display' );
1174 removeStyle : function( name )
1176 this.setStyle( name, '' );
1177 if ( this.$.style.removeAttribute )
1178 this.$.style.removeAttribute( CKEDITOR.tools.cssStyleToDomStyle( name ) );
1180 if ( !this.$.style.cssText )
1181 this.removeAttribute( 'style' );
1185 * Sets the value of an element style.
1186 * @param {String} name The name of the style. The CSS naming notation
1187 * must be used (e.g. "background-color").
1188 * @param {String} value The value to be set to the style.
1189 * @returns {CKEDITOR.dom.element} This element instance.
1191 * var element = CKEDITOR.dom.element.getById( 'myElement' );
1192 * <b>element.setStyle( 'background-color', '#ff0000' )</b>;
1193 * <b>element.setStyle( 'margin-top', '10px' )</b>;
1194 * <b>element.setStyle( 'float', 'right' )</b>;
1196 setStyle : function( name, value )
1198 this.$.style[ CKEDITOR.tools.cssStyleToDomStyle( name ) ] = value;
1203 * Sets the value of several element styles.
1204 * @param {Object} stylesPairs An object containing the names and
1205 * values of the styles.
1206 * @returns {CKEDITOR.dom.element} This element instance.
1208 * var element = CKEDITOR.dom.element.getById( 'myElement' );
1209 * <b>element.setStyles({
1210 * 'position' : 'absolute',
1211 * 'float' : 'right' })</b>;
1213 setStyles : function( stylesPairs )
1215 for ( var name in stylesPairs )
1216 this.setStyle( name, stylesPairs[ name ] );
1221 * Sets the opacity of an element.
1222 * @param {Number} opacity A number within the range [0.0, 1.0].
1224 * var element = CKEDITOR.dom.element.getById( 'myElement' );
1225 * <b>element.setOpacity( 0.75 )</b>;
1227 setOpacity : function( opacity )
1229 if ( CKEDITOR.env.ie )
1231 opacity = Math.round( opacity * 100 );
1232 this.setStyle( 'filter', opacity >= 100 ? '' : 'progid:DXImageTransform.Microsoft.Alpha(opacity=' + opacity + ')' );
1235 this.setStyle( 'opacity', opacity );
1239 * Makes the element and its children unselectable.
1242 * var element = CKEDITOR.dom.element.getById( 'myElement' );
1243 * element.unselectable();
1246 CKEDITOR.env.gecko ?
1249 this.$.style.MozUserSelect = 'none';
1250 this.on( 'dragstart', function( evt ) { evt.data.preventDefault(); } );
1252 : CKEDITOR.env.webkit ?
1255 this.$.style.KhtmlUserSelect = 'none';
1256 this.on( 'dragstart', function( evt ) { evt.data.preventDefault(); } );
1261 if ( CKEDITOR.env.ie || CKEDITOR.env.opera )
1263 var element = this.$,
1267 element.unselectable = 'on';
1269 while ( ( e = element.all[ i++ ] ) )
1271 switch ( e.tagName.toLowerCase() )
1277 /* Ignore the above tags */
1280 e.unselectable = 'on';
1286 getPositionedAncestor : function()
1289 while ( current.getName() != 'html' )
1291 if ( current.getComputedStyle( 'position' ) != 'static' )
1294 current = current.getParent();
1299 getDocumentPosition : function( refDocument )
1302 doc = this.getDocument(),
1303 body = doc.getBody(),
1304 quirks = doc.$.compatMode == 'BackCompat';
1306 if ( document.documentElement[ "getBoundingClientRect" ] )
1308 var box = this.$.getBoundingClientRect(),
1310 $docElem = $doc.documentElement;
1312 var clientTop = $docElem.clientTop || body.$.clientTop || 0,
1313 clientLeft = $docElem.clientLeft || body.$.clientLeft || 0,
1314 needAdjustScrollAndBorders = true;
1317 * #3804: getBoundingClientRect() works differently on IE and non-IE
1318 * browsers, regarding scroll positions.
1320 * On IE, the top position of the <html> element is always 0, no matter
1321 * how much you scrolled down.
1323 * On other browsers, the top position of the <html> element is negative
1326 if ( CKEDITOR.env.ie )
1328 var inDocElem = doc.getDocumentElement().contains( this ),
1329 inBody = doc.getBody().contains( this );
1331 needAdjustScrollAndBorders = ( quirks && inBody ) || ( !quirks && inDocElem );
1334 if ( needAdjustScrollAndBorders )
1336 x = box.left + ( !quirks && $docElem.scrollLeft || body.$.scrollLeft );
1338 y = box.top + ( !quirks && $docElem.scrollTop || body.$.scrollTop );
1344 var current = this, previous = null, offsetParent;
1345 while ( current && !( current.getName() == 'body' || current.getName() == 'html' ) )
1347 x += current.$.offsetLeft - current.$.scrollLeft;
1348 y += current.$.offsetTop - current.$.scrollTop;
1350 // Opera includes clientTop|Left into offsetTop|Left.
1351 if ( !current.equals( this ) )
1353 x += ( current.$.clientLeft || 0 );
1354 y += ( current.$.clientTop || 0 );
1357 var scrollElement = previous;
1358 while ( scrollElement && !scrollElement.equals( current ) )
1360 x -= scrollElement.$.scrollLeft;
1361 y -= scrollElement.$.scrollTop;
1362 scrollElement = scrollElement.getParent();
1366 current = ( offsetParent = current.$.offsetParent ) ?
1367 new CKEDITOR.dom.element( offsetParent ) : null;
1373 var currentWindow = this.getWindow(),
1374 refWindow = refDocument.getWindow();
1376 if ( !currentWindow.equals( refWindow ) && currentWindow.$.frameElement )
1378 var iframePosition = ( new CKEDITOR.dom.element( currentWindow.$.frameElement ) ).getDocumentPosition( refDocument );
1380 x += iframePosition.x;
1381 y += iframePosition.y;
1385 if ( !document.documentElement[ "getBoundingClientRect" ] )
1387 // In Firefox, we'll endup one pixel before the element positions,
1388 // so we must add it here.
1389 if ( CKEDITOR.env.gecko && !quirks )
1391 x += this.$.clientLeft ? 1 : 0;
1392 y += this.$.clientTop ? 1 : 0;
1396 return { x : x, y : y };
1399 scrollIntoView : function( alignTop )
1401 // Get the element window.
1402 var win = this.getWindow(),
1403 winHeight = win.getViewPaneSize().height;
1405 // Starts from the offset that will be scrolled with the negative value of
1406 // the visible window height.
1407 var offset = winHeight * -1;
1409 // Append the view pane's height if align to top.
1410 // Append element height if we are aligning to the bottom.
1412 offset += winHeight;
1415 offset += this.$.offsetHeight || 0;
1417 // Consider the margin in the scroll, which is ok for our current needs, but
1418 // needs investigation if we will be using this function in other places.
1419 offset += parseInt( this.getComputedStyle( 'marginBottom' ) || 0, 10 ) || 0;
1422 // Append the offsets for the entire element hierarchy.
1423 var elementPosition = this.getDocumentPosition();
1424 offset += elementPosition.y;
1426 // offset value might be out of range(nagative), fix it(#3692).
1427 offset = offset < 0 ? 0 : offset;
1429 // Scroll the window to the desired position, if not already visible(#3795).
1430 var currentScroll = win.getScrollPosition().y;
1431 if ( offset > currentScroll || offset < currentScroll - winHeight )
1432 win.$.scrollTo( 0, offset );
1435 setState : function( state )
1439 case CKEDITOR.TRISTATE_ON :
1440 this.addClass( 'cke_on' );
1441 this.removeClass( 'cke_off' );
1442 this.removeClass( 'cke_disabled' );
1444 case CKEDITOR.TRISTATE_DISABLED :
1445 this.addClass( 'cke_disabled' );
1446 this.removeClass( 'cke_off' );
1447 this.removeClass( 'cke_on' );
1450 this.addClass( 'cke_off' );
1451 this.removeClass( 'cke_on' );
1452 this.removeClass( 'cke_disabled' );
1458 * Returns the inner document of this IFRAME element.
1459 * @returns {CKEDITOR.dom.document} The inner document.
1461 getFrameDocument : function()
1467 // In IE, with custom document.domain, it may happen that
1468 // the iframe is not yet available, resulting in "Access
1469 // Denied" for the following property access.
1470 $.contentWindow.document;
1474 // Trick to solve this issue, forcing the iframe to get ready
1475 // by simply setting its "src" property.
1478 // In IE6 though, the above is not enough, so we must pause the
1479 // execution for a while, giving it time to think.
1480 if ( CKEDITOR.env.ie && CKEDITOR.env.version < 7 )
1482 window.showModalDialog(
1483 'javascript:document.write("' +
1485 'window.setTimeout(' +
1486 'function(){window.close();}' +
1492 return $ && new CKEDITOR.dom.document( $.contentWindow.document );
1496 * Copy all the attributes from one node to the other, kinda like a clone
1497 * skipAttributes is an object with the attributes that must NOT be copied.
1498 * @param {CKEDITOR.dom.element} dest The destination element.
1499 * @param {Object} skipAttributes A dictionary of attributes to skip.
1502 copyAttributes : function( dest, skipAttributes )
1504 var attributes = this.$.attributes;
1505 skipAttributes = skipAttributes || {};
1507 for ( var n = 0 ; n < attributes.length ; n++ )
1509 var attribute = attributes[n];
1511 // Lowercase attribute name hard rule is broken for
1512 // some attribute on IE, e.g. CHECKED.
1513 var attrName = attribute.nodeName.toLowerCase(),
1516 // We can set the type only once, so do it with the proper value, not copying it.
1517 if ( attrName in skipAttributes )
1520 if ( attrName == 'checked' && ( attrValue = this.getAttribute( attrName ) ) )
1521 dest.setAttribute( attrName, attrValue );
1522 // IE BUG: value attribute is never specified even if it exists.
1523 else if ( attribute.specified ||
1524 ( CKEDITOR.env.ie && attribute.nodeValue && attrName == 'value' ) )
1526 attrValue = this.getAttribute( attrName );
1527 if ( attrValue === null )
1528 attrValue = attribute.nodeValue;
1530 dest.setAttribute( attrName, attrValue );
1535 if ( this.$.style.cssText !== '' )
1536 dest.$.style.cssText = this.$.style.cssText;
1540 * Changes the tag name of the current element.
1541 * @param {String} newTag The new tag for the element.
1543 renameNode : function( newTag )
1545 // If it's already correct exit here.
1546 if ( this.getName() == newTag )
1549 var doc = this.getDocument();
1551 // Create the new node.
1552 var newNode = new CKEDITOR.dom.element( newTag, doc );
1554 // Copy all attributes.
1555 this.copyAttributes( newNode );
1557 // Move children to the new node.
1558 this.moveChildren( newNode );
1560 // Replace the node.
1561 this.getParent() && this.$.parentNode.replaceChild( newNode.$, this.$ );
1562 newNode.$[ 'data-cke-expando' ] = this.$[ 'data-cke-expando' ];
1567 * Gets a DOM tree descendant under the current node.
1568 * @param {Array|Number} indices The child index or array of child indices under the node.
1569 * @returns {CKEDITOR.dom.node} The specified DOM child under the current node. Null if child does not exist.
1571 * var strong = p.getChild(0);
1573 getChild : function( indices )
1575 var rawNode = this.$;
1577 if ( !indices.slice )
1578 rawNode = rawNode.childNodes[ indices ];
1581 while ( indices.length > 0 && rawNode )
1582 rawNode = rawNode.childNodes[ indices.shift() ];
1585 return rawNode ? new CKEDITOR.dom.node( rawNode ) : null;
1588 getChildCount : function()
1590 return this.$.childNodes.length;
1593 disableContextMenu : function()
1595 this.on( 'contextmenu', function( event )
1597 // Cancel the browser context menu.
1598 if ( !event.data.getTarget().hasClass( 'cke_enable_context_menu' ) )
1599 event.data.preventDefault();
1604 * Gets element's direction. Supports both CSS 'direction' prop and 'dir' attr.
1606 getDirection : function( useComputed )
1608 return useComputed ?
1609 this.getComputedStyle( 'direction' )
1610 // Webkit: offline element returns empty direction (#8053).
1611 || this.getDirection()
1612 || this.getDocument().$.dir
1613 || this.getDocument().getBody().getDirection( 1 )
1614 : this.getStyle( 'direction' ) || this.getAttribute( 'dir' );
1618 * Gets, sets and removes custom data to be stored as HTML5 data-* attributes.
1619 * @param {String} name The name of the attribute, excluding the 'data-' part.
1620 * @param {String} [value] The value to set. If set to false, the attribute will be removed.
1622 * element.data( 'extra-info', 'test' ); // appended the attribute data-extra-info="test" to the element
1623 * alert( element.data( 'extra-info' ) ); // "test"
1624 * element.data( 'extra-info', false ); // remove the data-extra-info attribute from the element
1626 data : function ( name, value )
1628 name = 'data-' + name;
1629 if ( value === undefined )
1630 return this.getAttribute( name );
1631 else if ( value === false )
1632 this.removeAttribute( name );
1634 this.setAttribute( name, value );
1643 width : [ "border-left-width", "border-right-width","padding-left", "padding-right" ],
1644 height : [ "border-top-width", "border-bottom-width", "padding-top", "padding-bottom" ]
1647 function marginAndPaddingSize( type )
1650 for ( var i = 0, len = sides[ type ].length; i < len; i++ )
1651 adjustment += parseInt( this.getComputedStyle( sides [ type ][ i ] ) || 0, 10 ) || 0;
1656 * Sets the element size considering the box model.
1657 * @name CKEDITOR.dom.element.prototype.setSize
1659 * @param {String} type The dimension to set. It accepts "width" and "height".
1660 * @param {Number} size The length unit in px.
1661 * @param {Boolean} isBorderBox Apply the size based on the border box model.
1663 CKEDITOR.dom.element.prototype.setSize = function( type, size, isBorderBox )
1665 if ( typeof size == 'number' )
1667 if ( isBorderBox && !( CKEDITOR.env.ie && CKEDITOR.env.quirks ) )
1668 size -= marginAndPaddingSize.call( this, type );
1670 this.setStyle( type, size + 'px' );
1675 * Gets the element size, possibly considering the box model.
1676 * @name CKEDITOR.dom.element.prototype.getSize
1678 * @param {String} type The dimension to get. It accepts "width" and "height".
1679 * @param {Boolean} isBorderBox Get the size based on the border box model.
1681 CKEDITOR.dom.element.prototype.getSize = function( type, isBorderBox )
1683 var size = Math.max( this.$[ 'offset' + CKEDITOR.tools.capitalize( type ) ],
1684 this.$[ 'client' + CKEDITOR.tools.capitalize( type ) ] ) || 0;
1687 size -= marginAndPaddingSize.call( this, type );