Class Document

文件

XML 文件的表示法。

方法

方法傳回類型簡短說明
addContent(content)Document將指定的節點附加至文件結尾。
addContent(index, content)Document在所有是文件立即子項的節點之間,插入指定的索引處。
cloneContent()Content[]為文件立即子項的所有節點建立未連接的副本。
detachRootElement()Element拆解並傳回文件的根 Element 節點。
getAllContent()Content[]取得文件立即子項的所有節點。
getContent(index)Content從所有是文件立即子項的節點中,取得位於指定索引的節點。
getContentSize()Integer取得文件立即子項的節點數量。
getDescendants()Content[]依照文件中顯示的順序,取得文件直接或間接子項的所有節點。
getDocType()DocType取得文件的 DocType 宣告。
getRootElement()Element取得文件的根 Element 節點。
hasRootElement()Boolean決定文件是否具有根 Element 節點。
removeContent()Content[]移除文件立即子項的所有節點。
removeContent(content)Boolean如果節點是文件的直接子項,將移除指定的節點。
removeContent(index)Content從所有為文件立即子項的節點中移除位於指定索引的節點。
setDocType(docType)Document設定文件的 DocType 宣告。
setRootElement(element)Document設定文件的根 Element 節點。

內容詳盡的說明文件

addContent(content)

將指定的節點附加至文件結尾。content 引數可以是 Content 物件,或是與 ContentType 中列出的類型對應的任何節點物件。不過請注意,一份文件只能有一個子項 Element 節點,也就是根 Element 節點。

參數

名稱類型說明
contentContent要附加的節點

回攻員

Document — 用於鏈結的文件


addContent(index, content)

在所有是文件立即子項的節點之間,插入指定的索引處。content 引數可以是 Content 物件,或是與 ContentType 中列出的類型對應的任何節點物件。不過請注意,文件只能有一個子項 Element 節點,也就是根 Element 節點。

參數

名稱類型說明
indexInteger要在這個索引處插入這個索引,該節點是文件立即子項的所有節點
contentContent要插入的節點

回攻員

Document — 用於鏈結的文件


cloneContent()

為文件立即子項的所有節點建立未連接的副本。

回攻員

Content[]:針對文件直接子項的所有節點所附加的陣列


detachRootElement()

拆解並傳回文件的根 Element 節點。如果文件沒有根 Element 節點,這個方法會傳回 null

回攻員

Element:卸離的 Element 節點;如果文件沒有根 Element 節點,則為 null


getAllContent()

取得文件立即子項的所有節點。

回攻員

Content[]:文件立即子項的所有節點陣列


getContent(index)

從所有是文件立即子項的節點中,取得位於指定索引的節點。如果指定的索引中沒有任何節點,這個方法會傳回 null

參數

名稱類型說明
indexInteger在所有為文件立即子項的節點之間建立該節點的索引

回攻員

Content:節點;如果指定索引沒有節點,則為 null


getContentSize()

取得文件立即子項的節點數量。

回攻員

Integer:文件立即子項的節點數量


getDescendants()

依照文件中顯示的順序,取得文件直接或間接子項的所有節點。

回攻員

Content[]:包含文件直接或間接子項的所有節點陣列


getDocType()

取得文件的 DocType 宣告。如果文件沒有 DocumentType 節點,這個方法會傳回 null

回攻員

DocTypeDocumentType 節點;如果文件沒有 DocumentType 節點,則為 null


getRootElement()

取得文件的根 Element 節點。如果文件沒有根 Element 節點,這個方法會傳回 null

回攻員

Element:根 Element 節點;如果文件沒有根 Element 節點,則為 null


hasRootElement()

決定文件是否具有根 Element 節點。

回攻員

Boolean:如果文件包含根 Element 節點,則為 true;如果不具有根節點,則為 false


removeContent()

移除文件立即子項的所有節點。

回攻員

Content[]:文件立即子項的所有節點陣列,這些節點在移除前即是文件的立即子項


removeContent(content)

如果節點是文件的直接子項,將移除指定的節點。content 引數可以是 Content 物件,或是與 ContentType 中列出的類型對應的任何節點物件。

參數

名稱類型說明
contentContent要移除的節點

回攻員

Boolean:如果節點是立即的子項且已移除,則為 true;如果不是,則為 false


removeContent(index)

從所有為文件立即子項的節點中移除位於指定索引的節點。如果指定的索引中沒有任何節點,這個方法會傳回 null

參數

名稱類型說明
indexInteger在所有為文件立即子項的節點之間建立該節點的索引

回攻員

Content:已移除的節點;如果指定索引中沒有節點,則為 null


setDocType(docType)

設定文件的 DocType 宣告。如果文件已有不同的 DocType 節點,此方法會覆寫舊節點。如果文件已包含正在設定的相同 DocType 節點,這個方法會擲回例外狀況。

參數

名稱類型說明
docTypeDocType要設定的 DocumentType

回攻員

Document — 用於鏈結的文件


setRootElement(element)

設定文件的根 Element 節點。如果文件已有根 Element 節點,這個方法會覆寫舊節點。

參數

名稱類型說明
elementElement要設定的根 Element 節點

回攻員

Document — 用於鏈結的文件