| Prev Class | Next Class | Frames | No Frames |
| Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface Textextends CharacterDataText 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.
Method Summary | |
String |
|
boolean |
|
Text |
|
Text |
|
Methods inherited from interface org.w3c.dom.CharacterData | |
appendData, deleteData, getData, getLength, insertData, replaceData, setData, substringData | |
public String getWholeText()
Returns all text ofTextnodes logically-adjacent text nodes to this node, concatenated in document order.
For instance, in the example belowwholeTexton theTextnode that contains "bar" returns "barfoo", while on theTextnode that contains "foo" it returns "barfoo".
- Since:
- DOM Level 3
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 usingDocument.normalizeDocument().
- Since:
- DOM Level 3
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
Textnode of the same type (TextorCDATASection) as the current node inserted at the location of the replacement.
For instance, in the above example callingreplaceWholeTexton theTextnode that contains "bar" with "yo" in argument results in the following:
Where the nodes to be removed are read-only descendants of anEntityReference, theEntityReferencemust be removed instead of the read-only nodes. If anyEntityReferenceto be removed has descendants that are notEntityReference,Text, orCDATASectionnodes, thereplaceWholeTextmethod must fail before performing any modification of the document, raising aDOMExceptionwith the codeNO_MODIFICATION_ALLOWED_ERR.
For instance, in the example below callingreplaceWholeTexton theTextnode that contains "bar" fails, because theEntityReferencenode "ent" contains anElementnode which cannot be removed.
- Parameters:
content- The content of the replacingTextnode.
- Returns:
- The
Textnode created with the specified content.
- Throws:
DOMException- NO_MODIFICATION_ALLOWED_ERR: Raised if one of theTextnodes being replaced is readonly.
- Since:
- DOM Level 3
public Text splitText(int offset) throws DOMException
Breaks this node into two nodes at the specifiedoffset, keeping both in the tree as siblings. After being split, this node will contain all the content up to theoffsetpoint. A new node of the same type, which contains all the content at and after theoffsetpoint, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When theoffsetis 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 from0.
- 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 indata.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.