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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
PDFStructureTreeBuilder.DefaultStructureElementBuilder
private static class
PDFStructureTreeBuilder.ImageBuilder
private static class
PDFStructureTreeBuilder.InlineHolderBuilder
private static class
PDFStructureTreeBuilder.LanguageHolderBuilder
private static class
PDFStructureTreeBuilder.LinkBuilder
private static class
PDFStructureTreeBuilder.PageSequenceBuilder
private static class
PDFStructureTreeBuilder.PlaceholderBuilder
private static class
PDFStructureTreeBuilder.RegionBuilder
private static interface
PDFStructureTreeBuilder.StructureElementBuilder
private static class
PDFStructureTreeBuilder.TableBuilder
private static class
PDFStructureTreeBuilder.TableCellBuilder
private static class
PDFStructureTreeBuilder.TableFooterBuilder
-
Field Summary
Fields Modifier and Type Field Description private java.util.LinkedList<PDFStructElem>
ancestors
private static java.util.Map<java.lang.String,PDFStructureTreeBuilder.StructureElementBuilder>
BUILDERS
private static PDFStructureTreeBuilder.StructureElementBuilder
DEFAULT_BUILDER
private EventBroadcaster
eventBroadcaster
private PDFFactory
pdfFactory
private static java.lang.String
ROLE
private PDFStructElem
rootStructureElement
-
Constructor Summary
Constructors Constructor Description PDFStructureTreeBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static void
addBuilder(java.lang.String fo, StructureType structureType)
private static void
addBuilder(java.lang.String fo, PDFStructureTreeBuilder.StructureElementBuilder mapper)
private void
createRootStructureElement(PDFLogicalStructureHandler logicalStructureHandler)
static PDFStructElem
createStructureElement(java.lang.String name, StructureHierarchyMember parent, org.xml.sax.Attributes attributes, PDFFactory pdfFactory, EventBroadcaster eventBroadcaster)
void
endNode(java.lang.String name)
Ends a structure tree node.void
endPageSequence()
Ends a page sequence structure tree node.private boolean
isPDFA1Safe(java.lang.String name)
(package private) void
setEventBroadcaster(EventBroadcaster eventBroadcaster)
(package private) void
setLogicalStructureHandler(PDFLogicalStructureHandler logicalStructureHandler)
(package private) void
setPdfFactory(PDFFactory pdfFactory)
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.
-
-
-
Field Detail
-
ROLE
private static final java.lang.String ROLE
- See Also:
- Constant Field Values
-
BUILDERS
private static final java.util.Map<java.lang.String,PDFStructureTreeBuilder.StructureElementBuilder> BUILDERS
-
DEFAULT_BUILDER
private static final PDFStructureTreeBuilder.StructureElementBuilder DEFAULT_BUILDER
-
pdfFactory
private PDFFactory pdfFactory
-
eventBroadcaster
private EventBroadcaster eventBroadcaster
-
ancestors
private java.util.LinkedList<PDFStructElem> ancestors
-
rootStructureElement
private PDFStructElem rootStructureElement
-
-
Method Detail
-
addBuilder
private static void addBuilder(java.lang.String fo, StructureType structureType)
-
addBuilder
private static void addBuilder(java.lang.String fo, PDFStructureTreeBuilder.StructureElementBuilder mapper)
-
setPdfFactory
void setPdfFactory(PDFFactory pdfFactory)
-
setEventBroadcaster
void setEventBroadcaster(EventBroadcaster eventBroadcaster)
-
setLogicalStructureHandler
void setLogicalStructureHandler(PDFLogicalStructureHandler logicalStructureHandler)
-
createRootStructureElement
private void createRootStructureElement(PDFLogicalStructureHandler logicalStructureHandler)
-
createStructureElement
public static PDFStructElem createStructureElement(java.lang.String name, StructureHierarchyMember parent, org.xml.sax.Attributes attributes, PDFFactory pdfFactory, 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
-
isPDFA1Safe
private boolean isPDFA1Safe(java.lang.String name)
-
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
-
-