Class CKEDITOR.dom.domObject

Extends CKEDITOR.event.
Defined in: core/dom/domobject.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.dom.domObject(nativeDomObject) Represents a DOM object.

Field Summary
Field Attributes	Field Name and Description
	$ The native DOM object represented by this class instance.
	removeCustomData

Method Summary
Method Attributes	Method Name and Description
	clearCustomData() Removes any data stored on this object.
	equals(object) Determines whether the specified object is equal to the current object.
	getCustomData(key) Gets the value set to a data slot in this object.
	getPrivate()
	getUniqueId() Gets an ID that can be used to identiquely identify this DOM object in the running session.
	removeAllListeners() Removes any listener set on this object.
	setCustomData(key, value) Sets a data slot value for this object.

Methods borrowed from class CKEDITOR.event:: fire, fireOnce, hasListeners, on, removeListener

Class Detail

CKEDITOR.dom.domObject(nativeDomObject)

Since: 3.0

Represents a DOM object. This class is not intended to be used directly. It serves as the base class for other classes representing specific DOM objects.

Parameters:
{Object} nativeDomObject: A native DOM object.

Field Detail

{Object} $

Since: 3.0

The native DOM object represented by this class instance.

var element = new CKEDITOR.dom.element( 'span' );
alert( element.$.nodeType );  // "1"

{Undefined} removeCustomData

Since: 3.0

NO EXAMPLE AVAILABLE

Method Detail

{Undefined} clearCustomData()

Since: 3.0

Removes any data stored on this object. To avoid memory leaks we must assure that there are no references left after the object is no longer needed.

NO EXAMPLE AVAILABLE

{Boolean} equals(object)

Since: 3.0

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.

{Object} getCustomData(key)

Since: 3.0

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'

Parameters:
{String} key: The key used to identify the data slot.

Returns:: {Object} This value set to the data slot.

See:: CKEDITOR.dom.domObject.prototype.setCustomData

{Undefined} getPrivate()

Since: 3.0

NO EXAMPLE AVAILABLE

{Number} getUniqueId()

Since: 3.0

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

NO EXAMPLE AVAILABLE

Returns:: {Number} A unique ID.

{Undefined} removeAllListeners()

Since: 3.0

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.

NO EXAMPLE AVAILABLE

{CKEDITOR.dom.domObject} setCustomData(key, value)

Since: 3.0

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 guarantied to be available on this unique dom node, thus any wish to continue access 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.

var element = new CKEDITOR.dom.element( 'span' );
element.setCustomData( 'hasCustomData', true );

Parameters:
{String} key: A key used to identify the data slot.
{Object} value: The value to set to the data slot.

Returns:: {CKEDITOR.dom.domObject} This DOM object instance.

See:: CKEDITOR.dom.domObject.prototype.getCustomData

CKEditor 3 JavaScript API Documentation

Namespaces

Classes

Class CKEDITOR.dom.domObject