2005/5/9

org::w3c::dom::CharacterData Class Reference

Inheritance diagram for org::w3c::dom::CharacterData:

Detailed Description

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 offsets in this interface start from 0.

As explained in the DOMString interface, text strings in the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In the following, the term 16-bit units is used whenever necessary to indicate that indexing on CharacterData is done in 16-bit units.

See also the Document acdk::lang::Object Model (DOM) Level 3 Core Specification.

API: org.w3c.dom<br>

Author:

Roger Rene Kommer

Version:

Revision

1.10

Date:

Date

2005/02/05 10:45:37

Public Member Functions
virtual RString	getData ()=0 throw ( RDOMException )
	The character data of the node that implements this interface.
virtual void	setData (IN(RString) s)=0 throw ( RDOMException )
	The character data of the node that implements this interface.
virtual int	getLength ()=0
	The number of 16-bit units that are available through data and the substringData method below.
virtual RString	subStringData (int i, int j)=0 throw ( RDOMException )
	Extracts a range of data from the node.
virtual void	appendData (IN(RString) s)=0 throw ( RDOMException )
	Append the string to the end of the character data of the node.
virtual void	insertData (int i, IN(RString) s)=0 throw ( RDOMException )
	Insert a string at the specified 16-bit unit offset.
virtual void	deleteData (int i, int j)=0 throw ( RDOMException )
	Remove a range of 16-bit units from the node.
virtual void	replaceData (int i, int j, IN(RString) s)=0 throw ( RDOMException )
	Replace the characters starting at the specified 16-bit unit offset with the specified string.

Member Function Documentation

virtual void org::w3c::dom::CharacterData::appendData (  IN(RString)  s  )  throw ( RDOMException ) [pure virtual]

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. Exceptions: DOMException  NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. Implemented in acdk::xml::dom::XMLCharacterData, and acdk::xml::libxmldom::LibXMLCharacterData.

virtual void org::w3c::dom::CharacterData::deleteData (  int  i, int  j )  throw ( RDOMException ) [pure virtual]

Remove a range of 16-bit units from the node. Upon success, data and length reflect the change. Parameters: offset  The offset from which to start removing. count  The number of 16-bit units to delete. If the sum of offset and count exceeds length then all 16-bit units from offset to the end of the data are deleted. Exceptions: DOMException  INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. Implemented in acdk::xml::dom::XMLCharacterData, and acdk::xml::libxmldom::LibXMLCharacterData.

virtual RString org::w3c::dom::CharacterData::getData (   )  throw ( RDOMException ) [pure virtual]

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. Exceptions: DOMException  DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform. Implemented in acdk::xml::dom::XMLCharacterData, and acdk::xml::libxmldom::LibXMLCharacterData.

virtual int org::w3c::dom::CharacterData::getLength (   )  [pure virtual]

The number of 16-bit units that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty. Implemented in acdk::xml::dom::XMLCharacterData, and acdk::xml::libxmldom::LibXMLCharacterData.

virtual void org::w3c::dom::CharacterData::insertData (  int  i, IN(RString)  s )  throw ( RDOMException ) [pure virtual]

Insert a string at the specified 16-bit unit offset. Parameters: offset  The character offset at which to insert. arg  The DOMString to insert. Exceptions: DOMException  INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. Implemented in acdk::xml::dom::XMLCharacterData, and acdk::xml::libxmldom::LibXMLCharacterData.

virtual void org::w3c::dom::CharacterData::replaceData (  int  i, int  j, IN(RString)  s )  throw ( RDOMException ) [pure virtual]

Replace the characters starting at the specified 16-bit unit offset with the specified string. Parameters: offset  The offset from which to start replacing. count  The number of 16-bit units to replace. If the sum of offset and count exceeds length, then all 16-bit units 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. Exceptions: DOMException  INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. Implemented in acdk::xml::dom::XMLCharacterData, and acdk::xml::libxmldom::LibXMLCharacterData.

virtual void org::w3c::dom::CharacterData::setData (  IN(RString)  s  )  throw ( RDOMException ) [pure virtual]

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. Exceptions: DOMException  NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. Implemented in acdk::xml::dom::XMLCharacterData, and acdk::xml::libxmldom::LibXMLCharacterData.

virtual RString org::w3c::dom::CharacterData::subStringData (  int  i, int  j )  throw ( RDOMException ) [pure virtual]

Extracts a range of data from the node. Parameters: offset  Start offset of substring to extract. count  The number of 16-bit units to extract. Returns: The specified substring. If the sum of offset and count exceeds the length, then all 16-bit units to the end of the data are returned. Exceptions: DOMException  INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative. DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString. Implemented in acdk::xml::dom::XMLCharacterData, and acdk::xml::libxmldom::LibXMLCharacterData.