Package org.apache.fop.render.pdf
Class PDFStructureTreeBuilder
- java.lang.Object
-
- org.apache.fop.render.pdf.PDFStructureTreeBuilder
-
- All Implemented Interfaces:
StructureTreeEventHandler
public class PDFStructureTreeBuilder extends java.lang.Object implements StructureTreeEventHandler
-
-
Constructor Summary
Constructors Constructor Description PDFStructureTreeBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PDFStructElem
createStructureElement(java.lang.String name, StructureHierarchyMember parent, org.xml.sax.Attributes attributes, PDFFactory pdfFactory, org.apache.fop.events.EventBroadcaster eventBroadcaster)
void
endNode(java.lang.String name)
Ends a structure tree node.void
endPageSequence()
Ends a page sequence structure tree node.StructureTreeElement
startImageNode(java.lang.String name, org.xml.sax.Attributes attributes, StructureTreeElement parent)
Starts an image node.StructureTreeElement
startNode(java.lang.String name, org.xml.sax.Attributes attributes, StructureTreeElement parent)
Starts a structure tree node.void
startPageSequence(java.util.Locale language, java.lang.String role)
Starts a page sequence structure tree node.StructureTreeElement
startReferencedNode(java.lang.String name, org.xml.sax.Attributes attributes, StructureTreeElement parent)
Starts a node that can be referenced by other nodes.
-
-
-
Method Detail
-
createStructureElement
public static PDFStructElem createStructureElement(java.lang.String name, StructureHierarchyMember parent, org.xml.sax.Attributes attributes, PDFFactory pdfFactory, org.apache.fop.events.EventBroadcaster eventBroadcaster)
-
startPageSequence
public void startPageSequence(java.util.Locale language, java.lang.String role)
Description copied from interface:StructureTreeEventHandler
Starts a page sequence structure tree node.- Specified by:
startPageSequence
in interfaceStructureTreeEventHandler
- Parameters:
language
- 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
-
startNode
public StructureTreeElement startNode(java.lang.String name, org.xml.sax.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
-
endNode
public void endNode(java.lang.String name)
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(java.lang.String name, org.xml.sax.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(java.lang.String name, org.xml.sax.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
-
-