org.w3c.dom
Interface Text

All Superinterfaces:
CharacterData sample code for org.w3c.dom.CharacterData definition code for org.w3c.dom.CharacterData , Node sample code for org.w3c.dom.Node definition code for org.w3c.dom.Node
All Known Subinterfaces:
CDATASection sample code for org.w3c.dom.CDATASection definition code for org.w3c.dom.CDATASection

public interface Text
extends CharacterData sample code for org.w3c.dom.CharacterData definition code for org.w3c.dom.CharacterData

The Text interface inherits from CharacterData and 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 the information items (elements, comments, etc.) 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 or HTML, so they will not (in general) persist between DOM editing sessions. The Node.normalize() method merges any such adjacent Text objects into a single node for each block of text.

No lexical check is done on the content of a Text node and, depending on its position in the document, some characters must be escaped during serialization using character references; e.g. the characters "<&" if the textual content is part of an element or of an attribute, the character sequence "]]>" when part of an element, the quotation mark character " or the apostrophe character ' when part of an attribute.

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


Field Summary
 
Fields inherited from interface org.w3c.dom.Node sample code for org.w3c.dom.Node definition code for org.w3c.dom.Node
ATTRIBUTE_NODE sample code for org.w3c.dom.Node.ATTRIBUTE_NODE definition code for org.w3c.dom.Node.ATTRIBUTE_NODE , CDATA_SECTION_NODE sample code for org.w3c.dom.Node.CDATA_SECTION_NODE definition code for org.w3c.dom.Node.CDATA_SECTION_NODE , COMMENT_NODE sample code for org.w3c.dom.Node.COMMENT_NODE definition code for org.w3c.dom.Node.COMMENT_NODE , DOCUMENT_FRAGMENT_NODE sample code for org.w3c.dom.Node.DOCUMENT_FRAGMENT_NODE definition code for org.w3c.dom.Node.DOCUMENT_FRAGMENT_NODE , DOCUMENT_NODE sample code for org.w3c.dom.Node.DOCUMENT_NODE definition code for org.w3c.dom.Node.DOCUMENT_NODE , DOCUMENT_POSITION_CONTAINED_BY sample code for org.w3c.dom.Node.DOCUMENT_POSITION_CONTAINED_BY definition code for org.w3c.dom.Node.DOCUMENT_POSITION_CONTAINED_BY , DOCUMENT_POSITION_CONTAINS sample code for org.w3c.dom.Node.DOCUMENT_POSITION_CONTAINS definition code for org.w3c.dom.Node.DOCUMENT_POSITION_CONTAINS , DOCUMENT_POSITION_DISCONNECTED sample code for org.w3c.dom.Node.DOCUMENT_POSITION_DISCONNECTED definition code for org.w3c.dom.Node.DOCUMENT_POSITION_DISCONNECTED , DOCUMENT_POSITION_FOLLOWING sample code for org.w3c.dom.Node.DOCUMENT_POSITION_FOLLOWING definition code for org.w3c.dom.Node.DOCUMENT_POSITION_FOLLOWING , DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC sample code for org.w3c.dom.Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC definition code for org.w3c.dom.Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC , DOCUMENT_POSITION_PRECEDING sample code for org.w3c.dom.Node.DOCUMENT_POSITION_PRECEDING definition code for org.w3c.dom.Node.DOCUMENT_POSITION_PRECEDING , DOCUMENT_TYPE_NODE sample code for org.w3c.dom.Node.DOCUMENT_TYPE_NODE definition code for org.w3c.dom.Node.DOCUMENT_TYPE_NODE , ELEMENT_NODE sample code for org.w3c.dom.Node.ELEMENT_NODE definition code for org.w3c.dom.Node.ELEMENT_NODE , ENTITY_NODE sample code for org.w3c.dom.Node.ENTITY_NODE definition code for org.w3c.dom.Node.ENTITY_NODE , ENTITY_REFERENCE_NODE sample code for org.w3c.dom.Node.ENTITY_REFERENCE_NODE definition code for org.w3c.dom.Node.ENTITY_REFERENCE_NODE , NOTATION_NODE sample code for org.w3c.dom.Node.NOTATION_NODE definition code for org.w3c.dom.Node.NOTATION_NODE , PROCESSING_INSTRUCTION_NODE sample code for org.w3c.dom.Node.PROCESSING_INSTRUCTION_NODE definition code for org.w3c.dom.Node.PROCESSING_INSTRUCTION_NODE , TEXT_NODE sample code for org.w3c.dom.Node.TEXT_NODE definition code for org.w3c.dom.Node.TEXT_NODE
 
Method Summary
 String sample code for java.lang.String definition code for java.lang.String getWholeText sample code for org.w3c.dom.Text.getWholeText() definition code for org.w3c.dom.Text.getWholeText() ()
          Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
 boolean isElementContentWhitespace sample code for org.w3c.dom.Text.isElementContentWhitespace() definition code for org.w3c.dom.Text.isElementContentWhitespace() ()
          Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace".
 Text sample code for org.w3c.dom.Text definition code for org.w3c.dom.Text replaceWholeText sample code for org.w3c.dom.Text.replaceWholeText(java.lang.String) definition code for org.w3c.dom.Text.replaceWholeText(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  content)
          Replaces the text of the current node and all logically-adjacent text nodes with the specified text.
 Text sample code for org.w3c.dom.Text definition code for org.w3c.dom.Text splitText sample code for org.w3c.dom.Text.splitText(int) definition code for org.w3c.dom.Text.splitText(int) (int offset)
          Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings.
 
Methods inherited from interface org.w3c.dom.CharacterData sample code for org.w3c.dom.CharacterData definition code for org.w3c.dom.CharacterData
appendData sample code for org.w3c.dom.CharacterData.appendData(java.lang.String) definition code for org.w3c.dom.CharacterData.appendData(java.lang.String) , deleteData sample code for org.w3c.dom.CharacterData.deleteData(int, int) definition code for org.w3c.dom.CharacterData.deleteData(int, int) , getData sample code for org.w3c.dom.CharacterData.getData() definition code for org.w3c.dom.CharacterData.getData() , getLength sample code for org.w3c.dom.CharacterData.getLength() definition code for org.w3c.dom.CharacterData.getLength() , insertData sample code for org.w3c.dom.CharacterData.insertData(int, java.lang.String) definition code for org.w3c.dom.CharacterData.insertData(int, java.lang.String) , replaceData sample code for org.w3c.dom.CharacterData.replaceData(int, int, java.lang.String) definition code for org.w3c.dom.CharacterData.replaceData(int, int, java.lang.String) , setData sample code for org.w3c.dom.CharacterData.setData(java.lang.String) definition code for org.w3c.dom.CharacterData.setData(java.lang.String) , substringData sample code for org.w3c.dom.CharacterData.substringData(int, int) definition code for org.w3c.dom.CharacterData.substringData(int, int)
 
Methods inherited from interface org.w3c.dom.Node sample code for org.w3c.dom.Node definition code for org.w3c.dom.Node
appendChild sample code for org.w3c.dom.Node.appendChild(org.w3c.dom.Node) definition code for org.w3c.dom.Node.appendChild(org.w3c.dom.Node) , cloneNode sample code for org.w3c.dom.Node.cloneNode(boolean) definition code for org.w3c.dom.Node.cloneNode(boolean) , compareDocumentPosition sample code for org.w3c.dom.Node.compareDocumentPosition(org.w3c.dom.Node) definition code for org.w3c.dom.Node.compareDocumentPosition(org.w3c.dom.Node) , getAttributes sample code for org.w3c.dom.Node.getAttributes() definition code for org.w3c.dom.Node.getAttributes() , getBaseURI sample code for org.w3c.dom.Node.getBaseURI() definition code for org.w3c.dom.Node.getBaseURI() , getChildNodes sample code for org.w3c.dom.Node.getChildNodes() definition code for org.w3c.dom.Node.getChildNodes() , getFeature sample code for org.w3c.dom.Node.getFeature(java.lang.String, java.lang.String) definition code for org.w3c.dom.Node.getFeature(java.lang.String, java.lang.String) , getFirstChild sample code for org.w3c.dom.Node.getFirstChild() definition code for org.w3c.dom.Node.getFirstChild() , getLastChild sample code for org.w3c.dom.Node.getLastChild() definition code for org.w3c.dom.Node.getLastChild() , getLocalName sample code for org.w3c.dom.Node.getLocalName() definition code for org.w3c.dom.Node.getLocalName() , getNamespaceURI sample code for org.w3c.dom.Node.getNamespaceURI() definition code for org.w3c.dom.Node.getNamespaceURI() , getNextSibling sample code for org.w3c.dom.Node.getNextSibling() definition code for org.w3c.dom.Node.getNextSibling() , getNodeName sample code for org.w3c.dom.Node.getNodeName() definition code for org.w3c.dom.Node.getNodeName() , getNodeType sample code for org.w3c.dom.Node.getNodeType() definition code for org.w3c.dom.Node.getNodeType() , getNodeValue sample code for org.w3c.dom.Node.getNodeValue() definition code for org.w3c.dom.Node.getNodeValue() , getOwnerDocument sample code for org.w3c.dom.Node.getOwnerDocument() definition code for org.w3c.dom.Node.getOwnerDocument() , getParentNode sample code for org.w3c.dom.Node.getParentNode() definition code for org.w3c.dom.Node.getParentNode() , getPrefix sample code for org.w3c.dom.Node.getPrefix() definition code for org.w3c.dom.Node.getPrefix() , getPreviousSibling sample code for org.w3c.dom.Node.getPreviousSibling() definition code for org.w3c.dom.Node.getPreviousSibling() , getTextContent sample code for org.w3c.dom.Node.getTextContent() definition code for org.w3c.dom.Node.getTextContent() , getUserData sample code for org.w3c.dom.Node.getUserData(java.lang.String) definition code for org.w3c.dom.Node.getUserData(java.lang.String) , hasAttributes sample code for org.w3c.dom.Node.hasAttributes() definition code for org.w3c.dom.Node.hasAttributes() , hasChildNodes sample code for org.w3c.dom.Node.hasChildNodes() definition code for org.w3c.dom.Node.hasChildNodes() , insertBefore sample code for org.w3c.dom.Node.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node) definition code for org.w3c.dom.Node.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node) , isDefaultNamespace sample code for org.w3c.dom.Node.isDefaultNamespace(java.lang.String) definition code for org.w3c.dom.Node.isDefaultNamespace(java.lang.String) , isEqualNode sample code for org.w3c.dom.Node.isEqualNode(org.w3c.dom.Node) definition code for org.w3c.dom.Node.isEqualNode(org.w3c.dom.Node) , isSameNode sample code for org.w3c.dom.Node.isSameNode(org.w3c.dom.Node) definition code for org.w3c.dom.Node.isSameNode(org.w3c.dom.Node) , isSupported sample code for org.w3c.dom.Node.isSupported(java.lang.String, java.lang.String) definition code for org.w3c.dom.Node.isSupported(java.lang.String, java.lang.String) , lookupNamespaceURI sample code for org.w3c.dom.Node.lookupNamespaceURI(java.lang.String) definition code for org.w3c.dom.Node.lookupNamespaceURI(java.lang.String) , lookupPrefix sample code for org.w3c.dom.Node.lookupPrefix(java.lang.String) definition code for org.w3c.dom.Node.lookupPrefix(java.lang.String) , normalize sample code for org.w3c.dom.Node.normalize() definition code for org.w3c.dom.Node.normalize() , removeChild sample code for org.w3c.dom.Node.removeChild(org.w3c.dom.Node) definition code for org.w3c.dom.Node.removeChild(org.w3c.dom.Node) , replaceChild sample code for org.w3c.dom.Node.replaceChild(org.w3c.dom.Node, org.w3c.dom.Node) definition code for org.w3c.dom.Node.replaceChild(org.w3c.dom.Node, org.w3c.dom.Node) , setNodeValue sample code for org.w3c.dom.Node.setNodeValue(java.lang.String) definition code for org.w3c.dom.Node.setNodeValue(java.lang.String) , setPrefix sample code for org.w3c.dom.Node.setPrefix(java.lang.String) definition code for org.w3c.dom.Node.setPrefix(java.lang.String) , setTextContent sample code for org.w3c.dom.Node.setTextContent(java.lang.String) definition code for org.w3c.dom.Node.setTextContent(java.lang.String) , setUserData sample code for org.w3c.dom.Node.setUserData(java.lang.String, java.lang.Object, org.w3c.dom.UserDataHandler) definition code for org.w3c.dom.Node.setUserData(java.lang.String, java.lang.Object, org.w3c.dom.UserDataHandler)
 

Method Detail

splitText sample code for org.w3c.dom.Text.splitText(int) definition code for org.w3c.dom.Text.splitText(int)

Text sample code for org.w3c.dom.Text definition code for org.w3c.dom.Text  splitText(int offset)
               throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings. After being split, this node will contain all the content up to the offset point. A new node of the same type, which contains all the content at and after the offset point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the offset is equal to the length of this node, the new node has no data.

Parameters:
offset - The 16-bit unit offset at which to split, starting from 0.
Returns:
The new node, of the same type as this node.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.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.

isElementContentWhitespace sample code for org.w3c.dom.Text.isElementContentWhitespace() definition code for org.w3c.dom.Text.isElementContentWhitespace()

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().

Since:
DOM Level 3

getWholeText sample code for org.w3c.dom.Text.getWholeText() definition code for org.w3c.dom.Text.getWholeText()

String sample code for java.lang.String definition code for java.lang.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".

Since:
DOM Level 3

replaceWholeText sample code for org.w3c.dom.Text.replaceWholeText(java.lang.String) definition code for org.w3c.dom.Text.replaceWholeText(java.lang.String)

Text sample code for org.w3c.dom.Text definition code for org.w3c.dom.Text  replaceWholeText(String sample code for java.lang.String definition code for java.lang.String  content)
                      throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.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:
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.

Parameters:
content - The content of the replacing Text node.
Returns:
The Text node created with the specified content.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text nodes being replaced is readonly.
Since:
DOM Level 3