org.apache.fop.fo

Interface FONode.FONodeIterator

All Superinterfaces:
ListIterator
Known Implementing Classes:
FObj.FObjIterator

public static interface FONode.FONodeIterator
extends ListIterator

Base iterator interface over a FO's children

Method Summary

FONode
firstNode()
Returns the first node in the list, and decreases the index, so that a subsequent call to hasPrevious() will return false
FONode
lastNode()
Returns the last node in the list, and advances the current position, so that a subsequent call to hasNext() will return false
FONode
nextNode()
Convenience method with return type of FONode (should be semantically equivalent to (FONode) next();)
FObj
parentNode()
Returns the parent node for this iterator's list of child nodes
FONode
previousNode()
Convenience method with return type of FONode (should be semantically equivalent to (FONode) previous();)

Method Details

firstNode

public FONode firstNode()
Returns the first node in the list, and decreases the index, so that a subsequent call to hasPrevious() will return false
Returns:
the first node in the list

lastNode

public FONode lastNode()
Returns the last node in the list, and advances the current position, so that a subsequent call to hasNext() will return false
Returns:
the last node in the list

nextNode

public FONode nextNode()
Convenience method with return type of FONode (should be semantically equivalent to (FONode) next();)
Returns:
the next node (if any), as a type FONode

parentNode

public FObj parentNode()
Returns the parent node for this iterator's list of child nodes
Returns:
the parent node

previousNode

public FONode previousNode()
Convenience method with return type of FONode (should be semantically equivalent to (FONode) previous();)
Returns:
the previous node (if any), as a type FONode

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.