Class Document

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é à l'index donné parmi tous les nœuds qui sont des enfants immédiats du document.
cloneContent()	Content[]	Crée des copies non rattachées de tous les nœuds qui sont des enfants immédiats du document.
detachRootElement()	Element|null	Détache et renvoie le nœud racine Element du document.
getAllContent()	Content[]	Récupère tous les nœuds qui sont des enfants immédiats du document.
getContent(index)	Content|null	Obtient le nœud à l'index donné parmi tous les nœuds qui sont des enfants immédiats du document.
getContentSize()	Integer	Obtient 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|null	Obtient la déclaration DocType du document.
getRootElement()	Element|null	Obtient le nœud Element racine du document.
hasRootElement()	Boolean	Détermine si le document comporte 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é, s'il s'agit d'un enfant immédiat du document.
removeContent(index)	Content|null	Supprime le nœud à 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 n'importe quel objet de nœud correspondant à un type listé dans ContentType. Notez toutefois qu'un document ne peut comporter qu'un seul nœud enfant Element, qui est implicitement le nœud racine Element.

Paramètres

Nom	Type	Description
content	Content	Nœud à ajouter.

Renvois

Document : le document, pour le chaînage.

---

addContent(index, content)

Insère le nœud donné à 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 n'importe quel objet de nœud correspondant à un type listé dans ContentType. Notez toutefois qu'un document ne peut comporter qu'un seul nœud enfant Element, 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 directs du document.
content	Content	Nœud à insérer.

Renvois

Document : le document, pour le chaînage.

---

cloneContent()

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

Renvois

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

---

detachRootElement()

Détache et renvoie le nœud racine Element du document. Si le document ne comporte pas de nœud Element racine, cette méthode renvoie null.

Renvois

Element|null : nœud Element détaché ou null si le document ne comporte 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 à l'index donné parmi tous les nœuds qui sont des enfants immédiats du document. Si aucun nœud ne se trouve à l'index donné, cette méthode renvoie null.

Paramètres

Nom	Type	Description
index	Integer	Index du nœud parmi tous les nœuds qui sont des enfants immédiats du document.

Renvois

Content|null : le nœud, ou null s'il n'y a pas de nœud à l'index donné.

---

getContentSize()

Obtient 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()

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

Renvois

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

---

getRootElement()

Obtient le nœud Element racine du document. Si le document ne comporte pas de nœud racine Element, cette méthode renvoie null.

Renvois

Element|null : nœud Element racine ou null si le document ne comporte pas de nœud Element racine.

---

hasRootElement()

Détermine si le document comporte un nœud Element racine.

Renvois

Boolean : true si le document comporte un nœud racine Element, 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é, s'il s'agit d'un enfant immédiat du document. L'argument content peut être un objet Content ou n'importe quel objet de nœud correspondant à un type listé dans ContentType.

Paramètres

Nom	Type	Description
content	Content	Nœud à supprimer.

Renvois

Boolean : true si le nœud était un enfant immédiat et a été supprimé, false sinon.

---

removeContent(index)

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

Paramètres

Nom	Type	Description
index	Integer	Index du nœud parmi tous les nœuds qui sont des enfants immédiats du document.

Renvois

Content|null : nœud supprimé ou null s'il n'y a pas de nœud à l'index donné.

---

setDocType(docType)

Définit la déclaration DocType du document. Si le document comporte déjà un nœud DocType différent, cette méthode écrase l'ancien nœud. Cette méthode lève une exception si le document contient déjà le même nœud DocType que celui qui est défini.

Paramètres

Nom	Type	Description
docType	DocType	DocumentType à définir.

Renvois

Document : le document, pour le chaînage.

---

setRootElement(element)

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

Paramètres

Nom	Type	Description
element	Element	Nœud Element racine à définir.

Renvois

Document : le document, pour le chaînage.