Class IFStructureTreeBuilder

java.lang.Object

org.apache.fop.render.intermediate.IFStructureTreeBuilder

All Implemented Interfaces:

StructureTreeEventHandler

final class IFStructureTreeBuilder
extends Object
implements StructureTreeEventHandler

Saves structure tree events as SAX events in order to replay them when it's time to stream the structure tree to the output.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	IFStructureTreeBuilder.IFStructureTreeElement
(package private) static class	IFStructureTreeBuilder.SAXEventRecorder	A SAX handler that records events to replay them later.

Field Summary

Fields

Modifier and Type	Field	Description
private StructureTreeEventHandler	delegate
private int	idCounter
private final List<IFStructureTreeBuilder.SAXEventRecorder>	pageSequenceEventRecorders
private IFStructureTreeBuilder.SAXEventRecorder	retrievedMarkersEventRecorder

Constructor Summary

Constructors

Constructor	Description
IFStructureTreeBuilder()

Method Summary

Modifier and Type	Method	Description
private AttributesImpl	addIDAttribute(Attributes attributes, String id)
private AttributesImpl	addParentAttribute(AttributesImpl attributes, StructureTreeElement parent)
void	endNode(String name)	Ends a structure tree node.
void	endPageSequence()	Ends a page sequence structure tree node.
private String	getNextID()
private void	prepareRetrievedMarkersEventRecorder()
void	replayEventsForPageSequence(ContentHandler handler, int pageSequenceIndex)	Replay SAX events for a page sequence.
void	replayEventsForRetrievedMarkers(ContentHandler handler)
StructureTreeElement	startImageNode(String name, Attributes attributes, StructureTreeElement parent)	Starts an image node.
StructureTreeElement	startNode(String name, Attributes attributes, StructureTreeElement parent)	Starts a structure tree node.
void	startPageSequence(Locale locale, String role)	Starts a page sequence structure tree node.
StructureTreeElement	startReferencedNode(String name, Attributes attributes, StructureTreeElement parent)	Starts a node that can be referenced by other nodes.

Methods inherited from class Object

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

Field Details

delegate

private StructureTreeEventHandler delegate

pageSequenceEventRecorders

private final List<IFStructureTreeBuilder.SAXEventRecorder> pageSequenceEventRecorders

retrievedMarkersEventRecorder

private IFStructureTreeBuilder.SAXEventRecorder retrievedMarkersEventRecorder

idCounter

private int idCounter

Constructor Details

IFStructureTreeBuilder

IFStructureTreeBuilder()

Method Details

replayEventsForPageSequence

public void replayEventsForPageSequence(ContentHandler handler,
 int pageSequenceIndex)
                                 throws SAXException

Replay SAX events for a page sequence.

Parameters:

handler - The handler that receives SAX events

pageSequenceIndex - The index of the page sequence

Throws:

SAXException

replayEventsForRetrievedMarkers

public void replayEventsForRetrievedMarkers(ContentHandler handler)
                                     throws SAXException

Throws:

SAXException

startPageSequence

public void startPageSequence(Locale locale,
 String role)

Description copied from interface: StructureTreeEventHandler

Starts a page sequence structure tree node.

Specified by:

startPageSequence in interface StructureTreeEventHandler

Parameters:

locale - The locale of the page sequence

role - the value of the role property. May be null.

endPageSequence

public void endPageSequence()

Description copied from interface: StructureTreeEventHandler

Ends a page sequence structure tree node.

Specified by:

endPageSequence in interface StructureTreeEventHandler

prepareRetrievedMarkersEventRecorder

private void prepareRetrievedMarkersEventRecorder()

startNode

public StructureTreeElement startNode(String name,
 Attributes attributes,
 StructureTreeElement parent)

Description copied from interface: StructureTreeEventHandler

Starts a structure tree node.

Specified by:

startNode in interface StructureTreeEventHandler

Parameters:

name - the name of the structure tree node

attributes - the node properties

parent - the parent of the node. May be null, in which case the parent node is the node corresponding to the previous call to this method

Returns:

the corresponding structure tree element

addParentAttribute

private AttributesImpl addParentAttribute(AttributesImpl attributes,
 StructureTreeElement parent)

endNode

public void endNode(String name)

Description copied from interface: StructureTreeEventHandler

Ends a structure tree node.

Specified by:

endNode in interface StructureTreeEventHandler

Parameters:

name - the name of the structure tree node

startImageNode

public StructureTreeElement startImageNode(String name,
 Attributes attributes,
 StructureTreeElement parent)

Description copied from interface: StructureTreeEventHandler

Starts an image node.

Specified by:

startImageNode in interface StructureTreeEventHandler

Parameters:

name - the name of the structure tree node

attributes - the node properties

parent - the parent of the node. May be null, in which case the parent node is the node corresponding to the previous call to this method

Returns:

the corresponding structure tree element

startReferencedNode

public StructureTreeElement startReferencedNode(String name,
 Attributes attributes,
 StructureTreeElement parent)

Description copied from interface: StructureTreeEventHandler

Starts a node that can be referenced by other nodes. This is usually a node that can have Marked Content References as children.

Specified by:

startReferencedNode in interface StructureTreeEventHandler

Parameters:

name - the name of the structure tree node

attributes - the node properties

parent - the parent of the node. May be null, in which case the parent node is the node corresponding to the previous call to this method

Returns:

the corresponding structure tree element

getNextID

private String getNextID()

addIDAttribute

private AttributesImpl addIDAttribute(Attributes attributes,
 String id)