TreeWalker
==========

L'objet **`TreeWalker`** représente les noeuds d'un sous-arbre de document et une position à l'intérieur.

Un `TreeWalker` peut être créé en utilisant la méthode `Document.createTreeWalker()`.

Propriétés
----------

*Cette interface n'hérite d'aucune propriété.*

`TreeWalker.root` Lecture seule 

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

`TreeWalker.whatToShow` Lecture seule 

Renvoie un `unsigned long` (*long non signé*), celui-ci étant un masque constitué de constantes décrivant les types de `Node` qui doivent être présentés. Les noeuds ne correspondants pas 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` 
Obsolète
 | `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` 
Obsolète
 | `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` 
Obsolète
 | `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`

Obsolète
 | `16` | Affiche les noeuds `EntityReference`. |
| `NodeFilter.SHOW_NOTATION` 
Obsolète
 | `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`. |

`TreeWalker.filter` Lecture seule 

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

`TreeWalker.expandEntityReferences` Lecture seule 
Obsolète

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

`TreeWalker.currentNode`

est le `Node` sur lequel le `TreeWalker` pointe actuellement.

Méthodes
--------

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

**Note :** Le TreeWalker considère uniquement les nœuds DOM visibles.

`TreeWalker.parentNode()`

Déplace le `Node` actuel vers le premier noeud ancêtre *visible* dans l'ordre du document et renvoie le noeud trouvé. Il déplace également le noeud actuel vers celui-ci. Si aucun noeud n'existe ou s'il est antérieur au *noeud racine* défini lors de la construction de l'objet, renvoie `null` et le noeud courant n'est pas modifié.

`TreeWalker.firstChild()`

Déplace le `Node` courant vers son premier enfant *visible* et renvoie l'enfant trouvé. Il déplace également le noeud courant vers cet enfant. Si aucun enfant n'existe, renvoie `null` et le noeud courant n'est pas modifié.

`TreeWalker.lastChild()`

Déplace le `Node` courant vers son dernier enfant *visible* et renvoie l'enfant trouvé. Il déplace également le noeud courant vers l'enfant. Si aucun enfant n'existe, renvoie `null` et le noeud courant n'est pas modifié.

`TreeWalker.previousSibling()`

Déplace le `Node` courant vers son frère précédent, le cas échéant, et renvoie le frère trouvé. Si aucun noeud frère n'existe, renvoie `null` et le noeud courant n'est pas modifié.

`TreeWalker.nextSibling()`

Déplace le `Node` courant vers son frère suivant, le cas échéant, et renvoie le frère trouvé. Si aucun noeud frère n'existe, renvoie `null` et le noeud courant n'est pas modifié.

`TreeWalker.previousNode()`

Déplace le `Node` courant vers le noeud *visible* précédent dans l'ordre du document et renvoie le noeud trouvé. Il déplace également le noeud courant vers celui-ci. Si aucun noeud n'existe ou s'il est avant le *noeud racine* défini lors de la construction de l'objet, renvoie `null` et le noeud courant n'est pas modifié.

`TreeWalker.nextNode()`

Déplace le `Node` courant vers le noeud *visible* suivant dans l'ordre du document et renvoie le noeud trouvé. Il déplace également le noeud courant vers celui-ci. Si aucun noeud n'existe ou s'il est avant le *noeud racine* défini lors de la construction de l'objet, renvoie `null` et le noeud courant n'est pas modifié.

Spécifications
--------------

| Specification |
| --- |
| DOM Standard # interface-treewalker |

Compatibilité des navigateurs
-----------------------------

BCD tables only load in the browser with JavaScript enabled. Enable JavaScript to view data.

Voir aussi
----------

* La méthode de création : `Document.createTreeWalker()`.
* Interfaces connexes : `NodeFilter`, `NodeIterator`.