Cette page a été traduite par l'API Cloud Translation.

Class Document

Représentation d'un document XML.

Méthodes

Méthode	Type renvoyé	Brève description
`addContent(content)`	`Document`	Ajoute le nœud donné à la fin du document.
`addContent(index, content)`	`Document`	Insère le nœud donné au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du document.
`cloneContent()`	`Content[]`	Crée des copies non associées de tous les nœuds qui sont des enfants immédiats du document.
`detachRootElement()`	`Element`	Dissocie et affiche le nœud `Element` racine du document.
`getAllContent()`	`Content[]`	Récupère tous les nœuds qui sont des enfants immédiats du document.
`getContent(index)`	`Content`	Récupère le nœud au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du document.
`getContentSize()`	`Integer`	Récupère le nombre de nœuds qui sont des enfants immédiats du document.
`getDescendants()`	`Content[]`	Récupère tous les nœuds qui sont des enfants directs ou indirects du document, dans l'ordre dans lequel ils apparaissent dans le document.
`getDocType()`	`DocType`	Récupère la déclaration `DocType` du document.
`getRootElement()`	`Element`	Récupère le nœud `Element` racine du document.
`hasRootElement()`	`Boolean`	Détermine si le document possède un nœud `Element` racine.
`removeContent()`	`Content[]`	Supprime tous les nœuds qui sont des enfants immédiats du document.
`removeContent(content)`	`Boolean`	Supprime le nœud donné si celui-ci est un enfant immédiat du document.
`removeContent(index)`	`Content`	Supprime le nœud au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du document.
`setDocType(docType)`	`Document`	Définit la déclaration `DocType` du document.
`setRootElement(element)`	`Document`	Définit le nœud `Element` racine du document.

Documentation détaillée

`addContent(content)`

Ajoute le nœud donné à la fin du document. L'argument content peut être un objet Content ou tout objet nœud correspondant à un type répertorié dans ContentType. Notez toutefois qu'un document ne peut avoir qu'un seul nœud Element enfant, qui est implicitement le nœud Element racine.

Paramètres

Nom	Type	Description
`content`	`Content`	nœud à ajouter

Renvois

Document : document, pour l'enchaînement

`addContent(index, content)`

Insère le nœud donné au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du document. L'argument content peut être un objet Content ou tout objet nœud correspondant à un type répertorié dans ContentType. Notez toutefois qu'un document ne peut avoir qu'un seul nœud Element enfant, qui est implicitement le nœud Element racine.

Paramètres

Nom	Type	Description
`index`	`Integer`	Index auquel insérer le nœud parmi tous les nœuds qui sont des enfants immédiats du document
`content`	`Content`	nœud à insérer

Renvois

Document : document, pour l'enchaînement

`cloneContent()`

Crée des copies non associées de tous les nœuds qui sont des enfants immédiats du document.

Renvois

Content[] : tableau de copies non associées de tous les nœuds qui sont des enfants immédiats du document

`detachRootElement()`

Dissocie et affiche le nœud Element racine du document. Si le document ne possède pas de nœud Element racine, cette méthode renvoie null.

Renvois

Element : nœud Element dissocié, ou null si le document ne possède pas de nœud Element racine

`getAllContent()`

Récupère tous les nœuds qui sont des enfants immédiats du document.

Renvois

Content[] : tableau de tous les nœuds qui sont des enfants immédiats du document

`getContent(index)`

Récupère le nœud au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du document. Si aucun nœud n'est disponible à l'index donné, cette méthode renvoie null.

Paramètres

Nom	Type	Description
`index`	`Integer`	l'index du nœud parmi tous les nœuds qui sont des enfants immédiats du document ;

Renvois

Content : nœud, ou null s'il n'y a aucun nœud à l'index donné

`getContentSize()`

Récupère le nombre de nœuds qui sont des enfants immédiats du document.

Renvois

Integer : nombre de nœuds qui sont des enfants immédiats du document

`getDescendants()`

Récupère tous les nœuds qui sont des enfants directs ou indirects du document, dans l'ordre dans lequel ils apparaissent dans le document.

Renvois

Content[] : tableau de tous les nœuds qui sont des enfants directs ou indirects du document

`getDocType()`

Récupère la déclaration DocType du document. Si le document ne comporte pas de nœud DocumentType, cette méthode renvoie null.

Renvois

DocType : nœud DocumentType ou null si le document ne comporte pas de nœud DocumentType

`getRootElement()`

Récupère le nœud Element racine du document. Si le document ne possède pas de nœud Element racine, cette méthode renvoie null.

Renvois

Element : nœud Element racine, ou null si le document n'a pas de nœud Element racine

`hasRootElement()`

Détermine si le document possède un nœud Element racine.

Renvois

Boolean : true si le document a un nœud Element racine ; false dans le cas contraire

`removeContent()`

Supprime tous les nœuds qui sont des enfants immédiats du document.

Renvois

Content[] : tableau de tous les nœuds qui étaient des enfants immédiats du document avant leur suppression

`removeContent(content)`

Supprime le nœud donné si celui-ci est un enfant immédiat du document. L'argument content peut être un objet Content ou tout objet de nœud correspondant à un type répertorié dans ContentType.

Paramètres

Nom	Type	Description
`content`	`Content`	le nœud à supprimer

Renvois

Boolean : true si le nœud était un enfant immédiat et a été supprimé ; false dans le cas contraire

`removeContent(index)`

Supprime le nœud au niveau de l'index donné parmi tous les nœuds qui sont des enfants immédiats du document. Si aucun nœud n'est disponible à l'index donné, cette méthode renvoie null.

Paramètres

Nom	Type	Description
`index`	`Integer`	l'index du nœud parmi tous les nœuds qui sont des enfants immédiats du document ;

Renvois

Content : nœud supprimé ou null s'il n'y a aucun nœud à l'index donné

`setDocType(docType)`

Définit la déclaration DocType du document. Si le document comporte déjà un autre nœud DocType, cette méthode écrase l'ancien nœud. Cette méthode génère une exception si le document contient déjà le même nœud DocType que celui en cours de définition.

Paramètres

Nom	Type	Description
`docType`	`DocType`	la `DocumentType` pour définir

Renvois

Document : document, pour l'enchaînement

`setRootElement(element)`

Définit le nœud Element racine du document. Si le document comporte déjà un nœud Element racine, cette méthode écrase l'ancien nœud.

Paramètres

Nom	Type	Description
`element`	`Element`	le nœud `Element` racine pour définir

Renvois

Document : document, pour l'enchaînement