NodeIterator

L'interface NodeIterator représente un itérateur pour les membres d'une liste des nœuds dans un sous-arbre du DOM. Les nœuds seront renvoyés dans l'ordre du document.

Un NodeIterator peut être créé en utilisant la méthode Document.createNodeIterator(), comme suit :

js
var nodeIterator = document.createNodeIterator(root, whatToShow, filter);

Propriétés

L'interface n'hérite d'aucune propriété.

NodeIterator.root Lecture seule

Renvoie un Node (noeud) représentant le noeud racine comme spécifié lors de la création du NodeIterator.

NodeIterator.whatToShow Lecture seule

Renvoie un unsigned long (long non signé), celui-ci étant un masque constitué de constantes décrivant les types de Node (noeud) et devant être présenté. Les nœuds non correspondants sont ignorés, mais leurs enfants peuvent être inclus, le cas échéant. Les valeurs possibles sont :

Constante Valeur numérique Description
NodeFilter.SHOW_ALL -1 (c'est la valeur numérique maximale du unsigned long (non signé long)) Affiche tous les noeuds.
NodeFilter.SHOW_ATTRIBUTE 2 Affiche l'attribut Attr des noeuds. Cela n'a de sens que lors de la création d'un TreeWalker avec un noeud Attr comme racine ; dans ce cas, cela signifie que le nœud d'attribut apparaîtra dans la première position de l'itération ou de la traversée. Comme les attributs ne sont jamais des enfants d'autres nœuds, ils n'apparaissent pas lors de la traversée de l'arbre du document.
NodeFilter.SHOW_CDATA_SECTION 8 Affiche les noeuds CDATASection.
NodeFilter.SHOW_COMMENT 128 Affiche les noeuds Comment.
NodeFilter.SHOW_DOCUMENT 256 Affiche les noeuds Document.
NodeFilter.SHOW_DOCUMENT_FRAGMENT 1024 Affiche les noeuds DocumentFragment.
NodeFilter.SHOW_DOCUMENT_TYPE 512 Affiche les noeuds DocumentType.
NodeFilter.SHOW_ELEMENT 1 Affiche les noeuds Element.
NodeFilter.SHOW_ENTITY 32 Affiche les noeuds Entity. Cela n'a de sens que lors de la création d'un TreeWalker avec un noeud Entity comme racine ; dans ce cas, il signifie que le noeud d'entité Entity apparaîtra à la première position de la traversée. Étant donné que les entités ne font pas partie de l'arborescence du document, elles n'apparaissent pas lors de la traversée de l'arborescence du document.
NodeFilter.SHOW_ENTITY_REFERENCE 16 Affiche les noeuds EntityReference.
NodeFilter.SHOW_NOTATION 2048 Affiche les noeuds Notation. Cela n'a de sens que lors de la création d'un TreeWalker avec un noeud Notation comme racine ; dans ce cas, il signifie que le noeud Notation apparaîtra à la première position de la traversée. Étant donné que les entités ne font pas partie de l'arborescence du document, elles n'apparaissent pas lors de la traversée de l'arborescence du document.
NodeFilter.SHOW_PROCESSING_INSTRUCTION 64 Affiche les noeuds ProcessingInstruction.
NodeFilter.SHOW_TEXT 4 Affiche les noeuds Text.
NodeIterator.filter Lecture seule

Renvoie un NodeFilter utilisé pour sélectionner les noeuds pertinents.

NodeIterator.expandEntityReferences Lecture seule

est un Boolean (booléen) indiquant si, lors de la suppression d'une EntityReference, tout son sous-arbre doit être supprimé en même temps.

NodeIterator.referenceNode Lecture seule

Renvoie le Node (noeud) auquel l'itérateur est ancré.

NodeIterator.pointerBeforeReferenceNode Lecture seule

Renvoie un Boolean (booléen) qui indique si le NodeIterator est ancré avant (true (vrai)) ou après (false (faux)) le noeud d'ancrage.

Méthodes

Cette interface n'hérite d'aucune méthode.

NodeIterator.detach()

Cette opération est une non opération. Elle ne fait rien. Auparavant, elle disait au moteur que le NodeIterator n'était plus utilisé, mais c'est maintenant inutile.

NodeIterator.previousNode()

Renvoie le noeud Node précédent dans le document ou null s'il n'y en a aucun.

NodeIterator.nextNode()

Renvoie le noeud Node suivant dans le document ou null s'il n'y en a aucun.

Spécifications

Specification
DOM Standard
# interface-nodeiterator

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi