Class Document

Dokument

Eine Darstellung eines XML-Dokuments.

Methoden

MethodeRückgabetypKurzbeschreibung
addContent(content)DocumentFügt den angegebenen Knoten am Ende des Dokuments an.
addContent(index, content)DocumentFügt den angegebenen Knoten an der angegebenen Position 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|nullLöst den Stammknoten Element des Dokuments und gibt ihn zurück.
getAllContent()Content[]Ruft alle Knoten ab, die unmittelbare untergeordnete Elemente des Dokuments sind.
getContent(index)Content|nullRuft den Knoten an der angegebenen Position unter allen Knoten ab, die unmittelbare untergeordnete Elemente des Dokuments sind.
getContentSize()IntegerRuft die Anzahl der Knoten ab, 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|nullRuft die DocType Deklaration des Dokuments ab.
getRootElement()Element|nullRuft den Stammknoten Element des Dokuments ab.
hasRootElement()BooleanBestimmt, ob das Dokument einen Stammknoten Element hat.
removeContent()Content[]Entfernt alle Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.
removeContent(content)BooleanEntfernt den angegebenen Knoten, wenn er ein unmittelbares untergeordnetes Element des Dokuments ist.
removeContent(index)Content|nullEntfernt den Knoten an der angegebenen Position unter allen Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.
setDocType(docType)DocumentLegt die DocType-Deklaration des Dokuments fest.
setRootElement(element)DocumentLegt den Stammknoten Element des Dokuments fest.

Detaillierte Dokumentation

addContent(content)

Fügt den angegebenen Knoten am Ende des Dokuments an. Das content Argument 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 Stammknoten Element ist.

Parameter

NameTypBeschreibung
contentContentDer anzuhängende Knoten.

Rückgabe

Document – Das Dokument für die Verkettung.

addContent(index, content)

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

Parameter

NameTypBeschreibung
indexIntegerDie Position, an der der Knoten unter allen Knoten eingefügt werden soll, die unmittelbare untergeordnete Elemente des Dokuments sind.
contentContentDer einzufügende Knoten.

Rückgabe

Document – Das Dokument für die Verkettung.

cloneContent()

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

Rückgabe

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

detachRootElement()

Löst den Stammknoten Element des Dokuments und gibt ihn zurück. Wenn das Dokument keinen Stammknoten Element hat, gibt diese Methode null zurück.

Rückgabe

Element|null – Der gelöste Knoten Element oder null, wenn das Dokument keinen Stammknoten Element hat.

getAllContent()

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

Rückgabe

Content[] – Ein Array mit allen Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.

getContent(index)

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

Parameter

NameTypBeschreibung
indexIntegerDie Position des Knotens unter allen Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.

Rückgabe

Content|null – Der Knoten oder null, wenn an der angegebenen Position kein Knoten vorhanden ist.

getContentSize()

Ruft die Anzahl der Knoten ab, die unmittelbare untergeordnete Elemente des Dokuments sind.

Rückgabe

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ückgabe

Content[] – Ein Array mit allen 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ückgabe

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

getRootElement()

Ruft den Stammknoten Element des Dokuments ab. Wenn das Dokument keinen Stammknoten Element hat, gibt diese Methode null zurück.

Rückgabe

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

hasRootElement()

Bestimmt, ob das Dokument einen Stammknoten Element hat.

Rückgabe

Boolean – true, wenn das Dokument einen Stammknoten Element hat, andernfalls false.

removeContent()

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

Rückgabe

Content[] – Ein Array mit allen Knoten, die unmittelbare untergeordnete Elemente des Dokuments waren, bevor sie entfernt wurden.

removeContent(content)

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

Parameter

NameTypBeschreibung
contentContentDer zu entfernende Knoten.

Rückgabe

Boolean – true, wenn der Knoten ein unmittelbares untergeordnetes Element war und entfernt wurde, andernfalls false.

removeContent(index)

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

Parameter

NameTypBeschreibung
indexIntegerDie Position des Knotens unter allen Knoten, die unmittelbare untergeordnete Elemente des Dokuments sind.

Rückgabe

Content|null – Der entfernte Knoten oder null, wenn an der angegebenen Position kein Knoten vorhanden ist.

setDocType(docType)

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

Parameter

NameTypBeschreibung
docTypeDocTypeDer DocumentType festzulegende.

Rückgabe

Document – Das Dokument für die Verkettung.

setRootElement(element)

Legt den Stammknoten Element des Dokuments fest. Wenn das Dokument bereits einen Stammknoten Element hat, überschreibt diese Methode den alten Knoten.

Parameter

NameTypBeschreibung
elementElementDer festzulegende Stammknoten Element.

Rückgabe

Document – Das Dokument für die Verkettung.