gnu.xml.dom

Class DomText

Implemented Interfaces:
CharacterData, Cloneable, Comparable<T>, DocumentEvent, EventTarget, Node, NodeList, Text
Known Direct Subclasses:
DomCDATASection

public class DomText
extends DomCharacterData
implements Text

"Text" implementation.

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

DomText(DomDocument owner, char[] buf, int off, int len)
DomText(DomDocument owner, String value)
Constructs a text node associated with the specified document and holding the specified data.

Method Summary

String
getNodeName()
DOM L1 Returns the string "#text".
String
getWholeText()
Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
boolean
isElementContentWhitespace()
Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace".
Text
replaceWholeText(String content)
Replaces the text of the current node and all logically-adjacent text nodes with the specified text.
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, getBaseURI, getChildNodes, getData, getLength, getNodeValue, insertData, replaceData, setData, setNodeValue, substringData

Methods inherited from class gnu.xml.dom.DomNode

addEventListener, appendChild, clone, cloneNode, compact, compareDocumentPosition, compareTo, createEvent, dispatchEvent, getAttributes, getBaseURI, getChildNodes, getElementsByTagName, getElementsByTagNameNS, getFeature, getFirstChild, getLastChild, getLength, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isReadonly, isSameNode, isSupported, item, list, lookupNamespaceURI, lookupPrefix, makeReadonly, nameAndTypeEquals, normalize, removeChild, removeEventListener, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData, toString, trimToSize

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DomText

protected DomText(DomDocument owner,
                  char[] buf,
                  int off,
                  int len)

DomText

protected DomText(DomDocument owner,
                  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 Details

getNodeName

public String getNodeName()
DOM L1 Returns the string "#text".
Specified by:
getNodeName in interface Node
Overrides:
getNodeName in interface DomNode

getWholeText

public String getWholeText()
Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
For instance, in the example below wholeText on the Text node that contains "bar" returns "barfoo", while on the Text node that contains "foo" it returns "barfoo".
Specified by:
getWholeText in interface Text
Since:
DOM Level 3

isElementContentWhitespace

public boolean isElementContentWhitespace()
Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace". The text node is determined to contain whitespace in element content during the load of the document or if validation occurs while using Document.normalizeDocument().
Specified by:
isElementContentWhitespace in interface Text
Since:
DOM Level 3

replaceWholeText

public Text replaceWholeText(String content)
            throws DOMException
Replaces the text of the current node and all logically-adjacent text nodes with the specified text. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text.
This method returns the node which received the replacement text. The returned node is:
  • null, when the replacement text is the empty string;
  • the current node, except when the current node is read-only;
  • a new Text node of the same type ( Text or CDATASection) as the current node inserted at the location of the replacement.

For instance, in the above example calling replaceWholeText on the Text node that contains "bar" with "yo" in argument results in the following:
Where the nodes to be removed are read-only descendants of an EntityReference, the EntityReference must be removed instead of the read-only nodes. If any EntityReference to be removed has descendants that are not EntityReference, Text, or CDATASection nodes, the replaceWholeText method must fail before performing any modification of the document, raising a DOMException with the code NO_MODIFICATION_ALLOWED_ERR.
For instance, in the example below calling replaceWholeText on the Text node that contains "bar" fails, because the EntityReference node "ent" contains an Element node which cannot be removed.
Specified by:
replaceWholeText in interface Text
Parameters:
content - The content of the replacing Text node.
Returns:
The Text node created with the specified content.
Throws:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text nodes being replaced is readonly.
Since:
DOM Level 3

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

DomText.java -- Copyright (C) 1999, 2000, 2001, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.