{{ DomRef() }}
A NodeFilter
interface represents an objecti used to filter the nodes in a {{ domxref("NodeIterator") }} or {{ domxref("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.
The browser doesn't provide any object implementing this interface. It is the user who is expected to write one, tailoring the acceptNode()
method to its needs, and using it with some {{domxref("TreeWalker")}} or {{domxref("NodeIterator")}} objects.
Properties
This interface neither implements, nor inherits, any property.
Methods
This interface doesn't inherit any method.
- {{domxref("NodeFilter.acceptNode")}}
-
Returns an
unsigned short
that will be used to tell if a given {{domxref("Node")}} must be accepted or not by the {{ domxref("NodeIterator") }} or {{ domxref("TreeWalker") }} iteration algorithm. This method is expected to be written by the user of aNodeFilter
. Possible return values are:Constant Description FILTER_ACCEPT
Value returned by the {{ domxref("NodeFilter.acceptNode()") }} method when a node should be accepted. FILTER_REJECT
Value to be returned by the {{ domxref("NodeFilter.acceptNode()") }} method when a node should be rejected. The children of rejected nodes are not visited by the {{ domxref("NodeIterator") }} or {{ domxref("TreeWalker") }} object; this value is treated as "skip this node and all its children". FILTER_SKIP
Value to be returned by {{ domxref("NodeFilter.acceptNode()") }} for nodes to be skipped by the {{ domxref("NodeIterator") }} or {{ domxref("TreeWalker") }} object. The children of skipped nodes are still considered. This is treated as "skip this node but not its children".
Example
var nodeIterator = document.createNodeIterator( // Node to use as root document.getElementById('someId'), // Only consider nodes that are text nodes (nodeType 3) NodeFilter.SHOW_TEXT, // Object containing the function to use for the acceptNode method // of the NodeFilter { acceptNode: function(node) { // Logic to determine whether to accept, reject or skip node // In this case, only accept nodes that have content // other than whitespace if ( ! /^\s*$/.test(node.data) ) { return NodeFilter.FILTER_ACCEPT; } } }, false ); // Show the content of every non-empty text node that is a child of root var node; while ((node = iterator.nextNode())) { alert(node.data); }
Specifications
Specification | Status | Comment |
---|---|---|
{{SpecName('DOM WHATWG', '#nodeFilter', 'NodeFilter')}} | {{Spec2('DOM WHATWG')}} | Removed the expandEntityReferences property. |
{{SpecName('DOM2 Traversal_Range', 'traversal.html#Traversal-NodeFilter', 'NodeFilter')}} | {{Spec2('DOM2 Traversal_Range')}} | Initial definition. |
Browser compatibility
{{CompatibilityTable}}
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | 1.0 | {{CompatGeckoDesktop("1.8.1")}} | 9.0 | 9.0 | 3.0 |
Feature | Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|
Basic support | {{CompatVersionUnknown}} | {{CompatGeckoMobile("1.8.1")}} | {{CompatVersionUnknown}} | 9.0 | 3.0 |
See also
- Related interfaces: {{domxref("TreeWalker")}}, {{domxref("NodeIterator")}}.