Class Document

Document

Eine Darstellung eines XML-Dokuments.

Methoden

MethodeRückgabetypKurzbeschreibung
addContent(content)DocumentHängt den angegebenen Knoten an das Ende des Dokuments an.
addContent(index, content)DocumentFügt den angegebenen Knoten beim angegebenen Index unter allen Knoten ein, die dem Dokument unmittelbar untergeordnet sind.
cloneContent()Content[]Erstellt nicht angehängte Kopien aller Knoten, die dem Dokument unmittelbar untergeordnet sind.
detachRootElement()ElementTrennt den Element-Stammknoten des Dokuments und gibt ihn zurück.
getAllContent()Content[]Ruft alle Knoten ab, die dem Dokument unmittelbar untergeordnet sind.
getContent(index)ContentRuft den Knoten beim angegebenen Index aus allen Knoten ab, die dem Dokument unmittelbar untergeordnet sind.
getContentSize()IntegerRuft die Anzahl der Knoten ab, die dem Dokument unmittelbar untergeordnet sind.
getDescendants()Content[]Ruft alle Knoten, die dem Dokument direkt oder indirekt untergeordnet sind, in der Reihenfolge ab, in der sie im Dokument angezeigt werden.
getDocType()DocTypeRuft die DocType-Deklaration des Dokuments ab.
getRootElement()ElementRuft den Element-Stammknoten des Dokuments ab.
hasRootElement()BooleanBestimmt, ob das Dokument einen Element-Stammknoten hat.
removeContent()Content[]Entfernt alle Knoten, die dem Dokument unmittelbar untergeordnet sind.
removeContent(content)BooleanEntfernt den angegebenen Knoten, wenn der Knoten dem Dokument unmittelbar untergeordnet ist.
removeContent(index)ContentEntfernt den Knoten am angegebenen Index aus allen Knoten, die dem Dokument unmittelbar untergeordnet sind.
setDocType(docType)DocumentLegt die DocType-Deklaration des Dokuments fest.
setRootElement(element)DocumentLegt den Element-Stammknoten des Dokuments fest.

Detaillierte Dokumentation

addContent(content)

Hängt den angegebenen Knoten an das 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 Stammknoten Element ist.

Parameter

NameTypBeschreibung
contentContentAnzuhängender Knoten

Return

Document: das Dokument für die Verkettung


addContent(index, content)

Fügt den angegebenen Knoten beim angegebenen Index unter allen Knoten ein, die dem Dokument unmittelbar untergeordnet 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 Stammknoten Element ist.

Parameter

NameTypBeschreibung
indexIntegerIndex, an dem der Knoten unter allen Knoten eingefügt werden soll, die dem Dokument unmittelbar untergeordnet sind
contentContentKnoten, der eingefügt werden soll

Return

Document: das Dokument für die Verkettung


cloneContent()

Erstellt nicht angehängte Kopien aller Knoten, die dem Dokument unmittelbar untergeordnet sind.

Return

Content[]: ein Array nicht angehängter Kopien aller Knoten, die dem Dokument unmittelbar untergeordnet sind


detachRootElement()

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

Return

Element – der getrennte Element-Knoten oder null, wenn das Dokument keinen Element-Stammknoten hat


getAllContent()

Ruft alle Knoten ab, die dem Dokument unmittelbar untergeordnet sind.

Return

Content[]: ein Array aller Knoten, die dem Dokument unmittelbar untergeordnet sind


getContent(index)

Ruft den Knoten beim angegebenen Index aus allen Knoten ab, die dem Dokument unmittelbar untergeordnet sind. Wenn sich am angegebenen Index kein Knoten befindet, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
indexIntegerIndex für den Knoten unter allen Knoten, die dem Dokument unmittelbar untergeordnet sind

Return

Content: der Knoten oder null, wenn sich am angegebenen Index kein Knoten befindet


getContentSize()

Ruft die Anzahl der Knoten ab, die dem Dokument unmittelbar untergeordnet sind.

Return

Integer: die Anzahl der Knoten, die dem Dokument unmittelbar untergeordnet sind


getDescendants()

Ruft alle Knoten, die dem Dokument direkt oder indirekt untergeordnet sind, in der Reihenfolge ab, in der sie im Dokument angezeigt werden.

Return

Content[]: ein Array aller Knoten, die dem Dokument direkt oder indirekt untergeordnet sind


getDocType()

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

Return

DocType: der DocumentType-Knoten oder null, wenn das Dokument keinen DocumentType-Knoten hat


getRootElement()

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

Return

Element: der Element-Stammknoten oder null, wenn das Dokument keinen Element-Stammknoten hat


hasRootElement()

Bestimmt, ob das Dokument einen Element-Stammknoten hat.

Return

Boolean: true, wenn das Dokument einen Element-Stammknoten hat; false, wenn nicht


removeContent()

Entfernt alle Knoten, die dem Dokument unmittelbar untergeordnet sind.

Return

Content[]: ein Array aller Knoten, die unmittelbar dem Dokument untergeordnet waren, bevor sie entfernt wurden


removeContent(content)

Entfernt den angegebenen Knoten, wenn der Knoten dem Dokument unmittelbar untergeordnet ist. Das Argument content kann ein Content-Objekt oder ein beliebiges Knotenobjekt sein, das einem in ContentType aufgeführten Typ entspricht.

Parameter

NameTypBeschreibung
contentContentZu entfernender Knoten

Return

Boolean: true, wenn der Knoten ein unmittelbar untergeordnetes Element war und entfernt wurde; false, wenn nicht


removeContent(index)

Entfernt den Knoten am angegebenen Index aus allen Knoten, die dem Dokument unmittelbar untergeordnet sind. Wenn sich am angegebenen Index kein Knoten befindet, gibt diese Methode null zurück.

Parameter

NameTypBeschreibung
indexIntegerIndex für den Knoten unter allen Knoten, die dem Dokument unmittelbar untergeordnet sind

Return

Content – Der Knoten, der entfernt wurde, oder null, wenn sich am angegebenen Index kein Knoten befindet


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 gibt eine Ausnahme aus, wenn das Dokument bereits denselben DocType-Knoten enthält, der gerade festgelegt wird.

Parameter

NameTypBeschreibung
docTypeDocTypeDocumentType, der festgelegt werden soll

Return

Document: das Dokument für die Verkettung


setRootElement(element)

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

Parameter

NameTypBeschreibung
elementElementden festzulegenden Element-Stammknoten

Return

Document: das Dokument für die Verkettung