Class Document

文件

XML 文件的表示法。

方法

方法傳回類型簡短說明
addContent(content)Document將指定節點附加至文件結尾。
addContent(index, content)Document在文件中所有直接子項節點中,於指定索引處插入指定節點。
cloneContent()Content[]建立文件中所有節點的未附加副本,這些節點是文件的直接子項。
detachRootElement()Element|null卸離並傳回文件的根 Element 節點。
getAllContent()Content[]取得文件的所有直接子項節點。
getContent(index)Content|null取得文件中所有直接子項節點中,位於指定索引的節點。
getContentSize()Integer取得文件直接子項的節點數量。
getDescendants()Content[]取得文件中所有直接或間接子項節點,並按照節點在文件中出現的順序排列。
getDocType()DocType|null取得文件的 DocType 宣告。
getRootElement()Element|null取得文件的根 Element 節點。
hasRootElement()Boolean判斷文件是否具有根 Element 節點。
removeContent()Content[]移除文件的所有直接子項節點。
removeContent(content)Boolean如果節點是文件的直接子項,則移除該節點。
removeContent(index)Content|null從文件中所有直接子項節點中,移除指定索引處的節點。
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|null:已卸離的 Element 節點;如果文件沒有根 Element 節點,則為 null


getAllContent()

取得文件的所有直接子項節點。

回攻員

Content[]:文件所有直接子項的陣列。


getContent(index)

取得文件中所有直接子項節點中,位於指定索引位置的節點。如果指定索引處沒有節點,這個方法會傳回 null

參數

名稱類型說明
indexInteger節點在文件直接子項所有節點中的索引。

回攻員

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


getContentSize()

取得文件直接子項的節點數量。

回攻員

Integer:文件直接子項的節點數量。


getDescendants()

取得文件中所有直接或間接子項節點,並按照節點在文件中出現的順序排列。

回攻員

Content[]:所有節點的陣列,這些節點是文件的直接或間接子項。


getDocType()

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

回攻員

DocType|nullDocumentType 節點,或文件沒有 DocumentType 節點時為 null


getRootElement()

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

回攻員

Element|null:根 Element 節點,或文件沒有根 Element 節點時為 null


hasRootElement()

判斷文件是否具有根 Element 節點。

回攻員

Boolean - true 如果文件有根 Element 節點;false 如果沒有。


removeContent()

移除文件的所有直接子項節點。

回攻員

Content[]:移除節點前,文件中所有直接子項的陣列。


removeContent(content)

如果節點是文件的直接子項,則會移除該節點。content 引數可以是 Content 物件,也可以是與 ContentType 中列出的型別對應的任何節點物件。

參數

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

回攻員

Boolean - true (如果節點是直接子項且已移除);false (如果不是)。


removeContent(index)

從文件中所有直接子項節點中,移除指定索引處的節點。如果指定索引處沒有節點,這個方法會傳回 null

參數

名稱類型說明
indexInteger節點在文件直接子項所有節點中的索引。

回攻員

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


setDocType(docType)

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

參數

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

回攻員

Document - 鏈結用的文件。


setRootElement(element)

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

參數

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

回攻員

Document - 鏈結用的文件。