elemental.traversal

Interface NodeFilter

All Known Implementing Classes:

JsNodeFilter

public interface NodeFilter

Field Summary

Fields

Modifier and Type	Field and Description
static short	FILTER_ACCEPT Value returned by the NodeFilter.acceptNode() method when a node should be accepted.
static short	FILTER_REJECT Value to be returned by the NodeFilter.acceptNode() method when a node should be rejected.
static short	FILTER_SKIP Value to be returned by NodeFilter.acceptNode() for nodes to be skipped by the NodeIterator or TreeWalker object.
static int	SHOW_ALL Shows all nodes.
static int	SHOW_ATTRIBUTE Shows attribute Attr nodes.
static int	SHOW_CDATA_SECTION Shows CDATASection nodes.
static int	SHOW_COMMENT Shows Comment nodes.
static int	SHOW_DOCUMENT Shows Document nodes.
static int	SHOW_DOCUMENT_FRAGMENT Shows DocumentFragment nodes.
static int	SHOW_DOCUMENT_TYPE Shows DocumentType nodes.
static int	SHOW_ELEMENT Shows Element nodes.
static int	SHOW_ENTITY Shows Entity nodes.
static int	SHOW_ENTITY_REFERENCE Shows EntityReference nodes.
static int	SHOW_NOTATION Shows Notation nodes.
static int	SHOW_PROCESSING_INSTRUCTION Shows ProcessingInstruction nodes.
static int	SHOW_TEXT Shows Text nodes.

Method Summary

Modifier and Type	Method and Description
short	acceptNode(Node n) The accept node method used by the filter is supplied as an object property when constructing the NodeIterator or TreeWalker .

Field Detail

FILTER_ACCEPT

static final short FILTER_ACCEPT

Value returned by the NodeFilter.acceptNode() method when a node should be accepted.

See Also:

Constant Field Values

FILTER_REJECT

static final short FILTER_REJECT

Value to be returned by the NodeFilter.acceptNode() method when a node should be rejected. The children of rejected nodes are not visited by the NodeIterator or TreeWalker object; this value is treated as "skip this node and all its children".

See Also:

Constant Field Values

FILTER_SKIP

static final short 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".

See Also:

Constant Field Values

SHOW_ALL

static final int SHOW_ALL

Shows all nodes.

See Also:

Constant Field Values

SHOW_ATTRIBUTE

static final int SHOW_ATTRIBUTE

Shows attribute Attr nodes. This is meaningful only when creating a NodeIterator or TreeWalker with an Attr 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

static final int SHOW_CDATA_SECTION

Shows CDATASection nodes.

See Also:

Constant Field Values

SHOW_COMMENT

static final int SHOW_COMMENT

Shows Comment nodes.

See Also:

Constant Field Values

SHOW_DOCUMENT

static final int SHOW_DOCUMENT

Shows Document nodes.

See Also:

Constant Field Values

SHOW_DOCUMENT_FRAGMENT

static final int SHOW_DOCUMENT_FRAGMENT

Shows DocumentFragment nodes.

See Also:

Constant Field Values

SHOW_DOCUMENT_TYPE

static final int SHOW_DOCUMENT_TYPE

Shows DocumentType nodes.

See Also:

Constant Field Values

SHOW_ELEMENT

static final int SHOW_ELEMENT

Shows Element nodes.

See Also:

Constant Field Values

SHOW_ENTITY

static final int SHOW_ENTITY

Shows Entity nodes. This is meaningful only when creating a NodeIterator or TreeWalker 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_ENTITY_REFERENCE

static final int SHOW_ENTITY_REFERENCE

Shows EntityReference nodes.

See Also:

Constant Field Values

SHOW_NOTATION

static final int SHOW_NOTATION

Shows Notation nodes. This is meaningful only when creating a NodeIterator or TreeWalker 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 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

static final int SHOW_PROCESSING_INSTRUCTION

Shows ProcessingInstruction nodes.

See Also:

Constant Field Values

SHOW_TEXT

static final int SHOW_TEXT

Shows Text nodes.

See Also:

Constant Field Values

Method Detail

acceptNode

short acceptNode(Node n)

The accept node method used by the filter is supplied as an object property when constructing the NodeIterator or TreeWalker .