Skip navigation links
com.aspose.html.dom.traversal.filters

Class NodeFilter

  • All Implemented Interfaces:
    INodeFilter

    public abstract class NodeFilter
extends Object
implements INodeFilter

    Filters are objects that know how to "filter out" nodes.

    • Field Detail

      • FILTER_ACCEPT

        public static final short FILTER_ACCEPT

        Accept the node. Navigation methods defined for NodeIterator or TreeWalker will return this node.

        See Also:
        Constant Field Values

      • FILTER_REJECT

        public static final short FILTER_REJECT

        Reject 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.

        See Also:
        Constant Field Values

      • FILTER_SKIP

        public static final short FILTER_SKIP

        Skip 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.

        See Also:
        Constant Field Values

      • SHOW_ELEMENT

        public static final long SHOW_ELEMENT

        Show Element nodes.

        See Also:
        Constant Field Values

      • SHOW_ATTRIBUTE

        public static final long SHOW_ATTRIBUTE

        Show 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.

        See Also:
        Constant Field Values

      • SHOW_CDATA_SECTION

        public static final long SHOW_CDATA_SECTION

        Show CDATASection nodes.

        See Also:
        Constant Field Values

      • SHOW_ENTITY_REFERENCE

        public static final long SHOW_ENTITY_REFERENCE

        Show EntityReference nodes.

        See Also:
        Constant Field Values

      • SHOW_ENTITY

        public static final long SHOW_ENTITY

        Show 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.

        See Also:
        Constant Field Values

      • SHOW_PROCESSING_INSTRUCTION

        public static final long SHOW_PROCESSING_INSTRUCTION

        Show ProcessingInstruction nodes.

        See Also:
        Constant Field Values

      • SHOW_COMMENT

        public static final long SHOW_COMMENT

        Show Comment nodes.

        See Also:
        Constant Field Values

      • SHOW_DOCUMENT

        public static final long SHOW_DOCUMENT

        Show Document nodes.

        See Also:
        Constant Field Values

      • SHOW_DOCUMENT_TYPE

        public static final long SHOW_DOCUMENT_TYPE

        Show DocumentType nodes.

        See Also:
        Constant Field Values

      • SHOW_DOCUMENT_FRAGMENT

        public static final long SHOW_DOCUMENT_FRAGMENT

        Show DocumentFragment nodes.

        See Also:
        Constant Field Values

      • SHOW_NOTATION

        public static final long SHOW_NOTATION

        Show 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.

        See Also:
        Constant Field Values

      • ANY

        public static final NodeFilter ANY

        Represents an empty filter that allows any node to pass

    • Constructor Detail

      • NodeFilter

        public NodeFilter()

    • Method Detail

      • getFilterNodeType

        public static long getFilterNodeType(Node node)

      • acceptNode

        public abstract short acceptNode(Node n)

        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.)

        Specified by:
        acceptNode in interface INodeFilter
        Parameters:
        n - node to check to see if it passes the filter or not.
        Returns:
        a constant to determine whether the node is accepted, rejected, or skipped, as defined above.