class CharacterData

# class CharacterData | The `CharacterData` interface extends Node with a set of attributes and methods for accessing character data in the DOM. More...
Full name | `DOM::CharacterData`
Definition | `#include <dom_text.h>`
Inherits | DOM::Node [public ]
Inherited by | CDATASection, Comment, Text
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- CharacterData ()
- CharacterData (const CharacterData &other)
- CharacterData (const Node &other)
- CharacterData & operator = (const Node &other)
- CharacterData & operator = (const CharacterData &other)
- ~CharacterData ()
- DOMString data () const
- void setData ( const DOMString & )
- unsigned long length () const
- DOMString substringData ( const unsigned long offset, const unsigned long count )
- void appendData ( const DOMString &arg )
- void insertData ( const unsigned long offset, const DOMString &arg )
- void deleteData ( const unsigned long offset, const unsigned long count )
- void replaceData ( const unsigned long offset, const unsigned long count, const DOMString &arg )

#### Protected Methods

- CharacterData (CharacterDataImpl *i)

## Detailed Description

The `CharacterData` interface extends Node with a set of attributes and methods for accessing character data in the DOM. For clarity this set is defined here rather than on each object that uses these attributes and methods. No DOM objects correspond directly to `CharacterData` , though `Text` and others do inherit the interface from it. All `offset`s in this interface start from 0.

CharacterData () | ### CharacterData

CharacterData (const CharacterData &other) | ### CharacterData

CharacterData (const Node &other) | ### CharacterData

CharacterData & operator = (const Node &other) | ### operator =

Reimplemented from Node.

CharacterData & operator = (const CharacterData &other) | ### operator =

Reimplemented from Node.

~CharacterData () | ### ~CharacterData

DOMString data () | ### data

[const]

The character data of the node that implements this interface. The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a `CharacterData` node. However, implementation limits may mean that the entirety of a node's data may not fit into a single `DOMString` . In such cases, the user may call `substringData` to retrieve the data in appropriately sized pieces.

Throws: DOMException, DOMSTRING_SIZE_ERR:, Raised, when, it, would, return, more, characters, than, fit, in, a, `, DOMString,` , variable, on, the, implementation, platform.

void setData ( const DOMString & ) | ### setData

see data

Throws: DOMException, NO_MODIFICATION_ALLOWED_ERR:, Raised, when, the, node, is, readonly.

unsigned long length () | ### length

[const]

The number of characters that are available through `data` and the `substringData` method below. This may have the value zero, i.e., `CharacterData` nodes may be empty.

DOMString substringData ( const unsigned long offset, const unsigned long count ) | ### substringData

Extracts a range of data from the node.

DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a `DOMString` .

Parameters:

offset | Start offset of substring to extract.
count | The number of characters to extract.

Returns: The specified substring. If the sum of `offset` and `count` exceeds the `length` , then all characters to the end of the data are returned.

Throws: DOMException, INDEX_SIZE_ERR:, Raised, if, the, specified, offset, is, negative, or, greater, than, the, number, of, characters, in, `, data,` , or, if, the, specified, `, count,` , is, negative.

void appendData ( const DOMString &arg ) | ### appendData

Append the string to the end of the character data of the node. Upon success, `data` provides access to the concatenation of `data` and the `DOMString` specified.

Parameters:

arg | The `DOMString` to append.

Throws: DOMException, NO_MODIFICATION_ALLOWED_ERR:, Raised, if, this, node, is, readonly.

void insertData ( const unsigned long offset, const DOMString &arg ) | ### insertData

Insert a string at the specified character offset.

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Parameters:

offset | The character offset at which to insert.
arg | The `DOMString` to insert.

Throws: DOMException, INDEX_SIZE_ERR:, Raised, if, the, specified, offset, is, negative, or, greater, than, the, number, of, characters, in, `, data,` , .

void deleteData ( const unsigned long offset, const unsigned long count ) | ### deleteData

Remove a range of characters from the node. Upon success, `data` and `length` reflect the change.

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Parameters:

offset | The offset from which to remove characters.
count | The number of characters to delete. If the sum of `offset` and `count` exceeds `length` then all characters from `offset` to the end of the data are deleted.

Throws: DOMException, INDEX_SIZE_ERR:, Raised, if, the, specified, offset, is, negative, or, greater, than, the, number, of, characters, in, `, data,` , or, if, the, specified, `, count,` , is, negative.

void replaceData ( const unsigned long offset, const unsigned long count, const DOMString &arg ) | ### replaceData

Replace the characters starting at the specified character offset with the specified string.

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Parameters:

offset | The offset from which to start replacing.
count | The number of characters to replace. If the sum of `offset` and `count` exceeds `length` , then all characters to the end of the data are replaced (i.e., the effect is the same as a `remove` method call with the same range, followed by an `append` method invocation).
arg | The `DOMString` with which the range must be replaced.

Throws: DOMException, INDEX_SIZE_ERR:, Raised, if, the, specified, offset, is, negative, or, greater, than, the, number, of, characters, in, `, data,` , or, if, the, specified, `, count,` , is, negative.

CharacterData (CharacterDataImpl *i) | ### CharacterData

[protected]

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:37:43 2003, using kdoc 2.0a54.