NodeFilter class

NodeFilter class

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

Inheritance: NodeFilter → DOMObject

The NodeFilter type exposes the following members:

Properties

PropertyDescription
FILTER_ACCEPTAccept the node. Navigation methods defined for
NodeIterator or TreeWalker will return this
node.
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.
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.
SHOW_ALLShow all Nodes.
SHOW_ELEMENTShow Element nodes.
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.
SHOW_TEXTShow Text nodes.
SHOW_CDATA_SECTIONShow CDATASection nodes.
SHOW_ENTITY_REFERENCEShow EntityReference nodes.
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.
SHOW_PROCESSING_INSTRUCTIONShow ProcessingInstruction nodes.
SHOW_COMMENTShow Comment nodes.
SHOW_DOCUMENTShow Document nodes.
SHOW_DOCUMENT_TYPEShow DocumentType nodes.
SHOW_DOCUMENT_FRAGMENTShow DocumentFragment nodes.
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.

Methods

MethodDescription
get_platform_typeThis method is used to retrieve ECMAScript object Type.
accept_nodeTest 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.)

See Also