NodeFilter Class

NodeFilter class

Filters are objects that know how to “filter out” nodes.

public abstract class NodeFilter : DOMObject, INodeFilter

Methods

NameDescription
abstract AcceptNode(Node)Test whether a specified node is visible in the logical view of a TreeWalker or NodeIterator. This function will be called by the implementation of TreeWalker and NodeIterator; it is not normally called directly from user code. (Though you could do so if you wanted to use the same filter to guide your own application logic.)
getPlatformType()This method is used to retrieve ECMAScript object Type.

Fields

NameDescription
const FILTER_ACCEPTAccept the node. Navigation methods defined for NodeIterator or TreeWalker will return this node.
const FILTER_REJECTReject the node. Navigation methods defined for NodeIterator or TreeWalker will not return this node. For TreeWalker, the children of this node will also be rejected. NodeIterators treat this as a synonym for FILTER_SKIP.
const FILTER_SKIPSkip this single node. Navigation methods defined for NodeIterator or TreeWalker will not return this node. For both NodeIterator and TreeWalker, the children of this node will still be considered.
const SHOW_ALLShow all Nodes.
const SHOW_ATTRIBUTEShow Attr nodes. This is meaningful only when creating an iterator or tree-walker with an attribute node as its root; in this case, it means that the attribute node will appear in the first position of the iteration or traversal. Since attributes are never children of other nodes, they do not appear when traversing over the document tree.
const SHOW_CDATA_SECTIONShow CDATASection nodes.
const SHOW_COMMENTShow Comment nodes.
const SHOW_DOCUMENTShow Document nodes.
const SHOW_DOCUMENT_FRAGMENTShow DocumentFragment nodes.
const SHOW_DOCUMENT_TYPEShow DocumentType nodes.
const SHOW_ELEMENTShow Element nodes.
const SHOW_ENTITYShow Entity nodes. This is meaningful only when creating an iterator or tree-walker with an Entity node as its root; in this case, it means that the Entity node will appear in the first position of the traversal. Since entities are not part of the document tree, they do not appear when traversing over the document tree.
const SHOW_ENTITY_REFERENCEShow EntityReference nodes.
const SHOW_NOTATIONShow Notation nodes. This is meaningful only when creating an iterator or tree-walker with a Notation node as its root; in this case, it means that the Notation node will appear in the first position of the traversal. Since notations are not part of the document tree, they do not appear when traversing over the document tree.
const SHOW_PROCESSING_INSTRUCTIONShow ProcessingInstruction nodes.
const SHOW_TEXTShow Text nodes.

See Also