Main Page   Class Hierarchy   Compound List   File List   Compound Members  

IDOM_Text Class Reference

Inheritance diagram for IDOM_Text:

IDOM_CharacterData IDOM_Node IDOM_CDATASection List of all members.

Public Methods

Destructor.
virtual ~IDOM_Text ()
Functions to modify the Text node.
virtual IDOM_Text * splitText (unsigned int offset)=0
Non-standard (not defined by the DOM specification) functions.
virtual bool isIgnorableWhitespace () const=0

Protected Methods

Constructors and assignment operator
 IDOM_Text (const IDOM_Text &other)
IDOM_Text & operator= (const IDOM_Text &other)

Detailed Description

The Text interface represents the textual content (termed character data in XML) of an Element or Attr. If there is no markup inside an element's content, the text is contained in a single object implementing the Text interface that is the only child of the element. If there is markup, it is parsed into a list of elements and Text nodes that form the list of children of the element.

When a document is first made available via the DOM, there is only one Text node for each block of text. Users may create adjacent Text nodes that represent the contents of a given element without any intervening markup, but should be aware that there is no way to represent the separations between these nodes in XML, so they will not (in general) persist between DOM editing sessions. The normalize() method on Element merges any such adjacent Text objects into a single node for each block of text; this is recommended before employing operations that depend on a particular document structure, such as navigation with XPointers.


Constructor & Destructor Documentation

virtual IDOM_Text::~IDOM_Text   [inline, virtual]
 

Destructor for IDOM_Text. The object being destroyed is the reference object, not the underlying Comment node itself.


Member Function Documentation

virtual bool IDOM_Text::isIgnorableWhitespace   const [pure virtual]
 

Return true if this node contains ignorable whitespaces only.

Returns:
True if this node contains ignorable whitespaces only.

virtual IDOM_Text* IDOM_Text::splitText unsigned int    offset [pure virtual]
 

Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings.

This node then only contains all the content up to the offset point. And a new node of the same nodeType, which is inserted as the next sibling of this node, contains all the content at and after the offset point. When the offset is equal to the lenght of this node, the new node has no data.

Parameters:
offset The offset at which to split, starting from 0.
Returns:
The new Text node.
Exceptions:
DOMException INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.


The documentation for this class was generated from the following file:
Generated on Tue Nov 19 09:36:43 2002 by doxygen1.3-rc1