TreeWalker

Proprits

Cette interface n'hrite d'aucune proprit.

TreeWalker.root Lecture seule

Renvoie un Node (noeud) reprsentant le noeud racine comme spcifi lors de la cration du TreeWalker.

TreeWalker.whatToShow Lecture seule

Renvoie un unsigned long (long non sign), celui-ci tant un masque constitu de constantes dcrivant les types de Node qui doivent tre prsents. Les noeuds ne correspondants pas sont ignors, mais leurs enfants peuvent tre inclus, le cas chant. Les valeurs possibles sont :

Constante	Valeur numrique	Description
NodeFilter.SHOW_ALL	-1 (c'est la valeur numrique 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 cration d'un TreeWalker avec un noeud Attr comme racine ; dans ce cas, cela signifie que le nud d'attribut apparatra dans la premire position de l'itration ou de la traverse. Comme les attributs ne sont jamais des enfants d'autres nuds, ils n'apparaissent pas lors de la traverse 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 cration d'un TreeWalker avec un noeud Entity comme racine ; dans ce cas, il signifie que le noeud d'entit Entity apparatra la premire position de la traverse. tant donn que les entits ne font pas partie de l'arborescence du document, elles n'apparaissent pas lors de la traverse 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 cration d'un TreeWalker avec un noeud Notation comme racine ; dans ce cas, il signifie que le noeud Notation apparatra la premire position de la traverse. tant donn que les entits ne font pas partie de l'arborescence du document, elles n'apparaissent pas lors de la traverse 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 slectionner les noeuds pertinents.

TreeWalker.expandEntityReferences Lecture seule

est un Boolean (boolen) indiquant si, lors de la suppression d'une EntityReference, tout son sous-arbre doit tre supprim en mme temps.

TreeWalker.currentNode

est le Node sur lequel le TreeWalker pointe actuellement.

Mthodes

Cette interface n'hrite d'aucune mthode.

TreeWalker.parentNode()

Dplace le Node actuel vers le premier noeud anctre visible dans l'ordre du document et renvoie le noeud trouv. Il dplace galement le noeud actuel vers celui-ci. Si aucun noeud n'existe ou s'il est antrieur au noeud racine dfini lors de la construction de l'objet, renvoie null et le noeud courant n'est pas modifi.

TreeWalker.firstChild()

Dplace le Node courant vers son premier enfant visible et renvoie l'enfant trouv. Il dplace galement le noeud courant vers cet enfant. Si aucun enfant n'existe, renvoie null et le noeud courant n'est pas modifi.

TreeWalker.lastChild()

Dplace le Node courant vers son dernier enfant visible et renvoie l'enfant trouv. Il dplace galement le noeud courant vers l'enfant. Si aucun enfant n'existe, renvoie null et le noeud courant n'est pas modifi.

TreeWalker.previousSibling()

Dplace le Node courant vers son frre prcdent, le cas chant, et renvoie le frre trouv. Si aucun noeud frre n'existe, renvoie null et le noeud courant n'est pas modifi.

TreeWalker.nextSibling()

Dplace le Node courant vers son frre suivant, le cas chant, et renvoie le frre trouv. Si aucun noeud frre n'existe, renvoie null et le noeud courant n'est pas modifi.

TreeWalker.previousNode()

Dplace le Node courant vers le noeud visible prcdent dans l'ordre du document et renvoie le noeud trouv. Il dplace galement le noeud courant vers celui-ci. Si aucun noeud n'existe ou s'il est avant le noeud racine dfini lors de la construction de l'objet, renvoie null et le noeud courant n'est pas modifi.

TreeWalker.nextNode()

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

Spcifications

Compatibilit des navigateurs

Voir aussi

• La mthode de cration : Document.createTreeWalker().
• Interfaces connexes : NodeFilter, NodeIterator.