Object XmlText

XmlText object represents the text content of an element or attribute

The XmlText node represents a series of plain text in an XML document. Because plain text appears in elements and attributes of XML, XmlText nodes usually appear as child nodes of XmlElement and XmlAttr nodes.

The XmlText node inherits the XmlCharacterData interface. The text content of the XmlText node can be accessed through the data attribute inherited from the XmlCharacterData interface or the nadevalue attribute inherited from the XmlNode interface.

The XmlText node can be manipulated by the method inherited from XmlCharacterData or the splitText() method defined by the XmlText interface itself. Use createTextNode of XmlDocument to create a new XmlText node.

The XmlText node has no children.

For the method of deleting empty XmlText nodes and merging adjacent XmlText nodes from the subtree of the document, please refer to the XmlNode.normalize method.

Inheritance

Member attributes

data

String, the text contained in the node

1
String XmlText.data;

length

Integer, the number of characters contained in the node

1
readonly Integer XmlText.length;

nodeType

Integer, returns the node type of the node

1
readonly Integer XmlText.nodeType;

The nodeType of different objects will return different values:

• XmlElement : ELEMENT_NODE(1)
• XmlAttr : ATTRIBUTE_NODE(2)
• XmlText : TEXT_NODE(3)
• XmlCDATASection : CDATA_SECTION_NODE(4)
• XmlProcessingInstruction : PROCESSING_INSTRUCTION_NODE(7)
• XmlComment : COMMENT_NODE(8)
• XmlDocument : DOCUMENT_NODE(9)
• XmlDocumentType : DOCUMENT_TYPE_NODE(10)

nodeName

String, returns the name of the node, according to its type

1
readonly String XmlText.nodeName;

The nodeName of different objects will return different values:

• XmlElement : element name
• XmlAttr : attribute name
• XmlText : #text
• XmlCDATASection : #cdata-section
• XmlProcessingInstruction : Return the specified target target
• XmlComment : #comment
• XmlDocument : #document
• XmlDocumentType : doctype name

nodeValue

String, returns the name of the node, according to its type

1
String XmlText.nodeValue;

The nodeName of different objects will return different values:

• XmlElement : null
• XmlAttr : the value of the attribute
• XmlText : the content of the node
• XmlCDATASection : the content of the node
• XmlProcessingInstruction : Return the specified content data
• XmlComment : comment text
• XmlDocument : null
• XmlDocumentType : null

ownerDocument

XmlDocument , returns the root element of the node ( XmlDocument object)

1
readonly XmlDocument XmlText.ownerDocument;

parentNode

XmlNode , can return the parent node of a node

1
readonly XmlNode XmlText.parentNode;

childNodes

XmlNodeList , returns the node list of the child nodes of the specified node

1
readonly XmlNodeList XmlText.childNodes;

firstChild

XmlNode , returns the first child node of the node

1
readonly XmlNode XmlText.firstChild;

lastChild

XmlNode , returns the last child node of the node

1
readonly XmlNode XmlText.lastChild;

previousSibling

XmlNode , returns the node immediately before a node (at the same tree level), if there is no such node, then this attribute returns null

1
readonly XmlNode XmlText.previousSibling;

nextSibling

XmlNode , returns the node immediately following an element (in the same tree level), if there is no such node, the property returns null

1
readonly XmlNode XmlText.nextSibling;

Member function

splitText

Split the text node into two nodes according to the specified offset

1
XmlText XmlText.splitText(Integer offset);

Call parameters:

• offset : Integer, which specifies where to split the text node. Start value starts at 0

Return result:

• XmlText , the Text node split from the current node

This method will split the XmlText node into two nodes at the specified offset. The original XmlText node will be modified so that it contains the text content (but not including the text content) before the position specified by offset. A new XmlText node will be created to store all characters from the offset position (including the character at that position) to the end of the original character. The new XmlText node is the return value of the method. In addition, if the original XmlText node has a parentNode, the new XmlText node will be inserted into this parent node immediately after the original node.

XmlCDATASection interface inherits the XmlText interface, and the XmlCDATASection node can also use this method, but the newly created node is the XmlCDATASection node, not the XmlText node.

substringData

Extract substring from node

1
2
String XmlText.substringData(Integer offset,
    Integer count);

Call parameters:

• offset : Integer, the position of the first character to be returned
• count : Integer, the number of characters in the substring to be returned

Return result:

• String , returns the extracted string

appendData

Append the string to the node

1
XmlText.appendData(String arg);

Call parameters:

• arg : String, string to be appended to the node

insertData

Insert string into node

1
2
XmlText.insertData(Integer offset,
    String arg);

Call parameters:

• offset : Integer, the character position where the string is to be inserted into the node
• arg : String, the string to be inserted

deleteData

Delete text from node

1
2
XmlText.deleteData(Integer offset,
    Integer count);

Call parameters:

• offset : Integer, the position of the first character to be deleted
• count : Integer, the number of characters to delete

replaceData

Replace the characters of the node with the specified string

1
2
3
XmlText.replaceData(Integer offset,
    Integer count,
    String arg);

Call parameters:

• offset : Integer, the character position of the node to be replaced
• count : Integer, the number of characters to be replaced
• arg : String, the string to be inserted

hasChildNodes

Query whether there are child nodes

1
Boolean XmlText.hasChildNodes();

Return result:

• Boolean , return true if there are any child nodes, otherwise return false

normalize

Merge adjacent Text nodes and delete empty Text nodes

1
XmlText.normalize();

This method will traverse all descendant nodes of the current node and normalize the document by deleting the empty Text node and merging all adjacent Text nodes. This method is useful for simplifying the structure of the document tree after inserting or deleting nodes.

cloneNode

Create an exact copy of the specified node

1
XmlNode XmlText.cloneNode(Boolean deep = true);

Call parameters:

• deep : Boolean, whether to deep copy, when true, the cloned node will clone all child nodes of the original node

Return result:

• XmlNode , return the copied node

This method will copy and return a copy of the node that called it. If the parameter passed to it is true, it will also recursively copy all descendants of the current node. Otherwise, it only copies the current node. The returned node does not belong to the document tree, and its parentNode property is null. When the Element node is copied, all its attributes will be copied.

lookupPrefix

Returns the prefix matching the specified namespace URI on the current node

1
String XmlText.lookupPrefix(String namespaceURI);

Call parameters:

• namespaceURI : String, specify the matching namespace URI

Return result:

• String , returns the matched prefix, returns null if it is not matched

lookupNamespaceURI

Returns the namespace URI that matches the specified prefix on the current node

1
String XmlText.lookupNamespaceURI(String prefix);

Call parameters:

• prefix : String, specify the matching prefix

Return result:

• String , returns the matching namespace URI, returns null if it is not matched

insertBefore

Insert a new child node before the existing child node

1
2
XmlNode XmlText.insertBefore(XmlNode newChild,
    XmlNode refChild);

Call parameters:

• newChild : XmlNode , insert a new node
• refChild : XmlNode , insert a new node before this node

Return result:

• XmlNode , returns the new child node

If newChild already exists in the document tree, it will be deleted from the document tree and then reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. In other words, the ownerDocument property of newChild must be the same as the ownerDocument property of the current node.

insertAfter

Insert a new child node after the existing child node

1
2
XmlNode XmlText.insertAfter(XmlNode newChild,
    XmlNode refChild);

Call parameters:

• newChild : XmlNode , insert a new node
• refChild : XmlNode , insert a new node after this node

Return result:

• XmlNode , returns the new child node

If newChild already exists in the document tree, it will be deleted from the document tree and then reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. In other words, the ownerDocument property of newChild must be the same as the ownerDocument property of the current node.

appendChild

Add a new child node to the end of the node's child node list

1
XmlNode XmlText.appendChild(XmlNode newChild);

Call parameters:

• newChild : XmlNode , specify the added node

Return result:

• XmlNode , return this new child node

If newChild already exists in the document tree, it will be deleted from the document tree and then reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. In other words, the ownerDocument property of newChild must be the same as the ownerDocument property of the current node.

replaceChild

Replace one child node with another

1
2
XmlNode XmlText.replaceChild(XmlNode newChild,
    XmlNode oldChild);

Call parameters:

• newChild : XmlNode , specify a new node
• oldChild : XmlNode , specify the node to be replaced

Return result:

• XmlNode , if the replacement is successful, this method can return the replaced node, if the replacement fails, it returns null

If newChild already exists in the document tree, it will be deleted from the document tree and then reinserted in its new position. Nodes from one document (or nodes created by one document) cannot be inserted into another document. In other words, the ownerDocument property of newChild must be the same as the ownerDocument property of the current node.

removeChild

Remove a node from the list of child nodes

1
XmlNode XmlText.removeChild(XmlNode oldChild);

Call parameters:

• oldChild : XmlNode , specify the node to be deleted

Return result:

• XmlNode , if the deletion is successful, this method can return the deleted node, if it fails, it returns null

toString

Returns the string representation of the object, generally returns "[Native Object]", the object can be re-implemented according to its own characteristics

1
String XmlText.toString();

Return result:

• String , returns the string representation of the object

toJSON

Returns the JSON format representation of the object, generally returns a collection of readable attributes defined by the object

1
Value XmlText.toJSON(String key = "");

Call parameters:

• key : String, unused

Return result:

• Value , returns a value containing JSON serializable