Home/CKEditor 4/API

CKEDITOR.dom.element

class

Hierarchy

domObject
- node
  - element

Mixes

event

Subclasses

editable
nestedEditable

See source

Represents a DOM element.

// Create a new <span> element.
var element = new CKEDITOR.dom.element( 'span' );

// Create an element based on a native DOM element.
var element = new CKEDITOR.dom.element( document.getElementById( 'myId' ) );

Filtering

Public
Inherited
Mixed
Protected
Private
Deprecated

Properties

readonly inherited
$ : Object
See source
The native DOM object represented by this class instance.
```
var element = new CKEDITOR.dom.element( 'span' );
alert( element.$.nodeType ); // '1'
```
readonly
type : Number

See source
The node type. This is a constant value set to CKEDITOR.NODE_ELEMENT.

Defaults to CKEDITOR.NODE_ELEMENT

Static properties

mixed static
useCapture : Boolean

See source

Methods

inherited
constructor( nativeDomObject ) → domObject

See source
Creates a domObject class instance.

Parameters

nativeDomObject : Object

A native DOM object.

Returns

domObject
chainable
addClass( className ) → element
See source
Adds a CSS class to the element. It appends the class to the already existing names.
```
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">
```
Note: Since CKEditor 4.5.0 this method cannot be used with multiple classes ('classA classB').

Parameters

className : String

The name of the class to be added.

Returns

element

this
append( node, [ toStart ] ) → node
See source
Append a node as a child of this element.
```
var p = new CKEDITOR.dom.element( 'p' );

var strong = new CKEDITOR.dom.element( 'strong' );
p.append( strong );

var em = p.append( 'em' );

// Result: '<p><strong></strong><em></em></p>'
```
Parameters

node : node | String

The node or element name to be appended.

[ toStart ] : Boolean

Indicates that the element is to be appended at the start.

Defaults to false

Returns

node

The appended node.
appendBogus( [ force ] )

See source
Appends a <br> filler element to this element if the filler is not present already. By default filler is appended only if CKEDITOR.env.needsBrFiller is true, however when force is set to true filler will be appended regardless of the environment.

Parameters

[ force ] : Boolean

Append filler regardless of the environment.
appendHtml( html )

See source
Append HTML as a child(ren) of this element.

Parameters

html : String
appendText( text )
See source
Append text to this element.
```
var p = new CKEDITOR.dom.element( 'p' );
p.appendText( 'This is' );
p.appendText( ' some text' );

// Result: '<p>This is some text</p>'
```
Parameters

text : String

The text to be appended.
inherited
appendTo( element ) → element
See source
Makes this node a child of another element.
```
var p = new CKEDITOR.dom.element( 'p' );
var strong = new CKEDITOR.dom.element( 'strong' );
strong.appendTo( p );

// Result: '<p><strong></strong></p>'.
```
Parameters

element : element

The target element to which this node will be appended.

Returns

element

The target element.

`breakParent( parent, [ cloneId ] )`

See source

Breaks one of the ancestor element in the element position, moving this element between the broken parts.

// 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 );

// 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 );

Parameters

parent : element

The anscestor element to get broken.

[ cloneId ] : Boolean

Whether to preserve ancestor ID attributes while breaking.

Defaults to false

inherited
capture()

See source
Register event handler under the capturing stage on supported target.
inherited
clearCustomData()

See source
Removes any data stored in this object. To avoid memory leaks we must assure that there are no references left after the object is no longer needed.
inherited
clone( [ includeChildren ], [ cloneId ] ) → node

See source
Clones this node.

Note: Values set by {setCustomData} will not be available in the clone.

Parameters

[ includeChildren ] : Boolean

If true then all node's children will be cloned recursively.

Defaults to false

[ cloneId ] : Boolean

Whether ID attributes should be cloned, too.

Defaults to false

Returns

node

Clone of this node.
contains( node ) → Boolean

See source
Checks if this element contains given node.

Parameters

node : node

Returns

Boolean
copyAttributes( dest, skipAttributes )

See source
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.

Parameters

dest : element

The destination element.

skipAttributes : Object

A dictionary of attributes to skip.
data( name, [ value ] )
See source
Gets, sets and removes custom data to be stored as HTML5 data-* attributes.
```
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.
```
Parameters

name : String

The name of the attribute, excluding the data- part.

[ value ] : String

The value to set. If set to false, the attribute will be removed.
inherited
define( name, meta )

See source
Predefine some intrinsic properties on a specific event name.

Parameters

name : String

The event name

meta : Object
disableContextMenu()

See source
Disables browser's context menu in this element.
inherited
equals( object ) → Boolean
See source
Determines whether the specified object is equal to the current object.
```
var doc = new CKEDITOR.dom.document( document );
alert( doc.equals( CKEDITOR.document ) );   // true
alert( doc == CKEDITOR.document );          // false
```
Parameters

object : Object

The object to compare with the current object.

Returns

Boolean

true if the object is equal.
since 4.3.0
find( selector ) → nodeList
See source
Returns list of elements within this element that match specified selector.

Notes:
- Not available in IE7.
- Returned list is not a live collection (like a result of native querySelectorAll).
- Unlike the native querySelectorAll this method ensures selector contextualization. This is:
```
  HTML:       '<body><div><i>foo</i></div></body>'
  Native:     div.querySelectorAll( 'body i' ) // ->      [ <i>foo</i> ]
  Method:     div.find( 'body i' ) // ->                  []
              div.find( 'i' ) // ->                       [ <i>foo</i> ]
```
Parameters

selector : String

A valid CSS selector.

Returns

nodeList
since 4.3.0
findOne( selector ) → element
See source
Returns the first element within this element that matches the specified selector.

Notes:
- Not available in IE7.
- Unlike the native querySelector this method ensures selector contextualization. This is:
```
  HTML:       '<body><div><i>foo</i></div></body>'
  Native:     div.querySelector( 'body i' ) // ->         <i>foo</i>
  Method:     div.findOne( 'body i' ) // ->               null
              div.findOne( 'i' ) // ->                    <i>foo</i>
```
Parameters

selector : String

A valid CSS selector.

Returns

element
inherited
fire( eventName, [ data ], [ editor ] ) → Boolean | Object
See source
Fires an specific event in the object. All registered listeners are called at this point.
```
someObject.on( 'someEvent', function() { ... } );
someObject.on( 'someEvent', function() { ... } );
someObject.fire( 'someEvent' );             // Both listeners are called.

someObject.on( 'someEvent', function( event ) {
    alert( event.data );                    // 'Example'
} );
someObject.fire( 'someEvent', 'Example' );
```
Parameters

eventName : String

The event name to fire.

[ data ] : Object

Data to be sent as the CKEDITOR.eventInfo.data when calling the listeners.

[ editor ] : editor

The editor instance to send as the CKEDITOR.eventInfo.editor when calling the listener.

Returns

Boolean | Object

A boolean indicating that the event is to be canceled, or data returned by one of the listeners.
since 4.13.0
fireEventHandler( element, eventName, evt )
See source
Fires the element event handler attribute, for example:
```
<button onkeydown="return customFn( event )">x</button>
```
```
buttonEl.fireEventHandler( 'keydown', {
    keyCode: 13 // Enter
} );
```
Parameters

element : element | HTMLElement

An element with an attached event handler attribute.

eventName : String

Event name.

evt : Object

Event payload.
inherited
fireOnce( eventName, [ data ], [ editor ] ) → Boolean | Object
See source
Fires an specific event in the object, releasing all listeners registered to that event. The same listeners are not called again on successive calls of it or of fire.
```
someObject.on( 'someEvent', function() { ... } );
someObject.fire( 'someEvent' );         // Above listener called.
someObject.fireOnce( 'someEvent' );     // Above listener called.
someObject.fire( 'someEvent' );         // No listeners called.
```
Parameters

eventName : String

The event name to fire.

[ data ] : Object

Data to be sent as the CKEDITOR.eventInfo.data when calling the listeners.

[ editor ] : editor

The editor instance to send as the CKEDITOR.eventInfo.editor when calling the listener.

Returns

Boolean | Object

A booloan indicating that the event is to be canceled, or data returned by one of the listeners.
focus( defer )
See source
Moves the selection focus to this element.
```
var element = CKEDITOR.document.getById( 'myTextarea' );
element.focus();
```
Parameters

defer : Boolean

Whether to asynchronously defer the execution by 100 ms.
focusNext( [ ignoreChildren ], [ indexToUse ] )
See source
Moves the UI focus to the element following this element in the tabindex order.
```
var element = CKEDITOR.document.getById( 'example' );
element.focusNext();
```
Parameters

[ ignoreChildren ] : Boolean

Defaults to false

[ indexToUse ] : Number
focusPrevious( [ ignoreChildren ], [ indexToUse ] )
See source
Moves the UI focus to the element before this element in the tabindex order.
```
var element = CKEDITOR.document.getById( 'example' );
element.focusPrevious();
```
Parameters

[ ignoreChildren ] : Boolean

Defaults to false

[ indexToUse ] : Number
since 4.3.0
forEach( callback, [ type ], [ skipRoot ] )
See source
Traverse the DOM of this element (inclusive), executing a callback for each node.
```
var element = CKEDITOR.dom.element.createFromHtml( '<div><p>foo<b>bar</b>bom</p></div>' );
element.forEach( function( node ) {
    console.log( node );
} );
// Will log:
// 1. <div> element,
// 2. <p> element,
// 3. "foo" text node,
// 4. <b> element,
// 5. "bar" text node,
// 6. "bom" text node.
```
Parameters

callback : Function

Function to be executed on every node. If callback returns false descendants of the node will be ignored.

[ type ] : Number

If specified callback will be executed only on nodes of this type.

[ skipRoot ] : Boolean

Don't execute callback on this element.
inherited
getAddress( [ normalized ] ) → Array

See source
Retrieves a uniquely identifiable tree address for this node. The tree address returned is an array of integers, with each integer indicating a child index of a DOM node, starting from document.documentElement.

For example, assuming <body> is the second child of <html> (<head> being the first), and we would like to address the third child under the fourth child of <body>, the tree address returned would be: [1, 3, 2].

The tree address cannot be used for finding back the DOM tree node once the DOM tree structure has been modified.

Parameters

[ normalized ] : Boolean

See getIndex.

Defaults to false

Returns

Array

The address.

since 3.6.1 inherited
`getAscendant( query, [ includeSelf ] ) → node`

See source

Gets the closest ancestor node of this node, specified by its name or using an evaluator function.

// Suppose we have the following HTML structure:
// <div id="outer"><div id="inner"><p><b>Some text</b></p></div></div>
// If node == <b>
ascendant = node.getAscendant( 'div' );             // ascendant == <div id="inner">
ascendant = node.getAscendant( 'b' );               // ascendant == null
ascendant = node.getAscendant( 'b', true );         // ascendant == <b>
ascendant = node.getAscendant( { div:1, p:1 } );    // Searches for the first 'div' or 'p': ascendant == <div id="inner">

// Using custom evaluator:
ascendant = node.getAscendant( function( el ) {
    return el.getId() == 'inner';
} );
// ascendant == <div id="inner">

Parameters

query : String | Function | Object: The name of the ancestor node to search or an object with the node names to search for or an evaluator function.
[ includeSelf ] : Boolean: Whether to include the current node in the search.

Returns

node: The located ancestor node or null if not found.

getAttribute( name ) → String
See source
Gets the value of an element attribute.
```
var element = CKEDITOR.dom.element.createFromHtml( '<input type="text" />' );
alert( element.getAttribute( 'type' ) ); // 'text'
```
Parameters

name : String

The attribute name.

Returns

String

The attribute value or null if not defined.
getAttributes( exclude ) → Object

See source
Gets the values of all element attributes.

Parameters

exclude : Array

The names of attributes to be excluded from the returned object.

Returns

Object

An object containing all element attributes with their values.
getBogus() → node | Boolean

See source
Checks if there is a filler node at the end of an element, and returns it.

Returns

node | Boolean

Bogus node or false.
getChild( indices ) → node
See source
Gets a DOM tree descendant under the current node.
```
var strong = p.getChild( 0 );
```
Parameters

indices : Array | Number

The child index or array of child indices under the node.

Returns

node

The specified DOM child under the current node. Null if child does not exist.
getChildCount() → Number

See source
Gets number of element's children.

Returns

Number
getChildren() → nodeList

See source
Gets the nodes list containing all children of this element.

Returns

nodeList
getClientRect( [ isAbsolute ] ) → rect
See source
Retrieve the bounding rectangle of the current element, in pixels, relative to the upper-left corner of the browser's client area.

Since 4.10.0 you can pass an additional parameter if the function should return an absolute element position that can be used for positioning elements inside scrollable areas.

For example, you can use this function with the editor's window frame to calculate the absolute rectangle of the visible area of the editor viewport. The retrieved absolute rectangle can be used to position elements like toolbars or notifications (elements outside the editor) to always keep them inside the editor viewport independently from the scroll position.
```
var frame = editor.window.getFrame();
frame.getClientRect( true );
```
Parameters

[ isAbsolute ] : Boolean

The function will retrieve an absolute rectangle of the element, i.e. the position relative to the upper-left corner of the topmost viewport. This option is available since 4.10.0.

Defaults to false

Returns

rect

The dimensions of the DOM element.
since 4.13.0
getClientSize() → Object

See source
Gets the element clientWidth and clientHeight.

Returns

Object

An object containing the width and height values.
inherited
getCommonAncestor( node )

See source

Parameters

node : Object
getComputedStyle( propertyName ) → String
See source
Gets the current computed value of one of the element CSS style properties.
```
var element = new CKEDITOR.dom.element( 'span' );
alert( element.getComputedStyle( 'display' ) ); // 'inline'
```
Parameters

propertyName : String

The style property name.

Returns

String

The property value.
inherited
getCustomData( key ) → Object
See source
Gets the value set to a data slot in this object.
```
var element = new CKEDITOR.dom.element( 'span' );
alert( element.getCustomData( 'hasCustomData' ) );      // e.g. 'true'
alert( element.getCustomData( 'nonExistingKey' ) );     // null
```
Parameters

key : String

The key used to identify the data slot.

Returns

Object

This value set to the data slot.
getDirection( useComputed )

See source
Gets element's direction. Supports both CSS direction prop and dir attr.

Parameters

useComputed : Object
inherited
getDocument() → document
See source
Gets the document containing this element.
```
var element = CKEDITOR.document.getById( 'example' );
alert( element.getDocument().equals( CKEDITOR.document ) ); // true
```
Returns

document

The document.
getDocumentPosition( [ refDocument ] ) → Object

See source
Gets this element's position in document.

Parameters

[ refDocument ] : document

Returns

Object

Element's position.

Properties

x : Number

y : Number

refDocument
getDtd() → Object

See source
Gets the DTD entries for this element.

Returns

Object

An object containing the list of elements accepted by this element.
getEditor( [ optimized ] ) → editor
See source
Retrieves an editor instance which is based on this element (if any). It basically loops over CKEDITOR.instances in search for an instance that uses the element.
```
var element = new CKEDITOR.dom.element( 'div' );
element.appendTo( CKEDITOR.document.getBody() );
CKEDITOR.replace( element );
alert( element.getEditor().name ); // 'editor1'
```
By default this method considers only original DOM elements upon which the editor was created. Setting optimized parameter to false will consider editor editable and its children.

Parameters

[ optimized ] : Boolean

If set to false it will scan every editor editable.

Defaults to true

Returns

editor

An editor instance or null if nothing has been found.
getElementsByTag( tagName )

See source
Gets all this element's descendants having given tag name.

Parameters

tagName : String
getFirst( evaluator ) → node
See source
Gets the first child node of this element.
```
var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b></div>' );
var first = element.getFirst();
alert( first.getName() ); // 'b'
```
Parameters

evaluator : Function

Filtering the result node.

Returns

node

The first child node or null if not available.
getFrameDocument() → document

See source
Returns the inner document of this <iframe> element.

Returns

document

The inner document.
getHtml() → String
See source
Gets the inner HTML of this element.
```
var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b></div>' );
alert( element.getHtml() ); // '<b>Example</b>'
```
Returns

String

The inner HTML of this element.
getId() → String
See source
Gets the value of the id attribute of this element.
```
var element = CKEDITOR.dom.element.createFromHtml( '<p id="myId"></p>' );
alert( element.getId() ); // 'myId'
```
Returns

String

The element id, or null if not available.
inherited
getIndex( normalized ) → Number
See source
Gets the index of a node in an array of its parent.childNodes. Returns -1 if a node does not have a parent or when the normalized argument is set to true and the text node is empty and will be removed during the normalization.

Let us assume having the following childNodes array:
```
[ emptyText, element1, text, text, element2, emptyText2 ]

emptyText.getIndex()            // 0
emptyText.getIndex( true )      // -1
element1.getIndex();            // 1
element1.getIndex( true );      // 0
element2.getIndex();            // 4
element2.getIndex( true );      // 2
emptyText2.getIndex();          // 5
emptyText2.getIndex( true );    // -1
```
Parameters

normalized : Boolean

When true, adjacent text nodes are merged and empty text nodes are removed.

Returns

Number

Index of a node or -1 if a node does not have a parent or is removed during the normalization.
getLast( evaluator ) → node

See source
See getFirst.

Parameters

evaluator : Function

Filtering the result node.

Returns

node
getName() → String
See source
Gets the element name (tag name). The returned name is guaranteed to be always full lowercased.
```
var element = new CKEDITOR.dom.element( 'span' );
alert( element.getName() ); // 'span'
```
Returns

String

The element name.
getNameAtt() → String
See source
Gets the value of the name attribute of this element.
```
var element = CKEDITOR.dom.element.createFromHtml( '<input name="myName"></input>' );
alert( <b>element.getNameAtt()</b> ); // 'myName'
```
Returns

String

The element name, or null if not available.
inherited
getNext( [ evaluator ] ) → node
See source
Gets the node that follows this element in its parent's child list.
```
var element = CKEDITOR.dom.element.createFromHtml( '<div><b>Example</b><i>next</i></div>' );
var last = element.getFirst().getNext();
alert( last.getName() ); // 'i'
```
Parameters

[ evaluator ] : Function

Filtering the result node.

Returns

node

The next node or null if not available.
inherited
getNextSourceNode( startFromSibling, nodeType, guard )

See source

Parameters

startFromSibling : Object

nodeType : Object

guard : Object

`getOuterHtml() → String`

See source

Gets the outer (inner plus tags) HTML of this element.

var element = CKEDITOR.dom.element.createFromHtml( '<div class="bold"><b>Example</b></div>' );
alert( element.getOuterHtml() ); // '<div class="bold"><b>Example</b></div>'

Returns

String: The outer HTML of this element.

inherited
getParent( [ allowFragmentParent ] ) → element
See source
Gets the parent element for this node.
```
var node = editor.document.getBody().getFirst();
var parent = node.getParent();
alert( parent.getName() ); // 'body'
```
Parameters

[ allowFragmentParent ] : Boolean

Consider also parent node that is of fragment type CKEDITOR.NODE_DOCUMENT_FRAGMENT.

Defaults to false

Returns

element

The parent element.
inherited
getParents( [ closerFirst ] ) → Array
See source
Returns an array containing node parents and the node itself. By default nodes are in descending order.
```
// Assuming that body has paragraph as the first child.
var node = editor.document.getBody().getFirst();
var parents = node.getParents();
alert( parents[ 0 ].getName() + ',' + parents[ 2 ].getName() ); // 'html,p'
```
Parameters

[ closerFirst ] : Boolean

Determines the order of returned nodes.

Defaults to false

Returns

Array

Returns an array of CKEDITOR.dom.node.
inherited
getPosition( otherNode ) → Number

See source
Determines the position relation between this node and the given CKEDITOR.dom.node in the document. This node can be preceding (CKEDITOR.POSITION_PRECEDING) or following (CKEDITOR.POSITION_FOLLOWING) the given node. This node can also contain (CKEDITOR.POSITION_CONTAINS) or be contained by (CKEDITOR.POSITION_IS_CONTAINED) the given node. The function returns a bitmask of constants listed above or CKEDITOR.POSITION_IDENTICAL if the given node is the same as this node.

Parameters

otherNode : node

A node to check relation with.

Returns

Number

Position relation between this node and given node.
getPositionedAncestor() → element

See source
Gets closest positioned (position != static) ancestor.

Returns

element

Positioned ancestor or null.
inherited
getPrevious( [ evaluator ] ) → node
See source
Gets the node that preceeds this element in its parent's child list.
```
var element = CKEDITOR.dom.element.createFromHtml( '<div><i>prev</i><b>Example</b></div>' );
var first = element.getLast().getPrev();
alert( first.getName() ); // 'i'
```
Parameters

[ evaluator ] : Function

Filtering the result node.

Returns

node

The previous node or null if not available.
inherited
getPreviousSourceNode( startFromSibling, nodeType, guard )

See source

Parameters

startFromSibling : Object

nodeType : Object

guard : Object

inherited
`getPrivate() → Object`

See source

Gets the private _ object which is bound to the native DOM object using getCustomData.

var elementA = new CKEDITOR.dom.element( nativeElement );
elementA.getPrivate().value = 1;
...
var elementB = new CKEDITOR.dom.element( nativeElement );
elementB.getPrivate().value; // 1

Returns

Object: The private object.

getSize( type, isBorderBox )

See source
Gets the element size, possibly considering the box model.

Parameters

type : 'width' | 'height'

The dimension to get.

isBorderBox : Boolean

Get the size based on the border box model.
getStyle( name ) → String

See source
Gets CSS style value.

Parameters

name : String

The CSS property name.

Returns

String

Style value.
getTabIndex() → Number
See source
Gets the computed tabindex for this element.
```
var element = CKEDITOR.document.getById( 'myDiv' );
alert( element.getTabIndex() ); // (e.g.) '-1'
```
Returns

Number

The tabindex value.
getText() → String
See source
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.
```
var element = CKEDITOR.dom.element.createFromHtml( '<div>Sample <i>text</i>.</div>' );
alert( <b>element.getText()</b> ); // 'Sample text.'
```
Returns

String

The text value.
inherited
getUniqueId() → Number

See source
Gets an ID that can be used to identify this DOM object in the running session.

Note: This method does not work on text nodes prior to Internet Explorer 9.

Returns

Number

A unique ID.
getValue() → String

See source
Gets the value set to this element. This value is usually available for form field elements.

Returns

String

The element value.
getWindow() → window

See source
Gets the window object that contains this element.

Returns

window

The window object.
inherited
hasAscendant( name, includeSelf )

See source

Parameters

name : Object

includeSelf : Object
hasAttribute( name ) → Boolean

See source
Checks if the specified attribute is defined for this element.

Parameters

name : String

The attribute name.

Returns

Boolean

true if the specified attribute is defined.

`hasAttributes() → Boolean`

See source

Checks if the element has any defined attributes.

var element = CKEDITOR.dom.element.createFromHtml( '<div title="Test">Example</div>' );
alert( element.hasAttributes() ); // true

var element = CKEDITOR.dom.element.createFromHtml( '<div>Example</div>' );
alert( element.hasAttributes() ); // false

Returns

Boolean: True if the element has attributes.

hasClass( className ) → Boolean

See source
Checks if element has class name.

Parameters

className : String

Returns

Boolean
inherited
hasListeners( eventName ) → Boolean
See source
Checks if there is any listener registered to a given event.
```
var myListener = function() { ... };
someObject.on( 'someEvent', myListener );
alert( someObject.hasListeners( 'someEvent' ) );    // true
alert( someObject.hasListeners( 'noEvent' ) );      // false
```
Parameters

eventName : String

The event name.

Returns

Boolean
inherited
hasNext() → Boolean

See source
Checks if the node is succeeded by any sibling.

Returns

Boolean
inherited
hasPrevious() → Boolean

See source
Checks if the node is preceded by any sibling.

Returns

Boolean
hide()
See source
Hides this element (sets display: none).
```
var element = CKEDITOR.document.getById( 'myElement' );
element.hide();
```
inherited
insertAfter( node ) → node
See source
Inserts this element after a node.
```
var em = new CKEDITOR.dom.element( 'em' );
var strong = new CKEDITOR.dom.element( 'strong' );
strong.insertAfter( em );

// Result: '<em></em><strong></strong>'
```
Parameters

node : node

The node that will precede this element.

Returns

node

The node preceding this one after insertion.
inherited
insertBefore( node ) → node
See source
Inserts this element before a node.
```
var em = new CKEDITOR.dom.element( 'em' );
var strong = new CKEDITOR.dom.element( 'strong' );
strong.insertBefore( em );

// result: '<strong></strong><em></em>'
```
Parameters

node : node

The node that will succeed this element.

Returns

node

The node being inserted.
inherited
insertBeforeMe( node ) → node
See source
Inserts a node before this node.
```
var em = new CKEDITOR.dom.element( 'em' );
var strong = new CKEDITOR.dom.element( 'strong' );
strong.insertBeforeMe( em );

// result: '<em></em><strong></strong>'
```
Parameters

node : node

The node that will preceed this element.

Returns

node

The node being inserted.
is( name ) → Boolean
See source
Checks if the element name matches the specified criteria.
```
var element = new CKEDITOR.element( 'span' );
alert( element.is( 'span' ) );          // true
alert( element.is( 'p', 'span' ) );     // true
alert( element.is( 'p' ) );             // false
alert( element.is( 'p', 'div' ) );      // false
alert( element.is( { p:1,span:1 } ) );  // true
```
Parameters

name : String | Object

One or more names to be checked, or a CKEDITOR.dtd object.

Returns

Boolean

true if the element name matches any of the names.
isBlockBoundary( [ customNodeNames ] ) → Boolean

See source
Checks whether an element is displayed as a block.

Parameters

[ customNodeNames ] : Object

Custom list of nodes which will extend the default CKEDITOR.dtd.$block list.

Returns

Boolean
since 4.13.0
isDetached() → Boolean

See source
Checks if an element is detached from the DOM.

Returns

Boolean

Whether an element is detached from the DOM.
isEditable( [ textCursor ] )

See source
Decide whether one element is able to receive cursor.

Parameters

[ textCursor ] : Boolean

Only consider element that could receive text child.

Defaults to true
isEmptyInlineRemoveable() → Boolean

See source
Whether it's an empty inline elements which has no visual impact when removed.

Returns

Boolean
isIdentical( otherElement ) → Boolean

See source
Compare this element's inner html, tag name, attributes, etc. with other one.

See W3C's DOM Level 3 spec - node#isEqualNode for more details.

Parameters

otherElement : element

Element to compare.

Returns

Boolean
since 3.5.0 inherited
isReadOnly( [ checkOnlyAttributes ] ) → Boolean
See source
Checks if this node is read-only (should not be changed).
```
// For the following HTML:
// <b>foo</b><div contenteditable="false"><i>bar</i></div>

elB.isReadOnly(); // -> false
foo.isReadOnly(); // -> false
elDiv.isReadOnly(); // -> true
elI.isReadOnly(); // -> true
```
This method works in two modes depending on browser support for the element.isContentEditable property and the value of the checkOnlyAttributes parameter. The element.isContentEditable check is faster, but it is known to malfunction in hidden or detached nodes. Additionally, when processing some detached DOM tree you may want to imitate that this happens inside an editable container (like it would happen inside the CKEDITOR.editable). To do so, you can temporarily attach this tree to an element with the data-cke-editable attribute and use the checkOnlyAttributes mode.

Parameters

[ checkOnlyAttributes ] : Boolean

If true, only attributes will be checked, native methods will not be used. This parameter needs to be true to check hidden or detached elements. Introduced in 4.5.0.

Defaults to false

Returns

Boolean
isVisible() → Boolean

See source
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.

Returns

Boolean

True if the element is visible.
inherited
ltrim()

See source
mergeSiblings( [ inlineOnly ] )
See source
Merges sibling elements that are identical to this one.

Identical child elements are also merged. For example:
```
<b><i></i></b><b><i></i></b> => <b><i></i></b>
```
Parameters

[ inlineOnly ] : Boolean

Allow only inline elements to be merged.

Defaults to true
inherited
move( target, toStart )

See source

Parameters

target : Object

toStart : Object
moveChildren( target, [ toStart ] )

See source
Moves this element's children to the target element.

Parameters

target : element

[ toStart ] : Boolean

Insert moved children at the beginning of the target element.

Defaults to false
inherited
on( eventName, listenerFunction, [ scopeObj ], [ listenerData ], [ priority ] ) → Object
See source
Registers a listener to a specific event in the current object.
```
someObject.on( 'someEvent', function() {
    alert( this == someObject );        // true
} );

someObject.on( 'someEvent', function() {
    alert( this == anotherObject );     // true
}, anotherObject );

someObject.on( 'someEvent', function( event ) {
    alert( event.listenerData );        // 'Example'
}, null, 'Example' );

someObject.on( 'someEvent', function() { ... } );                       // 2nd called
someObject.on( 'someEvent', function() { ... }, null, null, 100 );      // 3rd called
someObject.on( 'someEvent', function() { ... }, null, null, 1 );        // 1st called
```
Note: CKEditor's event system has a limitation that one function cannot be used as a listener for the same event more than once. Hence, to reuse it with multiple listeners, it should be wrapped into additional wrapper function:
```
function listener( evt ) { ... };

someObject.on( 'someEvent', function() {
    listener();
} );

someObject.on( 'someEvent', function( evt ) {
    listener( evt );
} );
```
Parameters

eventName : String

The event name to which listen.

listenerFunction : Function

The function listening to the event. A single CKEDITOR.eventInfo object instanced is passed to this function containing all the event data.

[ scopeObj ] : Object

The object used to scope the listener call (the this object). If omitted, the current object is used.

[ listenerData ] : Object

Data to be sent as the CKEDITOR.eventInfo.listenerData when calling the listener.

[ priority ] : Number

The listener priority. Lower priority listeners are called first. Listeners with the same priority value are called in registration order.

Defaults to 10

Returns

Object

An object containing the removeListener function, which can be used to remove the listener at any time.
inherited
once()

See source
Similiar with on but the listener will be called only once upon the next event firing.

CKEDITOR.event.on
chainable inherited
remove( [ preserveChildren ] ) → node
See source
Removes this node from the document DOM.
```
var element = CKEDITOR.document.getById( 'MyElement' );
element.remove();
```
Parameters

[ preserveChildren ] : Boolean

Indicates that the children elements must remain in the document, removing only the outer tags.

Defaults to false

Returns

node

this
inherited
removeAllListeners()

See source
Removes any listener set on this object.

To avoid memory leaks we must assure that there are no references left after the object is no longer needed.
removeAttribute( name )
See source
Removes an attribute from the element.
```
var element = CKEDITOR.dom.element.createFromHtml( '<div class="classA"></div>' );
element.removeAttribute( 'class' );
```
Parameters

name : String

The attribute name.
removeAttributes( [ attributes ] )

See source
Removes all element's attributes or just given ones.

Parameters

[ attributes ] : Array

The array with attributes names.
chainable
removeClass( className ) → element
See source
Removes a CSS class name from the elements classes. Other classes remain untouched.
```
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>
```
Parameters

className : String

The name of the class to remove.

Returns

element

this
inherited
removeCustomData( key ) → Object

See source
Removes the value in the data slot under the given key.

Parameters

key : String

Returns

Object

Removed value or null if not found.
inherited
removeListener( eventName, listenerFunction )
See source
Unregisters a listener function from being called at the specified event. No errors are thrown if the listener has not been registered previously.
```
var myListener = function() { ... };
someObject.on( 'someEvent', myListener );
someObject.fire( 'someEvent' );                 // myListener called.
someObject.removeListener( 'someEvent', myListener );
someObject.fire( 'someEvent' );                 // myListener not called.
```
Parameters

eventName : String

The event name.

listenerFunction : Function

The listener function to unregister.
removeStyle( name )
See source
Removes a style from the element.
```
var element = CKEDITOR.dom.element.createFromHtml( '<div style="display:none"></div>' );
element.removeStyle( 'display' );
```
Parameters

name : String

The style name.
renameNode( newTag )

See source
Changes the tag name of the current element.

Parameters

newTag : String

The new tag for the element.
inherited
replace( nodeToReplace )

See source

Parameters

nodeToReplace : Object
inherited
rtrim()

See source
scrollIntoParent( parent, [ alignToTop ], [ hscroll ] )

See source
Make any page element visible inside one of the ancestors by scrolling the parent.

Parameters

parent : element | window

The container to scroll into.

[ alignToTop ] : Boolean

Align the element's top side with the container's when true is specified; align the bottom with viewport bottom when false is specified. Otherwise scroll on either side with the minimum amount to show the element.

[ hscroll ] : Boolean

Whether horizontal overflow should be considered.
scrollIntoView( [ alignToTop ] )

See source
Make any page element visible inside the browser viewport.

Parameters

[ alignToTop ] : Boolean

Defaults to false
setAttribute( name, value ) → element
See source
Sets the value of an element attribute.
```
var element = CKEDITOR.document.getById( 'myElement' );
element.setAttribute( 'class', 'myClass' );
element.setAttribute( 'title', 'This is an example' );
```
Parameters

name : String

The name of the attribute.

value : String

The value to be set to the attribute.

Returns

element

This element instance.
chainable
setAttributes( attributesPairs ) → element
See source
Sets the value of several element attributes.
```
var element = CKEDITOR.document.getById( 'myElement' );
element.setAttributes( {
    'class':    'myClass',
    title:      'This is an example'
} );
```
Parameters

attributesPairs : Object

An object containing the names and values of the attributes.

Returns

element

This element instance.
chainable inherited
setCustomData( key, value ) → domObject
See source
Sets a data slot value for this object. These values are shared by all instances pointing to that same DOM object.

Note: The created data slot is only guaranteed to be available on this unique DOM node, thus any wish to continue access to it from other element clones (either created by clone node or from innerHtml) will fail. For such usage please use CKEDITOR.dom.element.setAttribute instead.

Note: This method does not work on text nodes prior to Internet Explorer 9.
```
var element = new CKEDITOR.dom.element( 'span' );
element.setCustomData( 'hasCustomData', true );
```
Parameters

key : String

A key used to identify the data slot.

value : Object

The value to set to the data slot.

Returns

domObject

This DOM object instance.
setHtml( html ) → String
See source
Sets the inner HTML of this element.
```
var p = new CKEDITOR.dom.element( 'p' );
p.setHtml( '<b>Inner</b> HTML' );

// Result: '<p><b>Inner</b> HTML</p>'
```
Parameters

html : String

The HTML to be set for this element.

Returns

String

The inserted HTML.
setOpacity( opacity )
See source
Sets the opacity of an element.
```
var element = CKEDITOR.document.getById( 'myElement' );
element.setOpacity( 0.75 );
```
Parameters

opacity : Number

A number within the range [0.0, 1.0].
setSize( type, size, isBorderBox )

See source
Sets the element size considering the box model.

Parameters

type : 'width' | 'height'

The dimension to set.

size : Number

The length unit in px.

isBorderBox : Boolean

Apply the size based on the border box model.
setState( state, [ base ], [ useAria ] )
See source
Switch the class attribute to reflect one of the triple states of an element in one of CKEDITOR.TRISTATE_ON, CKEDITOR.TRISTATE_OFF or CKEDITOR.TRISTATE_DISABLED.
```
link.setState( CKEDITOR.TRISTATE_ON );
// <a class="cke_on" aria-pressed="true">...</a>
link.setState( CKEDITOR.TRISTATE_OFF );
// <a class="cke_off">...</a>
link.setState( CKEDITOR.TRISTATE_DISABLED );
// <a class="cke_disabled" aria-disabled="true">...</a>

span.setState( CKEDITOR.TRISTATE_ON, 'cke_button' );
// <span class="cke_button_on">...</span>
```
Parameters

state : Number

Indicate the element state. One of CKEDITOR.TRISTATE_ON, CKEDITOR.TRISTATE_OFF, CKEDITOR.TRISTATE_DISABLED.

[ base ] : Object

The prefix apply to each of the state class name.

Defaults to 'cke'

[ useAria ] : Object

Whether toggle the ARIA state attributes besides of class name change.

Defaults to true
chainable
setStyle( name, value ) → element
See source
Sets the value of an element style.
```
var element = CKEDITOR.document.getById( 'myElement' );
element.setStyle( 'background-color', '#ff0000' );
element.setStyle( 'margin-top', '10px' );
element.setStyle( 'float', 'right' );
```
Parameters

name : String

The name of the style. The CSS naming notation must be used (e.g. background-color).

value : String

The value to be set to the style.

Returns

element

This element instance.
chainable
setStyles( stylesPairs ) → element
See source
Sets the value of several element styles.
```
var element = CKEDITOR.document.getById( 'myElement' );
element.setStyles( {
    position:   'absolute',
    float:      'right'
} );
```
Parameters

stylesPairs : Object

An object containing the names and values of the styles.

Returns

element

This element instance.
setText( text ) → String
See source
Sets the element contents as plain text.
```
var element = new CKEDITOR.dom.element( 'div' );
element.setText( 'A > B & C < D' );
alert( element.innerHTML ); // 'A &gt; B &amp; C &lt; D'
```
Parameters

text : String

The text to be set.

Returns

String

The inserted text.
chainable
setValue( value ) → element

See source
Sets the element value. This function is usually used with form field element.

Parameters

value : String

The element value.

Returns

element

This element instance.
show()
See source
Shows this element (displays it).
```
var element = CKEDITOR.document.getById( 'myElement' );
element.show();
```
inherited
trim()

See source
unselectable()
See source
Makes the element and its children unselectable.
```
var element = CKEDITOR.document.getById( 'myElement' );
element.unselectable();
```

Static methods

static
clearAllMarkers( database )

See source
Removes all markers added using this database. See the setMarker method for more information.

Parameters

database : Object

static
`clearMarkers( database )`

See source

Removes all markers added to this element and removes it from the database if removeFromDatabase was passed. See the setMarker method for more information.

var database = {};
CKEDITOR.dom.element.setMarker( database, element1, 'foo', 'bar' );
CKEDITOR.dom.element.setMarker( database, element2, 'oof', [ 1, 2, 3 ] );

element1.getCustomData( 'foo' ); // 'bar'
element2.getCustomData( 'oof' ); // [ 1, 2, 3 ]

CKEDITOR.dom.element.clearMarkers( database, element1, true );

element1.getCustomData( 'foo' ); // null
element2.getCustomData( 'oof' ); // [ 1, 2, 3 ]

Parameters

database : Object

static
createFromHtml( html ) → element
See source
Creates an instance of the CKEDITOR.dom.element class based on the HTML representation of an element.
```
var element = CKEDITOR.dom.element.createFromHtml( '<strong class="anyclass">My element</strong>' );
alert( element.getName() ); // 'strong'
```
Parameters

html : String

The element HTML. It should define only one element in the "root" level. The "root" element can have child nodes, but not siblings.

Returns

element

The element instance.
static
get( element ) → element
See source
The the 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.
```
var element = new CKEDITOR.dom.element( 'span' );
alert( element == CKEDITOR.dom.element.get( element ) ); // true

var element = document.getElementById( 'myElement' );
alert( CKEDITOR.dom.element.get( element ).getName() ); // (e.g.) 'p'
```
Parameters

element : String | Object

Element's id or name or native DOM element.

Returns

element

The transformed element.
mixed static
implementOn( targetObject )
See source
Implements the CKEDITOR.event features in an object.
```
var myObject = { message: 'Example' };
CKEDITOR.event.implementOn( myObject );

myObject.on( 'testEvent', function() {
    alert( this.message );
} );
myObject.fire( 'testEvent' ); // 'Example'
```
Parameters

targetObject : Object

The object into which implement the features.
static
setMarker( database, element, name, value ) → element
See source
Sets custom data on an element in a way that it is later possible to clear all data set on all elements sharing the same database.

This mechanism is very useful when processing some portion of DOM. All markers can later be removed by calling the clearAllMarkers method, hence markers will not leak to second pass of this algorithm.
```
var database = {};
CKEDITOR.dom.element.setMarker( database, element1, 'foo', 'bar' );
CKEDITOR.dom.element.setMarker( database, element2, 'oof', [ 1, 2, 3 ] );

element1.getCustomData( 'foo' ); // 'bar'
element2.getCustomData( 'oof' ); // [ 1, 2, 3 ]

CKEDITOR.dom.element.clearAllMarkers( database );

element1.getCustomData( 'foo' ); // null
```
Parameters

database : Object

element : element

name : String

value : Object

Returns

element

The element.

CKEDITOR.dom.element

Filtering

Properties

readonly inherited $ : ObjectCKEDITOR.dom.element#s-

readonly type : NumberCKEDITOR.dom.element#type

Static properties

mixed static useCapture : BooleanCKEDITOR.dom.element#useCapture

Methods

inherited constructor( nativeDomObject ) → domObjectCKEDITOR.dom.element#constructor

Parameters

Returns

chainable addClass( className ) → elementCKEDITOR.dom.element#addClass

Parameters

Returns

append( node, [ toStart ] ) → nodeCKEDITOR.dom.element#append

Parameters

Returns

appendBogus( [ force ] )CKEDITOR.dom.element#appendBogus

Parameters

appendHtml( html )CKEDITOR.dom.element#appendHtml

Parameters

appendText( text )CKEDITOR.dom.element#appendText

Parameters

inherited appendTo( element ) → elementCKEDITOR.dom.element#appendTo

Parameters

Returns

breakParent( parent, [ cloneId ] )CKEDITOR.dom.element#breakParent

Parameters

inherited capture()CKEDITOR.dom.element#capture

inherited clearCustomData()CKEDITOR.dom.element#clearCustomData

inherited clone( [ includeChildren ], [ cloneId ] ) → nodeCKEDITOR.dom.element#clone

Parameters

Returns

contains( node ) → BooleanCKEDITOR.dom.element#contains

Parameters

Returns

copyAttributes( dest, skipAttributes )CKEDITOR.dom.element#copyAttributes

Parameters

data( name, [ value ] )CKEDITOR.dom.element#data

Parameters

inherited define( name, meta )CKEDITOR.dom.element#define

Parameters

disableContextMenu()CKEDITOR.dom.element#disableContextMenu

inherited equals( object ) → BooleanCKEDITOR.dom.element#equals

Parameters

Returns

since 4.3.0 find( selector ) → nodeListCKEDITOR.dom.element#find

Parameters

Returns

since 4.3.0 findOne( selector ) → elementCKEDITOR.dom.element#findOne

Parameters

Returns

inherited fire( eventName, [ data ], [ editor ] ) → Boolean | ObjectCKEDITOR.dom.element#fire

Parameters

Returns

since 4.13.0 fireEventHandler( element, eventName, evt )CKEDITOR.dom.element#fireEventHandler

Parameters

inherited fireOnce( eventName, [ data ], [ editor ] ) → Boolean | ObjectCKEDITOR.dom.element#fireOnce

Parameters

Returns

focus( defer )CKEDITOR.dom.element#focus

Parameters

focusNext( [ ignoreChildren ], [ indexToUse ] )CKEDITOR.dom.element#focusNext

Parameters

focusPrevious( [ ignoreChildren ], [ indexToUse ] )CKEDITOR.dom.element#focusPrevious

Parameters

since 4.3.0 forEach( callback, [ type ], [ skipRoot ] )CKEDITOR.dom.element#forEach

Parameters

inherited getAddress( [ normalized ] ) → ArrayCKEDITOR.dom.element#getAddress

Parameters

Returns

since 3.6.1 inherited getAscendant( query, [ includeSelf ] ) → nodeCKEDITOR.dom.element#getAscendant

Parameters

Returns

getAttribute( name ) → StringCKEDITOR.dom.element#getAttribute

Parameters

Returns

getAttributes( exclude ) → ObjectCKEDITOR.dom.element#getAttributes

Parameters

Returns

readonly inherited
`$ : Object`

readonly
`type : Number`

mixed static
`useCapture : Boolean`

inherited
`constructor( nativeDomObject ) → domObject`

chainable
`addClass( className ) → element`

`append( node, [ toStart ] ) → node`

`appendBogus( [ force ] )`

`appendHtml( html )`

`appendText( text )`

inherited
`appendTo( element ) → element`

`breakParent( parent, [ cloneId ] )`

inherited
`capture()`

inherited
`clearCustomData()`

inherited
`clone( [ includeChildren ], [ cloneId ] ) → node`

`contains( node ) → Boolean`

`copyAttributes( dest, skipAttributes )`

`data( name, [ value ] )`

inherited
`define( name, meta )`

`disableContextMenu()`

inherited
`equals( object ) → Boolean`

since 4.3.0
`find( selector ) → nodeList`

since 4.3.0
`findOne( selector ) → element`

inherited
`fire( eventName, [ data ], [ editor ] ) → Boolean | Object`

since 4.13.0
`fireEventHandler( element, eventName, evt )`

inherited
`fireOnce( eventName, [ data ], [ editor ] ) → Boolean | Object`

`focus( defer )`

`focusNext( [ ignoreChildren ], [ indexToUse ] )`

`focusPrevious( [ ignoreChildren ], [ indexToUse ] )`

since 4.3.0
`forEach( callback, [ type ], [ skipRoot ] )`

inherited
`getAddress( [ normalized ] ) → Array`

since 3.6.1 inherited
`getAscendant( query, [ includeSelf ] ) → node`

`getAttribute( name ) → String`

`getAttributes( exclude ) → Object`

`getBogus() → node | Boolean`

`getChild( indices ) → node`

`getChildCount() → Number`

`getChildren() → nodeList`

`getClientRect( [ isAbsolute ] ) → rect`

since 4.13.0
`getClientSize() → Object`

inherited
`getCommonAncestor( node )`

`getComputedStyle( propertyName ) → String`

inherited
`getCustomData( key ) → Object`

`getDirection( useComputed )`

inherited
`getDocument() → document`

`getDocumentPosition( [ refDocument ] ) → Object`

`getDtd() → Object`

`getEditor( [ optimized ] ) → editor`

`getElementsByTag( tagName )`

`getFirst( evaluator ) → node`

`getFrameDocument() → document`

`getHtml() → String`

`getId() → String`

inherited
`getIndex( normalized ) → Number`

`getLast( evaluator ) → node`

`getName() → String`

`getNameAtt() → String`

inherited
`getNext( [ evaluator ] ) → node`

inherited
`getNextSourceNode( startFromSibling, nodeType, guard )`

`getOuterHtml() → String`

inherited
`getParent( [ allowFragmentParent ] ) → element`

inherited
`getParents( [ closerFirst ] ) → Array`

inherited
`getPosition( otherNode ) → Number`