Class CKFinder.dom.domObject

Extends CKFinder.event.

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

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

Method Summary
Method Attributes	Method Name and Description
	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.
	setCustomData(key, value) Sets a data slot value for this object.

Class Detail

CKFinder.dom.domObject(nativeDomObject)

Since: 2.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: 2.0

The native DOM object represented by this class instance.

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

Method Detail

{Boolean} equals(object)

Since: 2.0

Determines whether the specified object is equal to the current object.

var doc = new CKFinder.dom.document( document );
alert( doc.equals( CKFinder.document ) );  // "true"
alert( doc == CKFinder.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: 2.0

Gets the value set to a data slot in this object.

var element = new CKFinder.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:: CKFinder.dom.domObject.prototype.setCustomData

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

Since: 2.0

Sets a data slot value for this object. These values are shared by all instances pointing to that same DOM object.

var element = new CKFinder.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:: {CKFinder.dom.domObject} This DOM object instance.

See:: CKFinder.dom.domObject.prototype.getCustomData

CKFinder 2 JavaScript API Documentation

Namespaces

Classes

Class CKFinder.dom.domObject