Class Document

Dokument

Eine Darstellung eines XML-Dokuments.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
addContent(content)	Document	Fügt den angegebenen Knoten am Ende des Dokuments an.
addContent(index, content)	Document	Fügt den angegebenen Knoten am angegebenen Index unter allen Knoten ein, die unmittelbare untergeordnete Elemente des Dokuments sind.
cloneContent()	Content[]	Erstellt nicht angehängte Kopien aller Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.
detachRootElement()	Element|null	Trennt den Element-Knoten des Dokuments ab und gibt ihn zurück.
getAllContent()	Content[]	Ruft alle Knoten ab, die direkte untergeordnete Elemente des Dokuments sind.
getContent(index)	Content|null	Ruft den Knoten am angegebenen Index unter allen Knoten ab, die unmittelbare untergeordnete Elemente des Dokuments sind.
getContentSize()	Integer	Gibt die Anzahl der Knoten zurück, die unmittelbare untergeordnete Elemente des Dokuments sind.
getDescendants()	Content[]	Ruft alle Knoten ab, die direkte oder indirekte untergeordnete Elemente des Dokuments sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.
getDocType()	DocType|null	Ruft die DocType-Deklaration des Dokuments ab.
getRootElement()	Element|null	Ruft den Element-Knoten des Stammdokuments ab.
hasRootElement()	Boolean	Ermittelt, ob das Dokument einen Element-Stammknoten hat.
removeContent()	Content[]	Entfernt alle Knoten, die direkte untergeordnete Elemente des Dokuments sind.
removeContent(content)	Boolean	Entfernt den angegebenen Knoten, wenn er ein direkt untergeordnetes Element des Dokuments ist.
removeContent(index)	Content|null	Entfernt den Knoten am angegebenen Index unter allen Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.
setDocType(docType)	Document	Legt die DocType-Deklaration des Dokuments fest.
setRootElement(element)	Document	Legt den Element-Stammknoten des Dokuments fest.

Detaillierte Dokumentation

addContent(content)

Fügt den angegebenen Knoten am Ende des Dokuments an. Das Argument content kann ein Content-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht. Ein Dokument kann jedoch nur einen untergeordneten Element-Knoten haben, der implizit der Element-Stammknoten ist.

Parameter

Name	Typ	Beschreibung
content	Content	Der anzuhängende Knoten.

Rückflug

Document – Das Dokument zur Verkettung.

---

addContent(index, content)

Fügt den angegebenen Knoten am angegebenen Index unter allen Knoten ein, die unmittelbare untergeordnete Elemente des Dokuments sind. Das Argument content kann ein Content-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht. Ein Dokument kann jedoch nur einen untergeordneten Element-Knoten haben, der implizit der Element-Stammknoten ist.

Parameter

Name	Typ	Beschreibung
index	Integer	Der Index, an dem der Knoten unter allen Knoten eingefügt werden soll, die direkte untergeordnete Elemente des Dokuments sind.
content	Content	Der einzufügende Knoten.

Rückflug

Document – Das Dokument zur Verkettung.

---

cloneContent()

Erstellt nicht angehängte Kopien aller Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.

Rückflug

Content[]: Ein Array mit nicht angehängten Kopien aller Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.

---

detachRootElement()

Trennt den Element-Knoten des Dokuments ab und gibt ihn zurück. Wenn das Dokument keinen Element-Knoten auf der Stammebene hat, gibt diese Methode null zurück.

Rückflug

Element|null: Der getrennte Element-Knoten oder null, wenn das Dokument keinen Element-Stammknoten hat.

---

getAllContent()

Ruft alle Knoten ab, die direkte untergeordnete Elemente des Dokuments sind.

Rückflug

Content[]: Ein Array aller Knoten, die direkte untergeordnete Elemente des Dokuments sind.

---

getContent(index)

Ruft den Knoten am angegebenen Index unter allen Knoten ab, die unmittelbare untergeordnete Elemente des Dokuments sind. Wenn am angegebenen Index kein Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
index	Integer	Der Index für den Knoten unter allen Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.

Rückflug

Content|null: Der Knoten oder null, wenn am angegebenen Index kein Knoten vorhanden ist.

---

getContentSize()

Gibt die Anzahl der Knoten zurück, die unmittelbare untergeordnete Elemente des Dokuments sind.

Rückflug

Integer: Die Anzahl der Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.

---

getDescendants()

Ruft alle Knoten ab, die direkte oder indirekte untergeordnete Elemente des Dokuments sind, in der Reihenfolge, in der sie im Dokument angezeigt werden.

Rückflug

Content[]: Ein Array aller Knoten, die direkte oder indirekte untergeordnete Elemente des Dokuments sind.

---

getDocType()

Ruft die DocType-Deklaration des Dokuments ab. Wenn das Dokument keinen DocumentType-Knoten hat, gibt diese Methode null zurück.

Rückflug

DocType|null: Der Knoten DocumentType oder null, wenn das Dokument keinen Knoten DocumentType hat.

---

getRootElement()

Ruft den Element-Knoten des Stammdokuments ab. Wenn das Dokument keinen Element-Knoten auf der Stammebene hat, gibt diese Methode null zurück.

Rückflug

Element|null: Der Stammknoten Element oder null, wenn das Dokument keinen Stammknoten Element hat.

---

hasRootElement()

Ermittelt, ob das Dokument einen Element-Stammknoten hat.

Rückflug

Boolean – true, wenn das Dokument einen Element-Knoten auf der Stammebene hat, andernfalls false.

---

removeContent()

Entfernt alle Knoten, die direkte untergeordnete Elemente des Dokuments sind.

Rückflug

Content[]: Ein Array aller Knoten, die unmittelbare untergeordnete Elemente des Dokuments waren, bevor sie entfernt wurden.

---

removeContent(content)

Entfernt den angegebenen Knoten, wenn er ein direkt untergeordnetes Element des Dokuments ist. Das Argument content kann ein Content-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht.

Parameter

Name	Typ	Beschreibung
content	Content	Der zu entfernende Knoten.

Rückflug

Boolean – true, wenn der Knoten ein direkt untergeordnetes Element war und entfernt wurde; false, wenn nicht.

---

removeContent(index)

Entfernt den Knoten am angegebenen Index unter allen Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind. Wenn am angegebenen Index kein Knoten vorhanden ist, gibt diese Methode null zurück.

Parameter

Name	Typ	Beschreibung
index	Integer	Der Index für den Knoten unter allen Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.

Rückflug

Content|null: Der Knoten, der entfernt wurde, oder null, wenn am angegebenen Index kein Knoten vorhanden ist.

---

setDocType(docType)

Legt die DocType-Deklaration des Dokuments fest. Wenn das Dokument bereits einen anderen DocType-Knoten hat, wird der alte Knoten durch diese Methode überschrieben. Diese Methode löst eine Ausnahme aus, wenn das Dokument bereits denselben DocType-Knoten enthält, der festgelegt wird.

Parameter

Name	Typ	Beschreibung
docType	DocType	Die festzulegende DocumentType.

Rückflug

Document – Das Dokument zur Verkettung.

---

setRootElement(element)

Legt den Element-Stammknoten des Dokuments fest. Wenn das Dokument bereits einen Element-Stammknoten hat, wird der alte Knoten durch diese Methode überschrieben.

Parameter

Name	Typ	Beschreibung
element	Element	Der festzulegende Element-Stammknoten.

Rückflug

Document – Das Dokument zur Verkettung.