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 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 LinkedList<PDFStructElem>	ancestors
private static final Map<String,PDFStructureTreeBuilder.StructureElementBuilder>	BUILDERS
private static final PDFStructureTreeBuilder.StructureElementBuilder	DEFAULT_BUILDER
private EventBroadcaster	eventBroadcaster
private PDFFactory	pdfFactory
private static final String	ROLE
private PDFStructElem	rootStructureElement

Constructor Summary

Constructors

Constructor	Description
PDFStructureTreeBuilder()

Method Summary

Modifier and Type	Method	Description
private static void	addBuilder(String fo, StructureType structureType)
private static void	addBuilder(String fo, PDFStructureTreeBuilder.StructureElementBuilder mapper)
private void	createRootStructureElement(PDFLogicalStructureHandler logicalStructureHandler)
static PDFStructElem	createStructureElement(String name, StructureHierarchyMember parent, Attributes attributes, PDFFactory pdfFactory, EventBroadcaster eventBroadcaster)
void	endNode(String name)	Ends a structure tree node.
void	endPageSequence()	Ends a page sequence structure tree node.
private boolean	isPDFA1Safe(String name)
(package private) void	setEventBroadcaster(EventBroadcaster eventBroadcaster)
(package private) void	setLogicalStructureHandler(PDFLogicalStructureHandler logicalStructureHandler)
(package private) void	setPdfFactory(PDFFactory pdfFactory)
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 language, 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 java.lang.Object

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

Field Details

ROLE

private static final String ROLE

See Also:

• Constant Field Values

BUILDERS

private static final Map<String,PDFStructureTreeBuilder.StructureElementBuilder> BUILDERS

DEFAULT_BUILDER

private static final PDFStructureTreeBuilder.StructureElementBuilder DEFAULT_BUILDER

pdfFactory

private PDFFactory pdfFactory

eventBroadcaster

private EventBroadcaster eventBroadcaster

ancestors

private LinkedList<PDFStructElem> ancestors

rootStructureElement

private PDFStructElem rootStructureElement

Constructor Details

PDFStructureTreeBuilder

public PDFStructureTreeBuilder()

Method Details

addBuilder

private static void addBuilder(String fo,
 StructureType structureType)

addBuilder

private static void addBuilder(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(String name,
 StructureHierarchyMember parent,
 Attributes attributes,
 PDFFactory pdfFactory,
 EventBroadcaster eventBroadcaster)

startPageSequence

public void startPageSequence(Locale language,
 String role)

Description copied from interface: StructureTreeEventHandler

Starts a page sequence structure tree node.

Specified by:

startPageSequence in interface StructureTreeEventHandler

Parameters:

language - 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

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

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

isPDFA1Safe

private boolean isPDFA1Safe(String name)

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