NodeFilter

package js.html

@:native("NodeFilter") Available on js

A NodeFilter interface represents an object used to filter the nodes in a NodeIterator or TreeWalker. They don't know anything about the DOM or how to traverse nodes; they just know how to evaluate a single node against the provided filter.

Documentation NodeFilter by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See:

https://developer.mozilla.org/en-US/docs/Web/API/NodeFilter

Methods

acceptNode (node:Node):Int

Returns an unsigned short that will be used to tell if a given Node must be accepted or not by the NodeIterator or TreeWalker iteration algorithm. This method is expected to be written by the user of a NodeFilter. Possible return values are:

Constant	Description
FILTER_ACCEPT	Value returned by the NodeFilter.acceptNode() method when a node should be accepted.
FILTER_REJECT	Value to be returned by the NodeFilter.acceptNode() method when a node should be rejected. For TreeWalker, child nodes are also rejected. For NodeIterator, this flag is synonymous with FILTER_SKIP.
FILTER_SKIP	Value to be returned by NodeFilter.acceptNode() for nodes to be skipped by the NodeIterator or TreeWalker object. The children of skipped nodes are still considered. This is treated as "skip this node but not its children".

Static variables

@:value(1) static inline read only FILTER_ACCEPT:Int = 1

@:value(2) static inline read only FILTER_REJECT:Int = 2

@:value(3) static inline read only FILTER_SKIP:Int = 3

@:value(cast 4294967295) static inline read only SHOW_ALL:Int = cast 4294967295

@:value(2) static inline read only SHOW_ATTRIBUTE:Int = 2

@:value(8) static inline read only SHOW_CDATA_SECTION:Int = 8

@:value(128) static inline read only SHOW_COMMENT:Int = 128

@:value(256) static inline read only SHOW_DOCUMENT:Int = 256

@:value(1024) static inline read only SHOW_DOCUMENT_FRAGMENT:Int = 1024

@:value(512) static inline read only SHOW_DOCUMENT_TYPE:Int = 512

@:value(1) static inline read only SHOW_ELEMENT:Int = 1

@:value(32) static inline read only SHOW_ENTITY:Int = 32

@:value(16) static inline read only SHOW_ENTITY_REFERENCE:Int = 16

@:value(2048) static inline read only SHOW_NOTATION:Int = 2048

@:value(64) static inline read only SHOW_PROCESSING_INSTRUCTION:Int = 64

@:value(4) static inline read only SHOW_TEXT:Int = 4