org.axsl.fo

Class FoTreeEvent

java.lang.Object

java.util.EventObject

org.axsl.fo.FoTreeEvent

All Implemented Interfaces:

java.io.Serializable

public class FoTreeEvent
extends java.util.EventObject

An Event used for notification that various stages of the building of an FO tree have been completed. Events are fired when an FObj is complete, when a PageSequence is complete, and when the document is complete.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
FoTreeEvent(java.lang.Object source) Constructor for a "Document complete" event.
FoTreeEvent(java.lang.Object source, Fo fobj) Constructor for an "FObj complete" event.
FoTreeEvent(java.lang.Object source, PageSequence pageSequence) Constructor for a "PageSequence complete" event.

Method Summary

Modifier and Type	Method and Description
Fo	getFo() Returns the FObj instance attached to this event.
PageSequence	getPageSequence() Returns the PageSequence instance attached to this event.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FoTreeEvent

public FoTreeEvent(java.lang.Object source,
                   Fo fobj)

Constructor for an "FObj complete" event.

Parameters:

source - the Object that fired the event.

fobj - The FObj instance that was just created.

FoTreeEvent

public FoTreeEvent(java.lang.Object source)

Constructor for a "Document complete" event.

Parameters:

source - the Object that fired the event.

FoTreeEvent

public FoTreeEvent(java.lang.Object source,
                   PageSequence pageSequence)

Constructor for a "PageSequence complete" event.

Parameters:

source - the Object that fired the event.

pageSequence - The PageSequence instance that was just completed.

Method Detail

getFo

public Fo getFo()

Returns the FObj instance attached to this event.

Returns:

The FObj object attached to this event. This will return null for non-FObj events.

getPageSequence

public PageSequence getPageSequence()

Returns the PageSequence instance attached to this event.

Returns:

The PageSequence object attached to this event. This will return null for non-PageSequence events.