org.kde.koala
Class NodeFilter

java.lang.Object
  extended by org.kde.koala.NodeFilter
All Implemented Interfaces:
org.kde.qt.QtSupport

public class NodeFilter
extends java.lang.Object
implements org.kde.qt.QtSupport

Filters are objects that know how to "filter out" nodes. If an Iterator or TreeWalker is given a filter, before it returns the next node, it applies the filter. If the filter says to accept the node, the Iterator returns it; otherwise, the Iterator looks for the next node and pretends that the node that was rejected was not there. The DOM does not provide any filters. Filter is just an interface that users can implement to provide their own filters. Filters do not need to know how to iterate, nor do they need to know anything about the data structure that is being iterated. This makes it very easy to write filters, since the only thing they have to know how to do is evaluate a single node. One filter may be used with a number of different kinds of Iterators, encouraging code reuse. To create your own custom NodeFilter, define a subclass of CustomNodeFilter which overrides the acceptNode() method and assign an instance of it to the NodeFilter. For more details see the CustomNodeFilter class


Constructor Summary
  NodeFilter()
           
protected NodeFilter(java.lang.Class dummy)
           
  NodeFilter(NodeFilter other)
           
 
Method Summary
 short acceptNode(Node n)
          Test whether a specified node is visible in the logical view of a TreeWalker or NodeIterator.
static NodeFilter createCustom(CustomNodeFilter custom)
           
 CustomNodeFilter customNodeFilter()
           
 boolean isNull()
          not part of the DOM
 void setCustomNodeFilter(CustomNodeFilter custom)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NodeFilter

protected NodeFilter(java.lang.Class dummy)

NodeFilter

public NodeFilter()

NodeFilter

public NodeFilter(NodeFilter other)
Method Detail

acceptNode

public 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 intended to be called directly from user code.

Parameters:
n - The 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 .

isNull

public boolean isNull()
not part of the DOM


setCustomNodeFilter

public void setCustomNodeFilter(CustomNodeFilter custom)

customNodeFilter

public CustomNodeFilter customNodeFilter()

createCustom

public static NodeFilter createCustom(CustomNodeFilter custom)