namespace org::w3c::dom::traversal

Modules Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages

org::w3c::dom::traversal Namespace Reference

Detailed Description

Supports the optional Traversal feature of the DOM Level 2 Recommendation.

Compounds

class DocumentTraversal

DocumentTraversal contains methods that create NodeIterators and TreeWalkers to traverse a node and its children in document order (depth first, pre-order traversal, which is equivalent to the order in which the start tags occur in the text representation of the document). More...

class NodeFilter

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

class NodeIterator

NodeIterators are used to step through a set of nodes, e.g. More...

class TreeWalker

TreeWalker objects are used to navigate a document tree or subtree using the view of the document defined by their whatToShow flags and filter (if any). More...

Enumerations

enum NodeFilterAcceptFlags { FILTER_ACCEPT = 1, FILTER_REJECT = 2, FILTER_SKIP = 3 }

enum NodeFilterShowFlags {
  SHOW_ALL = 0xFFFFFFFF, SHOW_ELEMENT = 0x00000001, SHOW_ATTRIBUTE = 0x00000002, SHOW_TEXT = 0x00000004,
  SHOW_CDATA_SECTION = 0x00000008, SHOW_ENTITY_REFERENCE = 0x00000010, SHOW_ENTITY = 0x00000020, SHOW_PROCESSING_INSTRUCTION = 0x00000040,
  SHOW_COMMENT = 0x00000080, SHOW_DOCUMENT = 0x00000100, SHOW_DOCUMENT_TYPE = 0x00000200, SHOW_DOCUMENT_FRAGMENT = 0x00000400,
  SHOW_NOTATION = 0x00000800
}

Enumeration Type Documentation

enum org::w3c::dom::traversal::NodeFilterAcceptFlags

Enumeration values:

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

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.

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.

enum org::w3c::dom::traversal::NodeFilterShowFlags

Enumeration values:

SHOW_ALL Show all Nodes.

SHOW_ELEMENT Show Element nodes.

SHOW_ATTRIBUTE Show Attr nodes.
This is meaningful only when creating an NodeIterator or TreeWalker 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_TEXT Show Text nodes.

SHOW_CDATA_SECTION Show CDATASection nodes.

SHOW_ENTITY_REFERENCE Show EntityReference nodes.

SHOW_ENTITY Show Entity nodes.
This is meaningful only when creating an 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.

SHOW_PROCESSING_INSTRUCTION Show ProcessingInstruction nodes.

SHOW_COMMENT Show Comment nodes.

SHOW_DOCUMENT Show Document nodes.

SHOW_DOCUMENT_TYPE Show DocumentType nodes.

SHOW_DOCUMENT_FRAGMENT Show DocumentFragment nodes.

SHOW_NOTATION Show Notation nodes.
This is meaningful only when creating an 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 notations are not part of the document tree, they do not appear when traversing over the document tree.