Class IFStructureTreeBuilder
java.lang.Object
org.apache.fop.render.intermediate.IFStructureTreeBuilder
- All Implemented Interfaces:
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 ClassesModifier and TypeClassDescription(package private) static final class
(package private) static class
A SAX handler that records events to replay them later. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate StructureTreeEventHandler
private int
private final List
<IFStructureTreeBuilder.SAXEventRecorder> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate AttributesImpl
addIDAttribute
(Attributes attributes, String id) private AttributesImpl
addParentAttribute
(AttributesImpl attributes, StructureTreeElement parent) void
Ends a structure tree node.void
Ends a page sequence structure tree node.private String
private void
void
replayEventsForPageSequence
(ContentHandler handler, int pageSequenceIndex) Replay SAX events for a page sequence.void
startImageNode
(String name, Attributes attributes, StructureTreeElement parent) Starts an image node.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.startReferencedNode
(String name, Attributes attributes, StructureTreeElement parent) Starts a node that can be referenced by other nodes.
-
Field Details
-
delegate
-
pageSequenceEventRecorders
-
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 eventspageSequenceIndex
- The index of the page sequence- Throws:
SAXException
-
replayEventsForRetrievedMarkers
- Throws:
SAXException
-
startPageSequence
Description copied from interface:StructureTreeEventHandler
Starts a page sequence structure tree node.- Specified by:
startPageSequence
in interfaceStructureTreeEventHandler
- Parameters:
locale
- The locale of the page sequencerole
- 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 interfaceStructureTreeEventHandler
-
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 interfaceStructureTreeEventHandler
- Parameters:
name
- the name of the structure tree nodeattributes
- the node propertiesparent
- 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
-
endNode
Description copied from interface:StructureTreeEventHandler
Ends a structure tree node.- Specified by:
endNode
in interfaceStructureTreeEventHandler
- 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 interfaceStructureTreeEventHandler
- Parameters:
name
- the name of the structure tree nodeattributes
- the node propertiesparent
- 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 interfaceStructureTreeEventHandler
- Parameters:
name
- the name of the structure tree nodeattributes
- the node propertiesparent
- 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
-
addIDAttribute
-