CharacterData

Module: JavaScript DOM API

#include <CharacterData.idl>

Inherits from Node, EventTarget

Inherited by Comment, Text

Public Functions

Name
DOMStringsubstringData(unsigned long offset, unsigned long count)
voidappendData(DOMString data)
voidinsertData(unsigned long offset, DOMString data)
voiddeleteData(unsigned long offset, unsigned long count)
voidreplaceData(unsigned long offset, unsigned long count, DOMString data)
voidremove()
Removes node Note: This should be part of the ChildNode interface.

Public Attributes

Name
attribute DOMStringdata
readonly attribute unsigned longlength
readonly attribute ElementpreviousElementSibling
Returns the Element immediately prior to this node in its parent’s children list, or null if there is no Element in the list prior to this node. Note: This attribute is part of the NonDocumentTypeChildNode interface, which CharacterData implements.
readonly attribute ElementnextElementSibling
Returns the Element immediately following this node in its parent’s children list, or null if there is no Element in the list following this node. Note: This attribute is part of the NonDocumentTypeChildNode interface, which CharacterData implements.

Additional inherited members

Public Functions inherited from Node

Name
NoderemoveChild(Node oldChild)
remove a child node
NodeappendChild(Node newChild)
append a node as a child
voidappend((Node or DOMString)… newChildren)
append nodes and string objects as children, where the string objects are inserted as equivalent Text nodes
NodereplaceChild(Node newChild, Node oldChild)
replace oldChild with newChild
NodeinsertBefore(Node node, Node? referenceNode)
insert a node before the reference node, as a child of the current node
NodecloneNode(optional boolean deep =false)
booleanisEqualNode(Node? otherNode)
booleanisSameNode(Node? otherNode)
booleanhasChildNodes()
booleancontains(Node? other)
DOMStringlookupPrefix(DOMString? namespace)
booleanisDefaultNamespace(DOMString? namespace)
voidnormalize()
unsigned shortcompareDocumentPosition(Node other)
NodegetRootNode(optional GetRootNodeOptions options)
DOMStringlookupNamespaceURI(DOMString? prefix)

Public Attributes inherited from Node

Name
const unsigned shortELEMENT_NODE
const unsigned shortATTRIBUTE_NODE
const unsigned shortTEXT_NODE
const unsigned shortCDATA_SECTION_NODE
const unsigned shortENTITY_REFERENCE_NODE
const unsigned shortENTITY_NODE
const unsigned shortPROCESSING_INSTRUCTION_NODE
const unsigned shortCOMMENT_NODE
const unsigned shortDOCUMENT_NODE
const unsigned shortDOCUMENT_TYPE_NODE
const unsigned shortDOCUMENT_FRAGMENT_NODE
const unsigned shortNOTATION_NODE
const unsigned shortDOCUMENT_POSITION_DISCONNECTED
const unsigned shortDOCUMENT_POSITION_PRECEDING
const unsigned shortDOCUMENT_POSITION_FOLLOWING
const unsigned shortDOCUMENT_POSITION_CONTAINS
const unsigned shortDOCUMENT_POSITION_CONTAINED_BY
const unsigned shortDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonly attribute DOMStringnodeName
attribute DOMStringnodeValue
attribute DOMStringtextContent
readonly attribute unsigned shortnodeType
type of the node
readonly attribute NodeparentNode
parent of the node
readonly attribute ElementparentElement
parent element of the node. If parent is not an Element, returns null.
readonly attribute NodeListchildNodes
list of the children of this node
readonly attribute NodefirstChild
the node’s first child in the tree, or null if the node is childless
readonly attribute NodelastChild
last child of the node, or null if there are no child elements
readonly attribute NodepreviousSibling
the node immediately preceding the specified one in its parent’s children, or null if the specified node is the first in that list
readonly attribute NodenextSibling
the node immediately following the specified one in its parent’s children, or null if the specified node is the last node in that list
readonly attribute DocumentownerDocument
The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
readonly attribute USVStringbaseURI
readonly attribute booleanisConnected

Public Functions inherited from EventTarget

Name
voidaddEventListener(DOMInternedString type, EventListener listener, optional boolean useCapture)
voidremoveEventListener(DOMInternedString type, EventListener listener, optional boolean useCapture)
booleandispatchEvent(Event event)

Public Functions Documentation

function substringData

DOMString substringData(
    unsigned long offset,
    unsigned long count
)

function appendData

void appendData(
    DOMString data
)

function insertData

void insertData(
    unsigned long offset,
    DOMString data
)

function deleteData

void deleteData(
    unsigned long offset,
    unsigned long count
)

function replaceData

void replaceData(
    unsigned long offset,
    unsigned long count,
    DOMString data
)

function remove

void remove()

Removes node Note: This should be part of the ChildNode interface.

Public Attributes Documentation

variable data

attribute DOMString data;

variable length

readonly attribute unsigned long length;

variable previousElementSibling

readonly attribute Element previousElementSibling;

Returns the Element immediately prior to this node in its parent’s children list, or null if there is no Element in the list prior to this node. Note: This attribute is part of the NonDocumentTypeChildNode interface, which CharacterData implements.

variable nextElementSibling

readonly attribute Element nextElementSibling;

Returns the Element immediately following this node in its parent’s children list, or null if there is no Element in the list following this node. Note: This attribute is part of the NonDocumentTypeChildNode interface, which CharacterData implements.