GOOGLE
/*
Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.
For licensing, see LICENSE.html or http://ckeditor.com/license
*/
/**
* @fileOverview Defines the {@link CKEDITOR.dom.element} class, which
* represents a DOM element.
*/
/**
* Represents a DOM element.
* @constructor
* @augments CKEDITOR.dom.node
* @param {Object|String} element A native DOM element or the element name for
* new elements.
* @param {CKEDITOR.dom.document} [ownerDocument] The document that will contain
* the element in case of element creation.
* @example
* // Create a new <span> element.
* var element = new CKEDITOR.dom.element( 'span' );
* @example
* // Create an element based on a native DOM element.
* var element = new CKEDITOR.dom.element( document.getElementById( 'myId' ) );
*/
CKEDITOR.dom.element = function( element, ownerDocument )
{
if ( typeof element == 'string' )
element = ( ownerDocument ? ownerDocument.$ : document ).createElement( element );
// Call the base constructor (we must not call CKEDITOR.dom.node).
CKEDITOR.dom.domObject.call( this, element );
};
// PACKAGER_RENAME( CKEDITOR.dom.element )
/**
* The the {@link CKEDITOR.dom.element} representing and element. If the
* element is a native DOM element, it will be transformed into a valid
* CKEDITOR.dom.element object.
* @returns {CKEDITOR.dom.element} The transformed element.
* @example
* var element = new CKEDITOR.dom.element( 'span' );
* alert( element == <b>CKEDITOR.dom.element.get( element )</b> ); "true"
* @example
* var element = document.getElementById( 'myElement' );
* alert( <b>CKEDITOR.dom.element.get( element )</b>.getName() ); e.g. "p"
*/
CKEDITOR.dom.element.get = function( element )
{
return element && ( element.$ ? element : new CKEDITOR.dom.element( element ) );
};
CKEDITOR.dom.element.prototype = new CKEDITOR.dom.node();
/**
* Creates an instance of the {@link CKEDITOR.dom.element} class based on the
* HTML representation of an element.
* @param {String} html The element HTML. It should define only one element in
* the "root" level. The "root" element can have child nodes, but not
* siblings.
* @returns {CKEDITOR.dom.element} The element instance.
* @example
* var element = <b>CKEDITOR.dom.element.createFromHtml( '<strong class="anyclass">My element</strong>' )</b>;
* alert( element.getName() ); // "strong"
*/
CKEDITOR.dom.element.createFromHtml = function( html, ownerDocument )
{
var temp = new CKEDITOR.dom.element( 'div', ownerDocument );
temp.setHtml( html );
// When returning the node, remove it from its parent to detach it.
return temp.getFirst().remove();
};
CKEDITOR.dom.element.setMarker = function( database, element, name, value )
{
var id = element.getCustomData( 'list_marker_id' ) ||
( element.setCustomData( 'list_marker_id', CKEDITOR.tools.getNextNumber() ).getCustomData( 'list_marker_id' ) ),
markerNames = element.getCustomData( 'list_marker_names' ) ||
( element.setCustomData( 'list_marker_names', {} ).getCustomData( 'list_marker_names' ) );
database[id] = element;
markerNames[name] = 1;
return element.setCustomData( name, value );
};
CKEDITOR.dom.element.clearAllMarkers = function( database )
{
for ( var i in database )
CKEDITOR.dom.element.clearMarkers( database, database[i], 1 );
};
CKEDITOR.dom.element.clearMarkers = function( database, element, removeFromDatabase )
{
var names = element.getCustomData( 'list_marker_names' ),
id = element.getCustomData( 'list_marker_id' );
for ( var i in names )
element.removeCustomData( i );
element.removeCustomData( 'list_marker_names' );
if ( removeFromDatabase )
{
element.removeCustomData( 'list_marker_id' );
delete database[id];
}
};
CKEDITOR.tools.extend( CKEDITOR.dom.element.prototype,
/** @lends CKEDITOR.dom.element.prototype */
{
/**
* The node type. This is a constant value set to
* {@link CKEDITOR.NODE_ELEMENT}.
* @type Number
* @example
*/
type : CKEDITOR.NODE_ELEMENT,
/**
* Adds a CSS class to the element. It appends the class to the
* already existing names.
* @param {String} className The name of the class to be added.
* @example
* var element = new CKEDITOR.dom.element( 'div' );
* element.addClass( 'classA' ); // <div class="classA">
* element.addClass( 'classB' ); // <div class="classA classB">
* element.addClass( 'classA' ); // <div class="classA classB">
*/
addClass : function( className )
{
var c = this.$.className;
if ( c )
{
var regex = new RegExp( '(?:^|\\s)' + className + '(?:\\s|$)', '' );
if ( !regex.test( c ) )
c += ' ' + className;
}
this.$.className = c || className;
},
/**
* Removes a CSS class name from the elements classes. Other classes
* remain untouched.
* @param {String} className The name of the class to remove.
* @example
* var element = new CKEDITOR.dom.element( 'div' );
* element.addClass( 'classA' ); // <div class="classA">
* element.addClass( 'classB' ); // <div class="classA classB">
* element.removeClass( 'classA' ); // <div class="classB">
* element.removeClass( 'classB' ); // <div>
*/
removeClass : function( className )
{
var c = this.getAttribute( 'class' );
if ( c )
{
var regex = new RegExp( '(?:^|\\s+)' + className + '(?=\\s|$)', 'i' );
if ( regex.test( c ) )
{
c = c.replace( regex, '' ).replace( /^\s+/, '' );
if ( c )
this.setAttribute( 'class', c );
else
this.removeAttribute( 'class' );
}
}
},
hasClass : function( className )
{
var regex = new RegExp( '(?:^|\\s+)' + className + '(?=\\s|$)', '' );
return regex.test( this.getAttribute('class') );
},
/**
* Append a node as a child of this element.
* @param {CKEDITOR.dom.node|String} node The node or element name to be
* appended.
* @param {Boolean} [toStart] Indicates that the element is to be
* appended at the start.
* @returns {CKEDITOR.dom.node} The appended node.
* @example
* var p = new CKEDITOR.dom.element( 'p' );
*
* var strong = new CKEDITOR.dom.element( 'strong' );
* <b>p.append( strong );</b>
*
* var em = <b>p.append( 'em' );</b>
*
* // result: "<p><strong></strong><em></em></p>"
*/
append : function( node, toStart )
{
if ( typeof node == 'string' )
node = this.getDocument().createElement( node );
if ( toStart )
this.$.insertBefore( node.$, this.$.firstChild );
else
this.$.appendChild( node.$ );
return node;
},
appendHtml : function( html )
{
if ( !this.$.childNodes.length )
this.setHtml( html );
else
{
var temp = new CKEDITOR.dom.element( 'div', this.getDocument() );
temp.setHtml( html );
temp.moveChildren( this );
}
},
/**
* Append text to this element.
* @param {String} text The text to be appended.
* @returns {CKEDITOR.dom.node} The appended node.
* @example
* var p = new CKEDITOR.dom.element( 'p' );
* p.appendText( 'This is' );
* p.appendText( ' some text' );
*
* // result: "<p>This is some text</p>"
*/
appendText : function( text )
{
if ( this.$.text != undefined )
this.$.text += text;
else
this.append( new CKEDITOR.dom.text( text ) );
},
appendBogus : function()
{
var lastChild = this.getLast() ;
// Ignore empty/spaces text.
while ( lastChild && lastChild.type == CKEDITOR.NODE_TEXT && !CKEDITOR.tools.rtrim( lastChild.getText() ) )
lastChild = lastChild.getPrevious();
if ( !lastChild || !lastChild.is || !lastChild.is( 'br' ) )
{
var bogus = CKEDITOR.env.opera ?
this.getDocument().createText('') :
this.getDocument().createElement( 'br' );
CKEDITOR.env.gecko && bogus.setAttribute( 'type', '_moz' );
this.append( bogus );
}
},
/**
* Breaks one of the ancestor element in the element position, moving
* this element between the broken parts.
* @param {CKEDITOR.dom.element} parent The anscestor element to get broken.
* @example
* // Before breaking:
* // <b>This <i>is some<span /> sample</i> test text</b>
* // If "element" is <span /> and "parent" is <i>:
* // <b>This <i>is some</i><span /><i> sample</i> test text</b>
* element.breakParent( parent );
* @example
* // Before breaking:
* // <b>This <i>is some<span /> sample</i> test text</b>
* // If "element" is <span /> and "parent" is <b>:
* // <b>This <i>is some</i></b><span /><b><i> sample</i> test text</b>
* element.breakParent( parent );
*/
breakParent : function( parent )
{
var range = new CKEDITOR.dom.range( this.getDocument() );
// We'll be extracting part of this element, so let's use our
// range to get the correct piece.
range.setStartAfter( this );
range.setEndAfter( parent );
// Extract it.
var docFrag = range.extractContents();
// Move the element outside the broken element.
range.insertNode( this.remove() );
// Re-insert the extracted piece after the element.
docFrag.insertAfterNode( this );
},
contains :
CKEDITOR.env.ie || CKEDITOR.env.webkit ?
function( node )
{
var $ = this.$;
return node.type != CKEDITOR.NODE_ELEMENT ?
$.contains( node.getParent().$ ) :
$ != node.$ && $.contains( node.$ );
}
:
function( node )
{
return !!( this.$.compareDocumentPosition( node.$ ) & 16 );
},
/**
* Moves the selection focus to this element.
* @function
* @param {Boolean} defer Whether to asynchronously defer the
* execution by 100 ms.
* @example
* var element = CKEDITOR.document.getById( 'myTextarea' );
* <b>element.focus()</b>;
*/
focus : ( function()
{
function exec()
{
// IE throws error if the element is not visible.
try
{
this.$.focus();
}
catch (e)
{}
}
return function( defer )
{
if ( defer )
CKEDITOR.tools.setTimeout( exec, 100, this );
else
exec.call( this );
};
})(),
/**
* Gets the inner HTML of this element.
* @returns {String} The inner HTML of this element.
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b></div>' );
* alert( <b>p.getHtml()</b> ); // "<b>Example</b>"
*/
getHtml : function()
{
var retval = this.$.innerHTML;
// Strip <?xml:namespace> tags in IE. (#3341).
return CKEDITOR.env.ie ? retval.replace( /<\?[^>]*>/g, '' ) : retval;
},
getOuterHtml : function()
{
if ( this.$.outerHTML )
{
// IE includes the <?xml:namespace> tag in the outerHTML of
// namespaced element. So, we must strip it here. (#3341)
return this.$.outerHTML.replace( /<\?[^>]*>/, '' );
}
var tmpDiv = this.$.ownerDocument.createElement( 'div' );
tmpDiv.appendChild( this.$.cloneNode( true ) );
return tmpDiv.innerHTML;
},
/**
* Sets the inner HTML of this element.
* @param {String} html The HTML to be set for this element.
* @returns {String} The inserted HTML.
* @example
* var p = new CKEDITOR.dom.element( 'p' );
* <b>p.setHtml( '<b>Inner</b> HTML' );</b>
*
* // result: "<p><b>Inner</b> HTML</p>"
*/
setHtml : function( html )
{
return ( this.$.innerHTML = html );
},
/**
* Sets the element contents as plain text.
* @param {String} text The text to be set.
* @returns {String} The inserted text.
* @example
* var element = new CKEDITOR.dom.element( 'div' );
* element.setText( 'A > B & C < D' );
* alert( element.innerHTML ); // "A &gt; B &amp; C &lt; D"
*/
setText : function( text )
{
CKEDITOR.dom.element.prototype.setText = ( this.$.innerText != undefined ) ?
function ( text )
{
return this.$.innerText = text;
} :
function ( text )
{
return this.$.textContent = text;
};
return this.setText( text );
},
/**
* Gets the value of an element attribute.
* @function
* @param {String} name The attribute name.
* @returns {String} The attribute value or null if not defined.
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<input type="text" />' );
* alert( <b>element.getAttribute( 'type' )</b> ); // "text"
*/
getAttribute : (function()
{
var standard = function( name )
{
return this.$.getAttribute( name, 2 );
};
if ( CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.ie6Compat ) )
{
return function( name )
{
switch ( name )
{
case 'class':
name = 'className';
break;
case 'http-equiv':
name = 'httpEquiv';
break;
case 'name':
return this.$.name;
case 'tabindex':
var tabIndex = standard.call( this, name );
// IE returns tabIndex=0 by default for all
// elements. For those elements,
// getAtrribute( 'tabindex', 2 ) returns 32768
// instead. So, we must make this check to give a
// uniform result among all browsers.
if ( tabIndex !== 0 && this.$.tabIndex === 0 )
tabIndex = null;
return tabIndex;
break;
case 'checked':
{
var attr = this.$.attributes.getNamedItem( name ),
attrValue = attr.specified ? attr.nodeValue // For value given by parser.
: this.$.checked; // For value created via DOM interface.
return attrValue ? 'checked' : null;
}
case 'hspace':
case 'value':
return this.$[ name ];
case 'style':
// IE does not return inline styles via getAttribute(). See #2947.
return this.$.style.cssText;
}
return standard.call( this, name );
};
}
else
return standard;
})(),
getChildren : function()
{
return new CKEDITOR.dom.nodeList( this.$.childNodes );
},
/**
* Gets the current computed value of one of the element CSS style
* properties.
* @function
* @param {String} propertyName The style property name.
* @returns {String} The property value.
* @example
* var element = new CKEDITOR.dom.element( 'span' );
* alert( <b>element.getComputedStyle( 'display' )</b> ); // "inline"
*/
getComputedStyle :
CKEDITOR.env.ie ?
function( propertyName )
{
return this.$.currentStyle[ CKEDITOR.tools.cssStyleToDomStyle( propertyName ) ];
}
:
function( propertyName )
{
return this.getWindow().$.getComputedStyle( this.$, '' ).getPropertyValue( propertyName );
},
/**
* Gets the DTD entries for this element.
* @returns {Object} An object containing the list of elements accepted
* by this element.
*/
getDtd : function()
{
var dtd = CKEDITOR.dtd[ this.getName() ];
this.getDtd = function()
{
return dtd;
};
return dtd;
},
getElementsByTag : CKEDITOR.dom.document.prototype.getElementsByTag,
/**
* Gets the computed tabindex for this element.
* @function
* @returns {Number} The tabindex value.
* @example
* var element = CKEDITOR.document.getById( 'myDiv' );
* alert( <b>element.getTabIndex()</b> ); // e.g. "-1"
*/
getTabIndex :
CKEDITOR.env.ie ?
function()
{
var tabIndex = this.$.tabIndex;
// IE returns tabIndex=0 by default for all elements. In
// those cases we must check that the element really has
// the tabindex attribute set to zero, or it is one of
// those element that should have zero by default.
if ( tabIndex === 0 && !CKEDITOR.dtd.$tabIndex[ this.getName() ] && parseInt( this.getAttribute( 'tabindex' ), 10 ) !== 0 )
tabIndex = -1;
return tabIndex;
}
: CKEDITOR.env.webkit ?
function()
{
var tabIndex = this.$.tabIndex;
// Safari returns "undefined" for elements that should not
// have tabindex (like a div). So, we must try to get it
// from the attribute.
// https://bugs.webkit.org/show_bug.cgi?id=20596
if ( tabIndex == undefined )
{
tabIndex = parseInt( this.getAttribute( 'tabindex' ), 10 );
// If the element don't have the tabindex attribute,
// then we should return -1.
if ( isNaN( tabIndex ) )
tabIndex = -1;
}
return tabIndex;
}
:
function()
{
return this.$.tabIndex;
},
/**
* Gets the text value of this element.
*
* Only in IE (which uses innerText), <br> will cause linebreaks,
* and sucessive whitespaces (including line breaks) will be reduced to
* a single space. This behavior is ok for us, for now. It may change
* in the future.
* @returns {String} The text value.
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<div>Sample <i>text</i>.</div>' );
* alert( <b>element.getText()</b> ); // "Sample text."
*/
getText : function()
{
return this.$.textContent || this.$.innerText || '';
},
/**
* Gets the window object that contains this element.
* @returns {CKEDITOR.dom.window} The window object.
* @example
*/
getWindow : function()
{
return this.getDocument().getWindow();
},
/**
* Gets the value of the "id" attribute of this element.
* @returns {String} The element id, or null if not available.
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<p id="myId"></p>' );
* alert( <b>element.getId()</b> ); // "myId"
*/
getId : function()
{
return this.$.id || null;
},
/**
* Gets the value of the "name" attribute of this element.
* @returns {String} The element name, or null if not available.
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<input name="myName"></input>' );
* alert( <b>element.getNameAtt()</b> ); // "myName"
*/
getNameAtt : function()
{
return this.$.name || null;
},
/**
* Gets the element name (tag name). The returned name is guaranteed to
* be always full lowercased.
* @returns {String} The element name.
* @example
* var element = new CKEDITOR.dom.element( 'span' );
* alert( <b>element.getName()</b> ); // "span"
*/
getName : function()
{
// Cache the lowercased name inside a closure.
var nodeName = this.$.nodeName.toLowerCase();
if ( CKEDITOR.env.ie && ! ( document.documentMode > 8 ) )
{
var scopeName = this.$.scopeName;
if ( scopeName != 'HTML' )
nodeName = scopeName.toLowerCase() + ':' + nodeName;
}
return (
this.getName = function()
{
return nodeName;
})();
},
/**
* Gets the value set to this element. This value is usually available
* for form field elements.
* @returns {String} The element value.
*/
getValue : function()
{
return this.$.value;
},
/**
* Gets the first child node of this element.
* @param {Function} evaluator Filtering the result node.
* @returns {CKEDITOR.dom.node} The first child node or null if not
* available.
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b></div>' );
* var first = <b>element.getFirst()</b>;
* alert( first.getName() ); // "b"
*/
getFirst : function( evaluator )
{
var first = this.$.firstChild,
retval = first && new CKEDITOR.dom.node( first );
if ( retval && evaluator && !evaluator( retval ) )
retval = retval.getNext( evaluator );
return retval;
},
/**
* @param {Function} evaluator Filtering the result node.
*/
getLast : function( evaluator )
{
var last = this.$.lastChild,
retval = last && new CKEDITOR.dom.node( last );
if ( retval && evaluator && !evaluator( retval ) )
retval = retval.getPrevious( evaluator );
return retval;
},
getStyle : function( name )
{
return this.$.style[ CKEDITOR.tools.cssStyleToDomStyle( name ) ];
},
/**
* Checks if the element name matches one or more names.
* @param {String} name[,name[,...]] One or more names to be checked.
* @returns {Boolean} true if the element name matches any of the names.
* @example
* var element = new CKEDITOR.element( 'span' );
* alert( <b>element.is( 'span' )</b> ); "true"
* alert( <b>element.is( 'p', 'span' )</b> ); "true"
* alert( <b>element.is( 'p' )</b> ); "false"
* alert( <b>element.is( 'p', 'div' )</b> ); "false"
*/
is : function()
{
var name = this.getName();
for ( var i = 0 ; i < arguments.length ; i++ )
{
if ( arguments[ i ] == name )
return true;
}
return false;
},
/**
* Decide whether one element is able to receive cursor.
* @param {Boolean} [textCursor=true] Only consider element that could receive text child.
*/
isEditable : function( textCursor )
{
var name = this.getName();
if ( this.isReadOnly()
|| this.getComputedStyle( 'display' ) == 'none'
|| this.getComputedStyle( 'visibility' ) == 'hidden'
|| this.is( 'a' ) && this.data( 'cke-saved-name' ) && !this.getChildCount()
|| CKEDITOR.dtd.$nonEditable[ name ] )
{
return false;
}
if ( textCursor !== false )
{
// Get the element DTD (defaults to span for unknown elements).
var dtd = CKEDITOR.dtd[ name ] || CKEDITOR.dtd.span;
// In the DTD # == text node.
return ( dtd && dtd[ '#'] );
}
return true;
},
isIdentical : function( otherElement )
{
if ( this.getName() != otherElement.getName() )
return false;
var thisAttribs = this.$.attributes,
otherAttribs = otherElement.$.attributes;
var thisLength = thisAttribs.length,
otherLength = otherAttribs.length;
for ( var i = 0 ; i < thisLength ; i++ )
{
var attribute = thisAttribs[ i ];
if ( attribute.nodeName == '_moz_dirty' )
continue;
if ( ( !CKEDITOR.env.ie || ( attribute.specified && attribute.nodeName != 'data-cke-expando' ) ) && attribute.nodeValue != otherElement.getAttribute( attribute.nodeName ) )
return false;
}
// For IE, we have to for both elements, because it's difficult to
// know how the atttibutes collection is organized in its DOM.
if ( CKEDITOR.env.ie )
{
for ( i = 0 ; i < otherLength ; i++ )
{
attribute = otherAttribs[ i ];
if ( attribute.specified && attribute.nodeName != 'data-cke-expando'
&& attribute.nodeValue != this.getAttribute( attribute.nodeName ) )
return false;
}
}
return true;
},
/**
* Checks if this element is visible. May not work if the element is
* child of an element with visibility set to "hidden", but works well
* on the great majority of cases.
* @return {Boolean} True if the element is visible.
*/
isVisible : function()
{
var isVisible = ( this.$.offsetHeight || this.$.offsetWidth ) && this.getComputedStyle( 'visibility' ) != 'hidden',
elementWindow,
elementWindowFrame;
// Webkit and Opera report non-zero offsetHeight despite that
// element is inside an invisible iframe. (#4542)
if ( isVisible && ( CKEDITOR.env.webkit || CKEDITOR.env.opera ) )
{
elementWindow = this.getWindow();
if ( !elementWindow.equals( CKEDITOR.document.getWindow() )
&& ( elementWindowFrame = elementWindow.$.frameElement ) )
{
isVisible = new CKEDITOR.dom.element( elementWindowFrame ).isVisible();
}
}
return !!isVisible;
},
/**
* Whether it's an empty inline elements which has no visual impact when removed.
*/
isEmptyInlineRemoveable : function()
{
if ( !CKEDITOR.dtd.$removeEmpty[ this.getName() ] )
return false;
var children = this.getChildren();
for ( var i = 0, count = children.count(); i < count; i++ )
{
var child = children.getItem( i );
if ( child.type == CKEDITOR.NODE_ELEMENT && child.data( 'cke-bookmark' ) )
continue;
if ( child.type == CKEDITOR.NODE_ELEMENT && !child.isEmptyInlineRemoveable()
|| child.type == CKEDITOR.NODE_TEXT && CKEDITOR.tools.trim( child.getText() ) )
{
return false;
}
}
return true;
},
/**
* Checks if the element has any defined attributes.
* @function
* @returns {Boolean} True if the element has attributes.
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<div title="Test">Example</div>' );
* alert( <b>element.hasAttributes()</b> ); // "true"
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<div>Example</div>' );
* alert( <b>element.hasAttributes()</b> ); // "false"
*/
hasAttributes :
CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.ie6Compat ) ?
function()
{
var attributes = this.$.attributes;
for ( var i = 0 ; i < attributes.length ; i++ )
{
var attribute = attributes[i];
switch ( attribute.nodeName )
{
case 'class' :
// IE has a strange bug. If calling removeAttribute('className'),
// the attributes collection will still contain the "class"
// attribute, which will be marked as "specified", even if the
// outerHTML of the element is not displaying the class attribute.
// Note : I was not able to reproduce it outside the editor,
// but I've faced it while working on the TC of #1391.
if ( this.getAttribute( 'class' ) )
return true;
// Attributes to be ignored.
case 'data-cke-expando' :
continue;
/*jsl:fallthru*/
default :
if ( attribute.specified )
return true;
}
}
return false;
}
:
function()
{
var attrs = this.$.attributes,
attrsNum = attrs.length;
// The _moz_dirty attribute might get into the element after pasting (#5455)
var execludeAttrs = { 'data-cke-expando' : 1, _moz_dirty : 1 };
return attrsNum > 0 &&
( attrsNum > 2 ||
!execludeAttrs[ attrs[0].nodeName ] ||
( attrsNum == 2 && !execludeAttrs[ attrs[1].nodeName ] ) );
},
/**
* Checks if the specified attribute is defined for this element.
* @returns {Boolean} True if the specified attribute is defined.
* @param {String} name The attribute name.
* @example
*/
hasAttribute : (function()
{
function standard( name )
{
var $attr = this.$.attributes.getNamedItem( name );
return !!( $attr && $attr.specified );
}
return ( CKEDITOR.env.ie && CKEDITOR.env.version < 8 ) ?
function( name )
{
// On IE < 8 the name attribute cannot be retrieved
// right after the element creation and setting the
// name with setAttribute.
if ( name == 'name' )
return !!this.$.name;
return standard.call( this, name );
}
:
standard;
})(),
/**
* Hides this element (display:none).
* @example
* var element = CKEDITOR.dom.element.getById( 'myElement' );
* <b>element.hide()</b>;
*/
hide : function()
{
this.setStyle( 'display', 'none' );
},
moveChildren : function( target, toStart )
{
var $ = this.$;
target = target.$;
if ( $ == target )
return;
var child;
if ( toStart )
{
while ( ( child = $.lastChild ) )
target.insertBefore( $.removeChild( child ), target.firstChild );
}
else
{
while ( ( child = $.firstChild ) )
target.appendChild( $.removeChild( child ) );
}
},
/**
* Merges sibling elements that are identical to this one.<br>
* <br>
* Identical child elements are also merged. For example:<br>
* <b><i></i></b><b><i></i></b> => <b><i></i></b>
* @function
* @param {Boolean} [inlineOnly] Allow only inline elements to be merged. Defaults to "true".
*/
mergeSiblings : ( function()
{
function mergeElements( element, sibling, isNext )
{
if ( sibling && sibling.type == CKEDITOR.NODE_ELEMENT )
{
// Jumping over bookmark nodes and empty inline elements, e.g. <b><i></i></b>,
// queuing them to be moved later. (#5567)
var pendingNodes = [];
while ( sibling.data( 'cke-bookmark' )
|| sibling.isEmptyInlineRemoveable() )
{
pendingNodes.push( sibling );
sibling = isNext ? sibling.getNext() : sibling.getPrevious();
if ( !sibling || sibling.type != CKEDITOR.NODE_ELEMENT )
return;
}
if ( element.isIdentical( sibling ) )
{
// Save the last child to be checked too, to merge things like
// <b><i></i></b><b><i></i></b> => <b><i></i></b>
var innerSibling = isNext ? element.getLast() : element.getFirst();
// Move pending nodes first into the target element.
while( pendingNodes.length )
pendingNodes.shift().move( element, !isNext );
sibling.moveChildren( element, !isNext );
sibling.remove();
// Now check the last inner child (see two comments above).
if ( innerSibling && innerSibling.type == CKEDITOR.NODE_ELEMENT )
innerSibling.mergeSiblings();
}
}
}
return function( inlineOnly )
{
if ( ! ( inlineOnly === false
|| CKEDITOR.dtd.$removeEmpty[ this.getName() ]
|| this.is( 'a' ) ) ) // Merge empty links and anchors also. (#5567)
{
return;
}
mergeElements( this, this.getNext(), true );
mergeElements( this, this.getPrevious() );
};
} )(),
/**
* Shows this element (display it).
* @example
* var element = CKEDITOR.dom.element.getById( 'myElement' );
* <b>element.show()</b>;
*/
show : function()
{
this.setStyles(
{
display : '',
visibility : ''
});
},
/**
* Sets the value of an element attribute.
* @param {String} name The name of the attribute.
* @param {String} value The value to be set to the attribute.
* @function
* @returns {CKEDITOR.dom.element} This element instance.
* @example
* var element = CKEDITOR.dom.element.getById( 'myElement' );
* <b>element.setAttribute( 'class', 'myClass' )</b>;
* <b>element.setAttribute( 'title', 'This is an example' )</b>;
*/
setAttribute : (function()
{
var standard = function( name, value )
{
this.$.setAttribute( name, value );
return this;
};
if ( CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.ie6Compat ) )
{
return function( name, value )
{
if ( name == 'class' )
this.$.className = value;
else if ( name == 'style' )
this.$.style.cssText = value;
else if ( name == 'tabindex' ) // Case sensitive.
this.$.tabIndex = value;
else if ( name == 'checked' )
this.$.checked = value;
else
standard.apply( this, arguments );
return this;
};
}
else if ( CKEDITOR.env.ie8Compat && CKEDITOR.env.secure )
{
return function( name, value )
{
// IE8 throws error when setting src attribute to non-ssl value. (#7847)
if ( name == 'src' && value.match( /^http:\/\// ) )
try { standard.apply( this, arguments ); } catch( e ){}
else
standard.apply( this, arguments );
return this;
};
}
else
return standard;
})(),
/**
* Sets the value of several element attributes.
* @param {Object} attributesPairs An object containing the names and
* values of the attributes.
* @returns {CKEDITOR.dom.element} This element instance.
* @example
* var element = CKEDITOR.dom.element.getById( 'myElement' );
* <b>element.setAttributes({
* 'class' : 'myClass',
* 'title' : 'This is an example' })</b>;
*/
setAttributes : function( attributesPairs )
{
for ( var name in attributesPairs )
this.setAttribute( name, attributesPairs[ name ] );
return this;
},
/**
* Sets the element value. This function is usually used with form
* field element.
* @param {String} value The element value.
* @returns {CKEDITOR.dom.element} This element instance.
*/
setValue : function( value )
{
this.$.value = value;
return this;
},
/**
* Removes an attribute from the element.
* @param {String} name The attribute name.
* @function
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<div class="classA"></div>' );
* element.removeAttribute( 'class' );
*/
removeAttribute : (function()
{
var standard = function( name )
{
this.$.removeAttribute( name );
};
if ( CKEDITOR.env.ie && ( CKEDITOR.env.ie7Compat || CKEDITOR.env.ie6Compat ) )
{
return function( name )
{
if ( name == 'class' )
name = 'className';
else if ( name == 'tabindex' )
name = 'tabIndex';
standard.call( this, name );
};
}
else
return standard;
})(),
removeAttributes : function ( attributes )
{
if ( CKEDITOR.tools.isArray( attributes ) )
{
for ( var i = 0 ; i < attributes.length ; i++ )
this.removeAttribute( attributes[ i ] );
}
else
{
for ( var attr in attributes )
attributes.hasOwnProperty( attr ) && this.removeAttribute( attr );
}
},
/**
* Removes a style from the element.
* @param {String} name The style name.
* @function
* @example
* var element = CKEDITOR.dom.element.createFromHtml( '<div style="display:none"></div>' );
* element.removeStyle( 'display' );
*/
removeStyle : function( name )
{
this.setStyle( name, '' );
if ( this.$.style.removeAttribute )
this.$.style.removeAttribute( CKEDITOR.tools.cssStyleToDomStyle( name ) );
if ( !this.$.style.cssText )
this.removeAttribute( 'style' );
},
/**
* Sets the value of an element style.
* @param {String} name The name of the style. The CSS naming notation
* must be used (e.g. "background-color").
* @param {String} value The value to be set to the style.
* @returns {CKEDITOR.dom.element} This element instance.
* @example
* var element = CKEDITOR.dom.element.getById( 'myElement' );
* <b>element.setStyle( 'background-color', '#ff0000' )</b>;
* <b>element.setStyle( 'margin-top', '10px' )</b>;
* <b>element.setStyle( 'float', 'right' )</b>;
*/
setStyle : function( name, value )
{
this.$.style[ CKEDITOR.tools.cssStyleToDomStyle( name ) ] = value;
return this;
},
/**
* Sets the value of several element styles.
* @param {Object} stylesPairs An object containing the names and
* values of the styles.
* @returns {CKEDITOR.dom.element} This element instance.
* @example
* var element = CKEDITOR.dom.element.getById( 'myElement' );
* <b>element.setStyles({
* 'position' : 'absolute',
* 'float' : 'right' })</b>;
*/
setStyles : function( stylesPairs )
{
for ( var name in stylesPairs )
this.setStyle( name, stylesPairs[ name ] );
return this;
},
/**
* Sets the opacity of an element.
* @param {Number} opacity A number within the range [0.0, 1.0].
* @example
* var element = CKEDITOR.dom.element.getById( 'myElement' );
* <b>element.setOpacity( 0.75 )</b>;
*/
setOpacity : function( opacity )
{
if ( CKEDITOR.env.ie )
{
opacity = Math.round( opacity * 100 );
this.setStyle( 'filter', opacity >= 100 ? '' : 'progid:DXImageTransform.Microsoft.Alpha(opacity=' + opacity + ')' );
}
else
this.setStyle( 'opacity', opacity );
},
/**
* Makes the element and its children unselectable.
* @function
* @example
* var element = CKEDITOR.dom.element.getById( 'myElement' );
* element.unselectable();
*/
unselectable :
CKEDITOR.env.gecko ?
function()
{
this.$.style.MozUserSelect = 'none';
this.on( 'dragstart', function( evt ) { evt.data.preventDefault(); } );
}
: CKEDITOR.env.webkit ?
function()
{
this.$.style.KhtmlUserSelect = 'none';
this.on( 'dragstart', function( evt ) { evt.data.preventDefault(); } );
}
:
function()
{
if ( CKEDITOR.env.ie || CKEDITOR.env.opera )
{
var element = this.$,
elements = element.getElementsByTagName("*"),
e,
i = 0;
element.unselectable = 'on';
while ( ( e = elements[ i++ ] ) )
{
switch ( e.tagName.toLowerCase() )
{
case 'iframe' :
case 'textarea' :
case 'input' :
case 'select' :
/* Ignore the above tags */
break;
default :
e.unselectable = 'on';
}
}
}
},
getPositionedAncestor : function()
{
var current = this;
while ( current.getName() != 'html' )
{
if ( current.getComputedStyle( 'position' ) != 'static' )
return current;
current = current.getParent();
}
return null;
},
getDocumentPosition : function( refDocument )
{
var x = 0, y = 0,
doc = this.getDocument(),
body = doc.getBody(),
quirks = doc.$.compatMode == 'BackCompat';
if ( document.documentElement[ "getBoundingClientRect" ] )
{
var box = this.$.getBoundingClientRect(),
$doc = doc.$,
$docElem = $doc.documentElement;
var clientTop = $docElem.clientTop || body.$.clientTop || 0,
clientLeft = $docElem.clientLeft || body.$.clientLeft || 0,
needAdjustScrollAndBorders = true;
/*
* #3804: getBoundingClientRect() works differently on IE and non-IE
* browsers, regarding scroll positions.
*
* On IE, the top position of the <html> element is always 0, no matter
* how much you scrolled down.
*
* On other browsers, the top position of the <html> element is negative
* scrollTop.
*/
if ( CKEDITOR.env.ie )
{
var inDocElem = doc.getDocumentElement().contains( this ),
inBody = doc.getBody().contains( this );
needAdjustScrollAndBorders = ( quirks && inBody ) || ( !quirks && inDocElem );
}
if ( needAdjustScrollAndBorders )
{
x = box.left + ( !quirks && $docElem.scrollLeft || body.$.scrollLeft );
x -= clientLeft;
y = box.top + ( !quirks && $docElem.scrollTop || body.$.scrollTop );
y -= clientTop;
}
}
else
{
var current = this, previous = null, offsetParent;
while ( current && !( current.getName() == 'body' || current.getName() == 'html' ) )
{
x += current.$.offsetLeft - current.$.scrollLeft;
y += current.$.offsetTop - current.$.scrollTop;
// Opera includes clientTop|Left into offsetTop|Left.
if ( !current.equals( this ) )
{
x += ( current.$.clientLeft || 0 );
y += ( current.$.clientTop || 0 );
}
var scrollElement = previous;
while ( scrollElement && !scrollElement.equals( current ) )
{
x -= scrollElement.$.scrollLeft;
y -= scrollElement.$.scrollTop;
scrollElement = scrollElement.getParent();
}
previous = current;
current = ( offsetParent = current.$.offsetParent ) ?
new CKEDITOR.dom.element( offsetParent ) : null;
}
}
if ( refDocument )
{
var currentWindow = this.getWindow(),
refWindow = refDocument.getWindow();
if ( !currentWindow.equals( refWindow ) && currentWindow.$.frameElement )
{
var iframePosition = ( new CKEDITOR.dom.element( currentWindow.$.frameElement ) ).getDocumentPosition( refDocument );
x += iframePosition.x;
y += iframePosition.y;
}
}
if ( !document.documentElement[ "getBoundingClientRect" ] )
{
// In Firefox, we'll endup one pixel before the element positions,
// so we must add it here.
if ( CKEDITOR.env.gecko && !quirks )
{
x += this.$.clientLeft ? 1 : 0;
y += this.$.clientTop ? 1 : 0;
}
}
return { x : x, y : y };
},
/**
* Make any page element visible inside the browser viewport.
* @param {Boolean} [alignToTop]
*/
scrollIntoView : function( alignToTop )
{
var parent = this.getParent();
if ( !parent ) return;
// Scroll the element into parent container from the inner out.
do
{
// Check ancestors that overflows.
var overflowed =
parent.$.clientWidth && parent.$.clientWidth < parent.$.scrollWidth
|| parent.$.clientHeight && parent.$.clientHeight < parent.$.scrollHeight;
if ( overflowed )
this.scrollIntoParent( parent, alignToTop, 1 );
// Walk across the frame.
if ( parent.is( 'html' ) )
{
var win = parent.getWindow();
// Avoid security error.
try
{
var iframe = win.$.frameElement;
iframe && ( parent = new CKEDITOR.dom.element( iframe ) );
}
catch(er){}
}
}
while ( ( parent = parent.getParent() ) );
},
/**
* Make any page element visible inside one of the ancestors by scrolling the parent.
* @param {CKEDITOR.dom.element|CKEDITOR.dom.window} parent The container to scroll into.
* @param {Boolean} [alignToTop] Align the element's top side with the container's
* when <code>true</code> is specified; align the bottom with viewport bottom when
* <code>false</code> is specified. Otherwise scroll on either side with the minimum
* amount to show the element.
* @param {Boolean} [hscroll] Whether horizontal overflow should be considered.
*/
scrollIntoParent : function( parent, alignToTop, hscroll )
{
!parent && ( parent = this.getWindow() );
var doc = parent.getDocument();
var isQuirks = doc.$.compatMode == 'BackCompat';
// On window <html> is scrolled while quirks scrolls <body>.
if ( parent instanceof CKEDITOR.dom.window )
parent = isQuirks ? doc.getBody() : doc.getDocumentElement();
// Scroll the parent by the specified amount.
function scrollBy( x, y )
{
// Webkit doesn't support "scrollTop/scrollLeft"
// on documentElement/body element.
if ( /body|html/.test( parent.getName() ) )
parent.getWindow().$.scrollBy( x, y );
else
{
parent.$[ 'scrollLeft' ] += x;
parent.$[ 'scrollTop' ] += y;
}
}
// Figure out the element position relative to the specified window.
function screenPos( element, refWin )
{
var pos = { x: 0, y: 0 };
if ( !( element.is( isQuirks ? 'body' : 'html' ) ) )
{
var box = element.$.getBoundingClientRect();
pos.x = box.left, pos.y = box.top;
}
var win = element.getWindow();
if ( !win.equals( refWin ) )
{
var outerPos = screenPos( CKEDITOR.dom.element.get( win.$.frameElement ), refWin );
pos.x += outerPos.x, pos.y += outerPos.y;
}
return pos;
}
// calculated margin size.
function margin( element, side )
{
return parseInt( element.getComputedStyle( 'margin-' + side ) || 0, 10 ) || 0;
}
var win = parent.getWindow();
var thisPos = screenPos( this, win ),
parentPos = screenPos( parent, win ),
eh = this.$.offsetHeight,
ew = this.$.offsetWidth,
ch = parent.$.clientHeight,
cw = parent.$.clientWidth,
lt,
br;
// Left-top margins.
lt =
{
x : thisPos.x - margin( this, 'left' ) - parentPos.x || 0,
y : thisPos.y - margin( this, 'top' ) - parentPos.y|| 0
};
// Bottom-right margins.
br =
{
x : thisPos.x + ew + margin( this, 'right' ) - ( ( parentPos.x ) + cw ) || 0,
y : thisPos.y + eh + margin( this, 'bottom' ) - ( ( parentPos.y ) + ch ) || 0
};
// 1. Do the specified alignment as much as possible;
// 2. Otherwise be smart to scroll only the minimum amount;
// 3. Never cut at the top;
// 4. DO NOT scroll when already visible.
if ( lt.y < 0 || br.y > 0 )
{
scrollBy( 0,
alignToTop === true ? lt.y :
alignToTop === false ? br.y :
lt.y < 0 ? lt.y : br.y );
}
if ( hscroll && ( lt.x < 0 || br.x > 0 ) )
scrollBy( lt.x < 0 ? lt.x : br.x, 0 );
},
setState : function( state )
{
switch ( state )
{
case CKEDITOR.TRISTATE_ON :
this.addClass( 'cke_on' );
this.removeClass( 'cke_off' );
this.removeClass( 'cke_disabled' );
break;
case CKEDITOR.TRISTATE_DISABLED :
this.addClass( 'cke_disabled' );
this.removeClass( 'cke_off' );
this.removeClass( 'cke_on' );
break;
default :
this.addClass( 'cke_off' );
this.removeClass( 'cke_on' );
this.removeClass( 'cke_disabled' );
break;
}
},
/**
* Returns the inner document of this IFRAME element.
* @returns {CKEDITOR.dom.document} The inner document.
*/
getFrameDocument : function()
{
var $ = this.$;
try
{
// In IE, with custom document.domain, it may happen that
// the iframe is not yet available, resulting in "Access
// Denied" for the following property access.
$.contentWindow.document;
}
catch ( e )
{
// Trick to solve this issue, forcing the iframe to get ready
// by simply setting its "src" property.
$.src = $.src;
// In IE6 though, the above is not enough, so we must pause the
// execution for a while, giving it time to think.
if ( CKEDITOR.env.ie && CKEDITOR.env.version < 7 )
{
window.showModalDialog(
'javascript:document.write("' +
'<script>' +
'window.setTimeout(' +
'function(){window.close();}' +
',50);' +
'</script>")' );
}
}
return $ && new CKEDITOR.dom.document( $.contentWindow.document );
},
/**
* Copy all the attributes from one node to the other, kinda like a clone
* skipAttributes is an object with the attributes that must NOT be copied.
* @param {CKEDITOR.dom.element} dest The destination element.
* @param {Object} skipAttributes A dictionary of attributes to skip.
* @example
*/
copyAttributes : function( dest, skipAttributes )
{
var attributes = this.$.attributes;
skipAttributes = skipAttributes || {};
for ( var n = 0 ; n < attributes.length ; n++ )
{
var attribute = attributes[n];
// Lowercase attribute name hard rule is broken for
// some attribute on IE, e.g. CHECKED.
var attrName = attribute.nodeName.toLowerCase(),
attrValue;
// We can set the type only once, so do it with the proper value, not copying it.
if ( attrName in skipAttributes )
continue;
if ( attrName == 'checked' && ( attrValue = this.getAttribute( attrName ) ) )
dest.setAttribute( attrName, attrValue );
// IE BUG: value attribute is never specified even if it exists.
else if ( attribute.specified ||
( CKEDITOR.env.ie && attribute.nodeValue && attrName == 'value' ) )
{
attrValue = this.getAttribute( attrName );
if ( attrValue === null )
attrValue = attribute.nodeValue;
dest.setAttribute( attrName, attrValue );
}
}
// The style:
if ( this.$.style.cssText !== '' )
dest.$.style.cssText = this.$.style.cssText;
},
/**
* Changes the tag name of the current element.
* @param {String} newTag The new tag for the element.
*/
renameNode : function( newTag )
{
// If it's already correct exit here.
if ( this.getName() == newTag )
return;
var doc = this.getDocument();
// Create the new node.
var newNode = new CKEDITOR.dom.element( newTag, doc );
// Copy all attributes.
this.copyAttributes( newNode );
// Move children to the new node.
this.moveChildren( newNode );
// Replace the node.
this.getParent() && this.$.parentNode.replaceChild( newNode.$, this.$ );
newNode.$[ 'data-cke-expando' ] = this.$[ 'data-cke-expando' ];
this.$ = newNode.$;
},
/**
* Gets a DOM tree descendant under the current node.
* @param {Array|Number} indices The child index or array of child indices under the node.
* @returns {CKEDITOR.dom.node} The specified DOM child under the current node. Null if child does not exist.
* @example
* var strong = p.getChild(0);
*/
getChild : function( indices )
{
var rawNode = this.$;
if ( !indices.slice )
rawNode = rawNode.childNodes[ indices ];
else
{
while ( indices.length > 0 && rawNode )
rawNode = rawNode.childNodes[ indices.shift() ];
}
return rawNode ? new CKEDITOR.dom.node( rawNode ) : null;
},
getChildCount : function()
{
return this.$.childNodes.length;
},
disableContextMenu : function()
{
this.on( 'contextmenu', function( event )
{
// Cancel the browser context menu.
if ( !event.data.getTarget().hasClass( 'cke_enable_context_menu' ) )
event.data.preventDefault();
} );
},
/**
* Gets element's direction. Supports both CSS 'direction' prop and 'dir' attr.
*/
getDirection : function( useComputed )
{
return useComputed ?
this.getComputedStyle( 'direction' )
// Webkit: offline element returns empty direction (#8053).
|| this.getDirection()
|| this.getDocument().$.dir
|| this.getDocument().getBody().getDirection( 1 )
: this.getStyle( 'direction' ) || this.getAttribute( 'dir' );
},
/**
* Gets, sets and removes custom data to be stored as HTML5 data-* attributes.
* @param {String} name The name of the attribute, excluding the 'data-' part.
* @param {String} [value] The value to set. If set to false, the attribute will be removed.
* @example
* element.data( 'extra-info', 'test' ); // appended the attribute data-extra-info="test" to the element
* alert( element.data( 'extra-info' ) ); // "test"
* element.data( 'extra-info', false ); // remove the data-extra-info attribute from the element
*/
data : function ( name, value )
{
name = 'data-' + name;
if ( value === undefined )
return this.getAttribute( name );
else if ( value === false )
this.removeAttribute( name );
else
this.setAttribute( name, value );
return null;
}
});
( function()
{
var sides = {
width : [ "border-left-width", "border-right-width","padding-left", "padding-right" ],
height : [ "border-top-width", "border-bottom-width", "padding-top", "padding-bottom" ]
};
function marginAndPaddingSize( type )
{
var adjustment = 0;
for ( var i = 0, len = sides[ type ].length; i < len; i++ )
adjustment += parseInt( this.getComputedStyle( sides [ type ][ i ] ) || 0, 10 ) || 0;
return adjustment;
}
/**
* Sets the element size considering the box model.
* @name CKEDITOR.dom.element.prototype.setSize
* @function
* @param {String} type The dimension to set. It accepts "width" and "height".
* @param {Number} size The length unit in px.
* @param {Boolean} isBorderBox Apply the size based on the border box model.
*/
CKEDITOR.dom.element.prototype.setSize = function( type, size, isBorderBox )
{
if ( typeof size == 'number' )
{
if ( isBorderBox && !( CKEDITOR.env.ie && CKEDITOR.env.quirks ) )
size -= marginAndPaddingSize.call( this, type );
this.setStyle( type, size + 'px' );
}
};
/**
* Gets the element size, possibly considering the box model.
* @name CKEDITOR.dom.element.prototype.getSize
* @function
* @param {String} type The dimension to get. It accepts "width" and "height".
* @param {Boolean} isBorderBox Get the size based on the border box model.
*/
CKEDITOR.dom.element.prototype.getSize = function( type, isBorderBox )
{
var size = Math.max( this.$[ 'offset' + CKEDITOR.tools.capitalize( type ) ],
this.$[ 'client' + CKEDITOR.tools.capitalize( type ) ] ) || 0;
if ( isBorderBox )
size -= marginAndPaddingSize.call( this, type );
return size;
};
})();
Copyright © 1945 -