org.axsl.fo

Interface FoTreeListener

All Superinterfaces:

java.util.EventListener

public interface FoTreeListener
extends java.util.EventListener

An interface for classes that need to handle FOTreeEvent objects as they are fired. The key benefit to using this interface is that the implementation can handle PageSequence objects at a higher level, rather than dealing directly with a lower-level SAX event.

See Also:

FoTreeEvent

Method Summary

Modifier and Type	Method and Description
void	foComplete(FoTreeEvent event) Method for handling a completed FObj object.
void	foDocumentComplete(FoTreeEvent event) Method for handling the end of the document.
void	foPageSequenceComplete(FoTreeEvent event) Method for handling a completed PageSequence object.
boolean	wantsFoCompleteEvents() This flag gives the FOTreeBuilder an opportunity to avoid creating unnecessary event objects unless somebody wants them.

Method Detail

foComplete

void foComplete(FoTreeEvent event)
         throws FoTreeException

Method for handling a completed FObj object.

Parameters:

event - The FOTreeEvent that has been fired.

Throws:

FoTreeException - For errors while processing the event.

foPageSequenceComplete

void foPageSequenceComplete(FoTreeEvent event)
                     throws FoTreeException

Method for handling a completed PageSequence object.

Parameters:

event - The FOTreeEvent that has been fired.

Throws:

FoTreeException - For errors while processing the event.

foDocumentComplete

void foDocumentComplete(FoTreeEvent event)
                 throws FoTreeException

Method for handling the end of the document.

Parameters:

event - The FOTreeEvent that has been fired.

Throws:

FoTreeException - For errors while processing the event.

wantsFoCompleteEvents

boolean wantsFoCompleteEvents()

This flag gives the FOTreeBuilder an opportunity to avoid creating unnecessary event objects unless somebody wants them.

Returns:

True if you need FObj-complete events, false otherwise.