TreeWalker class / dart:html Library / Dart API Reference

TreeWalker class

The TreeWalker object represents the nodes of a document subtree and a position within them.

A TreeWalker can be created using the createTreeWalker() method of the document object.

@DomName('TreeWalker')
@Unstable
class TreeWalker native "TreeWalker" {
 factory TreeWalker(Node root, int whatToShow) {
   return document.$dom_createTreeWalker(root, whatToShow, null, false);
 }

 @DomName('TreeWalker.currentNode')
 @DocsEditable
 Node currentNode;

 @DomName('TreeWalker.expandEntityReferences')
 @DocsEditable
 // http://dom.spec.whatwg.org/#dom-traversal
 @deprecated // deprecated
 final bool expandEntityReferences;

 @DomName('TreeWalker.filter')
 @DocsEditable
 final NodeFilter filter;

 @DomName('TreeWalker.root')
 @DocsEditable
 final Node root;

 @DomName('TreeWalker.whatToShow')
 @DocsEditable
 final int whatToShow;

 @DomName('TreeWalker.firstChild')
 @DocsEditable
 Node firstChild() native;

 @DomName('TreeWalker.lastChild')
 @DocsEditable
 Node lastChild() native;

 @DomName('TreeWalker.nextNode')
 @DocsEditable
 Node nextNode() native;

 @DomName('TreeWalker.nextSibling')
 @DocsEditable
 Node nextSibling() native;

 @DomName('TreeWalker.parentNode')
 @DocsEditable
 Node parentNode() native;

 @DomName('TreeWalker.previousNode')
 @DocsEditable
 Node previousNode() native;

 @DomName('TreeWalker.previousSibling')
 @DocsEditable
 Node previousSibling() native;

}

Extends

Interceptor > TreeWalker

Constructors

factory TreeWalker(Node root, int whatToShow) #

factory TreeWalker(Node root, int whatToShow) {
 return document.$dom_createTreeWalker(root, whatToShow, null, false);
}

Properties

Node currentNode #

Node currentNode

final bool expandEntityReferences #

final bool expandEntityReferences

final NodeFilter filter #

final NodeFilter filter

final int hashCode #

inherited from Interceptor

Get a hash code for this object.

All objects have hash codes. Hash codes are guaranteed to be the same for objects that are equal when compared using the equality operator ==. Other than that there are no guarantees about the hash codes. They will not be consistent between runs and there are no distribution guarantees.

If a subclass overrides hashCode it should override the equality operator as well to maintain consistency.

docs inherited from Object

int get hashCode => Primitives.objectHashCode(this);

final Node root #

final Node root

final Type runtimeType #

inherited from Interceptor

A representation of the runtime type of the object.

docs inherited from Object

Type get runtimeType => getRuntimeType(this);

final int whatToShow #

final int whatToShow

Operators

bool operator ==(other) #

inherited from Interceptor

The equality operator.

The default behavior for all Objects is to return true if and only if this and other are the same object.

If a subclass overrides the equality operator it should override the hashCode method as well to maintain consistency.

docs inherited from Object

bool operator ==(other) => identical(this, other);

Methods

Node firstChild() #

@DomName('TreeWalker.firstChild')
@DocsEditable
Node firstChild() native;

Node lastChild() #

@DomName('TreeWalker.lastChild')
@DocsEditable
Node lastChild() native;

Node nextNode() #

@DomName('TreeWalker.nextNode')
@DocsEditable
Node nextNode() native;

Node nextSibling() #

@DomName('TreeWalker.nextSibling')
@DocsEditable
Node nextSibling() native;

dynamic noSuchMethod(Invocation invocation) #

inherited from Interceptor

noSuchMethod is invoked when users invoke a non-existant method on an object. The name of the method and the arguments of the invocation are passed to noSuchMethod in an Invocation. If noSuchMethod returns a value, that value becomes the result of the original invocation.

The default behavior of noSuchMethod is to throw a noSuchMethodError.

docs inherited from Object

dynamic noSuchMethod(Invocation invocation) {
 throw new NoSuchMethodError(
     this,
     _symbolToString(invocation.memberName),
     invocation.positionalArguments,
     _symbolMapToStringMap(invocation.namedArguments));
}

Node parentNode() #

@DomName('TreeWalker.parentNode')
@DocsEditable
Node parentNode() native;

Node previousNode() #

@DomName('TreeWalker.previousNode')
@DocsEditable
Node previousNode() native;

Node previousSibling() #

@DomName('TreeWalker.previousSibling')
@DocsEditable
Node previousSibling() native;

String toString() #

inherited from Interceptor

Returns a string representation of this object.

docs inherited from Object

String toString() => Primitives.objectToString(this);

This page includes content from the Mozilla Foundation that is graciously licensed under a Creative Commons: Attribution-Sharealike license. Mozilla has no other association with Dart or dartlang.org. We encourage you to improve the web by contributing to The Mozilla Developer Network.