Object 內置對象

對象XmlText

XmlText 對象表示元素或屬性的文本內容

XmlText 節點表示XML 文檔中的一系列純文本。因為純文本出現在XML 的元素和屬性中,所以XmlText 節點通常作為XmlElement 節點和 XmlAttr 節點的子節點出現。

XmlText 節點繼承了 XmlCharacterData 接口,通過從 XmlCharacterData 接口繼承的data 屬性或從 XmlNode 接口繼承的nadevalue 屬性,可以訪問XmlText 節點的文本內容。

用從 XmlCharacterData繼承的方法或XmlText 接口自身定義的splitText() 方法可以操作XmlText 節點。使用XmlDocument 的createTextNode 來創建一個新的XmlText 節點。

XmlText 節點沒有子節點。

關於從文檔的子樹中刪除空XmlText 節點與合併相鄰的XmlText 節點的方法,請參閱 XmlNode.normalize 方法。

繼承關係

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>XmlNode|nodeType;nodeName;nodeValue;ownerDocument;parentNode;childNodes;firstChild;lastChild;previousSibling;nextSibling|hasChildNodes();normalize();cloneNode();lookupPrefix();lookupNamespaceURI();insertBefore();insertAfter();appendChild();replaceChild();removeChild()] [<class>XmlCharacterData|data;length|substringData();appendData();insertData();deleteData();replaceData()] [<this>XmlText|splitText()] [<class>XmlCDATASection] [object] <:- [XmlNode] [XmlNode] <:- [XmlCharacterData] [XmlCharacterData] <:- [XmlText] [XmlText] <:- [XmlCDATASection] XmlNode nodeType nodeName nodeValue ownerDocument parentNode childNodes firstChild lastChild previousSibling nextSibling hasChildNodes() normalize() cloneNode() lookupPrefix() lookupNamespaceURI() insertBefore() insertAfter() appendChild() replaceChild() removeChild() XmlCharacterData data length substringData() appendData() insertData() deleteData() replaceData() object toString() toJSON() XmlText splitText() XmlCDATASection

成員屬性

data

String, 該節點包含的文本

1
String XmlText.data;

length

Integer, 該節點包含的字符數

1
readonly Integer XmlText.length;

nodeType

Integer, 返回節點的節點類型

1
readonly Integer XmlText.nodeType;

不同對象的nodeType 會返回不同的值:


nodeName

String, 返回節點的名稱,根據其類型

1
readonly String XmlText.nodeName;

不同對象的nodeName 會返回不同的值:


nodeValue

String, 返回節點的名稱,根據其類型

1
String XmlText.nodeValue;

不同對象的nodeName 會返回不同的值:


ownerDocument

XmlDocument, 返回節點的根元素(XmlDocument 對象)

1
readonly XmlDocument XmlText.ownerDocument;

parentNode

XmlNode, 可返回某節點的父節點

1
readonly XmlNode XmlText.parentNode;

childNodes

XmlNodeList, 返回指定節點的子節點的節點列表

1
readonly XmlNodeList XmlText.childNodes;

firstChild

XmlNode, 返回節點的首個子節點

1
readonly XmlNode XmlText.firstChild;

lastChild

XmlNode, 返回節點的最後一個子節點

1
readonly XmlNode XmlText.lastChild;

previousSibling

XmlNode, 返回某節點之前緊跟的節點(處於同一樹層級),如果沒有此節點,那麼該屬性返回null

1
readonly XmlNode XmlText.previousSibling;

nextSibling

XmlNode, 返回某個元素之後緊跟的節點(處於同一樹層級中),如果無此節點,則屬性返回null

1
readonly XmlNode XmlText.nextSibling;

成員函數

splitText

按照指定的offset 把文本節點分割為兩個節點

1
XmlText XmlText.splitText(Integer offset);

調用參數:

  • offset: Integer, 規定在何處分割文本節點。開始值以0 開始

返回結果:

  • XmlText, 從當前節點分割出的Text 節點

該方法將在指定的offset 處把XmlText 節點分割成兩個節點。原始的XmlText 節點將被修改,使它包含offset 指定的位置之前的文本內容(但不包括文本內容)。新的XmlText 節點將被創建,用於存放從offset 位置(包括該位置上的字符)到原字符結尾的所有字符。新的XmlText 節點是該方法的返回值。此外,如果原始的XmlText 節點具有parentNode,新的XmlText 節點將插入這個父節點,緊鄰在原始節點之後。

XmlCDATASection 接口繼承了XmlText 接口, XmlCDATASection 節點也可以使用該方法,只是新創建的節點是 XmlCDATASection 節點,而不是XmlText 節點。


substringData

從節點中提取子串

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

調用參數:

  • offset: Integer, 要返回的第一個字符的位置
  • count: Integer, 要返回的子串中的字符數

返回結果:

  • String, 返回提取的字符串

appendData

把字符串附加到節點上

1
XmlText.appendData(String arg);

調用參數:

  • arg: String, 要附加到節點的字符串

insertData

把字符串插入節點

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

調用參數:

  • offset: Integer, 要把字符串插入節點的字符位置
  • arg: String, 要插入的字符串

deleteData

從節點刪除文本

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

調用參數:

  • offset: Integer, 要刪除的第一個字符的位置
  • count: Integer, 要刪除的字符的數量

replaceData

用指定的字符串替換節點的字符

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

調用參數:

  • offset: Integer, 節點要替換的字符位置
  • count: Integer, 要替換的字符的數量
  • arg: String, 要插入的字符串

hasChildNodes

查詢是否存在子節點

1
Boolean XmlText.hasChildNodes();

返回結果:

  • Boolean, 存在任何子節點時返回true,否則返回false

normalize

合併相鄰的Text 節點並刪除空的Text 節點

1
XmlText.normalize();

這個方法將遍歷當前節點的所有子孫節點,通過刪除空的Text 節點,已經合併所有相鄰的Text 節點來規範化文檔。該方法在進行節點的插入或刪除操作後,對於簡化文檔樹的結構很有用。


cloneNode

創建指定的節點的精確拷貝

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

調用參數:

  • deep: Boolean, 是否深度拷貝,為true 時,被克隆的節點會克隆原節點的所有子節點

返回結果:

  • XmlNode, 返回所複製的節點

該方法將復制並返回調用它的節點的副本。如果傳遞給它的參數是true,它還將遞歸複製當前節點的所有子孫節點。否則,它只複製當前節點。返回的節點不屬於文檔樹,它的parentNode 屬性為null。當複制的是Element 節點時,它的所有屬性都將被複製。


lookupPrefix

返回在當前節點上匹配指定的命名空間URI 的前綴

1
String XmlText.lookupPrefix(String namespaceURI);

調用參數:

  • namespaceURI: String, 指定匹配的命名空間URI

返回結果:

  • String, 返回匹配的前綴,未匹配到返回null

lookupNamespaceURI

返回在當前節點上匹配指定的前綴的命名空間URI

1
String XmlText.lookupNamespaceURI(String prefix);

調用參數:

  • prefix: String, 指定匹配的前綴

返回結果:

  • String, 返回匹配的命名空間URI,未匹配到返回null

insertBefore

在已有的子節點前插入一個新的子節點

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

調用參數:

  • newChild: XmlNode, 插入新的節點
  • refChild: XmlNode, 在此節點前插入新節點

返回結果:

如果文檔樹中已經存在了newChild,它將從文檔樹中刪除,然後重新插入它的新位置。來自一個文檔的節點(或由一個文檔創建的節點)不能插入另一個文檔。也就是說,newChild 的ownerDocument 屬性必須與當前節點的ownerDocument 屬性相同。


insertAfter

在已有的子節點後插入一個新的子節點

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

調用參數:

  • newChild: XmlNode, 插入新的節點
  • refChild: XmlNode, 在此節點後插入新節點

返回結果:

如果文檔樹中已經存在了newChild,它將從文檔樹中刪除,然後重新插入它的新位置。來自一個文檔的節點(或由一個文檔創建的節點)不能插入另一個文檔。也就是說,newChild 的ownerDocument 屬性必須與當前節點的ownerDocument 屬性相同。


appendChild

向節點的子節點列表的末尾添加新的子節點

1
XmlNode XmlText.appendChild(XmlNode newChild);

調用參數:

  • newChild: XmlNode, 指定添加的節點

返回結果:

  • XmlNode, 返回這個新的子節點

如果文檔樹中已經存在了newChild,它將從文檔樹中刪除,然後重新插入它的新位置。來自一個文檔的節點(或由一個文檔創建的節點)不能插入另一個文檔。也就是說,newChild 的ownerDocument 屬性必須與當前節點的ownerDocument 屬性相同。


replaceChild

將某個子節點替換為另一個

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

調用參數:

  • newChild: XmlNode, 指定新的節點
  • oldChild: XmlNode, 指定被替換的節點

返回結果:

  • XmlNode, 如替換成功,此方法可返回被替換的節點,如替換失敗,則返回null

如果文檔樹中已經存在了newChild,它將從文檔樹中刪除,然後重新插入它的新位置。來自一個文檔的節點(或由一個文檔創建的節點)不能插入另一個文檔。也就是說,newChild 的ownerDocument 屬性必須與當前節點的ownerDocument 屬性相同。


removeChild

從子節點列表中刪除某個節點

1
XmlNode XmlText.removeChild(XmlNode oldChild);

調用參數:

  • oldChild: XmlNode, 指定被刪除的節點

返回結果:

  • XmlNode, 如刪除成功,此方法可返回被刪除的節點,如失敗,則返回null

toString

返回對象的字符串表示,一般返回"[Native Object]",對象可以根據自己的特性重新實現

1
String XmlText.toString();

返回結果:

  • String, 返回對象的字符串表示

toJSON

返回對象的JSON 格式表示,一般返回對象定義的可讀屬性集合

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

調用參數:

  • key: String, 未使用

返回結果:

  • Value, 返回包含可JSON 序列化的值