gnu.xml.dom
Class DomText

java.lang.Object
  |
  +--gnu.xml.dom.DomNode
        |
        +--gnu.xml.dom.DomCharacterData
              |
              +--gnu.xml.dom.DomText

All Implemented Interfaces:

CharacterData, java.lang.Cloneable, org.w3c.dom.events.DocumentEvent, org.w3c.dom.events.EventTarget, Node, NodeList, Text

Direct Known Subclasses:

DomCDATA

public class DomText

extends DomCharacterData

implements Text

"Text" implementation.

Version:

$Date: 2001/06/20 21:30:05 $

Author:

David Brownell

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

protected

DomText(Document owner, java.lang.String value) Constructs a text node associated with the specified document and holding the specified data.

Method Summary

java.lang.String	getNodeName() DOM L1 Returns the string "#text".
boolean	isIgnorable() Returns the flag recording whether the text contains "ignorable whitespace".
void	setIgnorable(boolean value) Sets a flag which may be used to record whether the text contains "ignorable whitespace", which can be discarded by most applications.
Text	splitText(int offset) DOM L1 Splits this text node in two parts at the offset, returning the new text node (the sibling with the second part).

Methods inherited from class gnu.xml.dom.DomCharacterData

appendData, deleteData, getChildNodes, getData, getLength, getNodeValue, insertData, replaceData, setData, setNodeValue, substringData

Methods inherited from class gnu.xml.dom.DomNode

addEventListener, appendChild, clone, cloneNode, createEvent, dispatchEvent, getAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeType, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isReadonly, isSupported, item, makeReadonly, nameAndTypeEquals, normalize, removeChild, removeEventListener, replaceChild, setPrefix, trimToSize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.w3c.dom.CharacterData

appendData, deleteData, getData, getLength, insertData, replaceData, setData, substringData

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Constructor Detail

DomText

protected DomText(Document owner,
                  java.lang.String value)

Constructs a text node associated with the specified document and holding the specified data.

This constructor should only be invoked by a Document object as part of its createTextNode functionality, or through a subclass which is similarly used in a "Sub-DOM" style layer.

Method Detail

getNodeName

public java.lang.String getNodeName()

DOM L1 Returns the string "#text".

Specified by:

getNodeName in interface Node

splitText

public Text splitText(int offset)

DOM L1 Splits this text node in two parts at the offset, returning the new text node (the sibling with the second part).

Specified by:

splitText in interface Text

Following copied from interface: org.w3c.dom.Text

Parameters:

offsetThe - 16-bit unit offset at which to split, starting from 0.

Returns:

The new node, of the same type as this node.

Throws:

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.

setIgnorable

public final void setIgnorable(boolean value)

Sets a flag which may be used to record whether the text contains "ignorable whitespace", which can be discarded by most applications.

The XML specification requires that validating processors report which whitespace separates elements with "children" content models, and so is "ignorable" (not part of character data). In Java, most parsers, not just validating ones, make this information available through SAX callbacks.

Where possible, configure your DOM construction code to discard ignorable whitespace reported to it by a parser, rather than trying to save it in any way. This will reduce your memory consumption, simplifies many algorithms, and will provide various savings in execution time as well.

isIgnorable

public final boolean isIgnorable()

Returns the flag recording whether the text contains "ignorable whitespace".