org.apache.xerces.impl.xs.opti.DefaultNode
org.apache.xerces.impl.xs.opti.NodeImpl
org.apache.xerces.impl.xs.opti.DefaultText
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class DefaultText
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
normalize() method on Node merges any such
adjacent Text objects into a single node for each block of
text.
See also the Document Object Model (DOM) Level 2 Core Specification. This is an empty implementation.
| Field Summary |
|---|
| Constructor Summary | |
|---|---|
DefaultText()
|
|
| Method Summary | |
|---|---|
void |
appendData(java.lang.String arg)
Append the string to the end of the character data of the node. |
void |
deleteData(int offset,
int count)
Remove a range of 16-bit units from the node. |
java.lang.String |
getData()
The character data of the node that implements this interface. |
int |
getLength()
The number of 16-bit units that are available through data
and the substringData method below. |
java.lang.String |
getWholeText()
Returns all text of Text nodes logically-adjacent text
nodes to this node, concatenated in document order. |
void |
insertData(int offset,
java.lang.String arg)
Insert a string at the specified 16-bit unit offset. |
boolean |
isElementContentWhitespace()
DOM Level 3 CR |
void |
replaceData(int offset,
int count,
java.lang.String arg)
Replace the characters starting at the specified 16-bit unit offset with the specified string. |
Text |
replaceWholeText(java.lang.String content)
Replaces the text of the current node and all logically-adjacent text nodes with the specified text. |
void |
setData(java.lang.String data)
The character data of the node that implements this interface. |
Text |
splitText(int offset)
Breaks this node into two nodes at the specified offset,
keeping both in the tree as siblings. |
java.lang.String |
substringData(int offset,
int count)
Extracts a range of data from the node. |
| Methods inherited from class org.apache.xerces.impl.xs.opti.NodeImpl |
|---|
getLocalName, getNamespaceURI, getNodeName, getNodeType, getPrefix, getReadOnly, setReadOnly |
| Methods inherited from class org.apache.xerces.impl.xs.opti.DefaultNode |
|---|
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.w3c.dom.Node |
|---|
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData |
| Constructor Detail |
|---|
public DefaultText()
| Method Detail |
|---|
public java.lang.String getData()
throws DOMException
CharacterData node. However,
implementation limits may mean that the entirety of a node's data may
not fit into a single DOMString. In such cases, the user
may call substringData to retrieve the data in
appropriately sized pieces.
getData in interface CharacterDataDOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString variable on the implementation
platform.
public void setData(java.lang.String data)
throws DOMException
CharacterData node. However,
implementation limits may mean that the entirety of a node's data may
not fit into a single DOMString. In such cases, the user
may call substringData to retrieve the data in
appropriately sized pieces.
setData in interface CharacterDataDOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString variable on the implementation
platform.public int getLength()
data
and the substringData method below. This may have the
value zero, i.e., CharacterData nodes may be empty.
getLength in interface CharacterData
public java.lang.String substringData(int offset,
int count)
throws DOMException
substringData in interface CharacterDataoffset - Start offset of substring to extract.count - The number of 16-bit units to extract.
offset and
count exceeds the length, then all 16-bit
units to the end of the data are returned.
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data, or if the specified count is
negative.
DOMString.
public void appendData(java.lang.String arg)
throws DOMException
data provides access to the concatenation of
data and the DOMString specified.
appendData in interface CharacterDataarg - The DOMString to append.
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void insertData(int offset,
java.lang.String arg)
throws DOMException
insertData in interface CharacterDataoffset - The character offset at which to insert.arg - The DOMString to insert.
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data.
public void deleteData(int offset,
int count)
throws DOMException
data and length reflect the change.
deleteData in interface CharacterDataoffset - The offset from which to start removing.count - The number of 16-bit units to delete. If the sum of
offset and count exceeds
length then all 16-bit units from offset
to the end of the data are deleted.
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data, or if the specified count is
negative.
public void replaceData(int offset,
int count,
java.lang.String arg)
throws DOMException
replaceData in interface CharacterDataoffset - The offset from which to start replacing.count - The number of 16-bit units to replace. If the sum of
offset and count exceeds
length, then all 16-bit units to the end of the data
are replaced; (i.e., the effect is the same as a remove
method call with the same range, followed by an append
method invocation).arg - The DOMString with which the range must be
replaced.
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data, or if the specified count is
negative.
public Text splitText(int offset)
throws DOMException
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.
splitText in interface Textoffset - The 16-bit unit offset at which to split, starting from
0.
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
than the number of 16-bit units in data.
public boolean isElementContentWhitespace()
isElementContentWhitespace in interface Textpublic java.lang.String getWholeText()
TextText nodes logically-adjacent text
nodes to this node, concatenated in document order.
wholeText on the
Text node that contains "bar" returns "barfoo", while on
the Text node that contains "foo" it returns "barfoo".
getWholeText in interface Text
public Text replaceWholeText(java.lang.String content)
throws DOMException
Textnull, when the replacement text is
the empty string;
Text node of the same type (
Text or CDATASection) as the current node
inserted at the location of the replacement.
replaceWholeText on the Text node that
contains "bar" with "yo" in argument results in the following:
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.
replaceWholeText on the Text node that
contains "bar" fails, because the EntityReference node
"ent" contains an Element node which cannot be removed.
replaceWholeText in interface Textcontent - The content of the replacing Text node.
Text node created with the specified content.
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text
nodes being replaced is readonly.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||