Package org.apache.fop.layoutmgr
Class LayoutManagerMapping
- java.lang.Object
-
- org.apache.fop.layoutmgr.LayoutManagerMapping
-
- All Implemented Interfaces:
LayoutManagerMaker
public class LayoutManagerMapping extends java.lang.Object implements LayoutManagerMaker
The default LayoutManager maker class
-
-
Nested Class Summary
-
Constructor Summary
Constructors Constructor Description LayoutManagerMapping(FOUserAgent userAgent)
default constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
initialize()
Initializes the set of maker objects associated with this LayoutManagerMappingContentLayoutManager
makeContentLayoutManager(PageSequenceLayoutManager pslm, Title title)
Make a ContentLayoutManager object.ExternalDocumentLayoutManager
makeExternalDocumentLayoutManager(AreaTreeHandler ath, ExternalDocument ed)
Make a ExternalDocumentLayoutManager object for the fox:external-document extension.FlowLayoutManager
makeFlowLayoutManager(PageSequenceLayoutManager pslm, Flow flow)
Make a FlowLayoutManager object.LayoutManager
makeLayoutManager(FONode node)
Make a specific LayoutManager for the node.void
makeLayoutManagers(FONode node, java.util.List lms)
Make LayoutManagers for the node and add them to the list lms.PageSequenceLayoutManager
makePageSequenceLayoutManager(AreaTreeHandler ath, PageSequence ps)
Make a PageSequenceLayoutManager object.StaticContentLayoutManager
makeStaticContentLayoutManager(PageSequenceLayoutManager pslm, StaticContent sc, Block block)
Make a StaticContentLayoutManager object for a footnote-separator.StaticContentLayoutManager
makeStaticContentLayoutManager(PageSequenceLayoutManager pslm, StaticContent sc, SideRegion reg)
Make a StaticContentLayoutManager object.protected void
registerMaker(java.lang.Class clazz, LayoutManagerMapping.Maker maker)
Registers a Maker class for a specific formatting object.
-
-
-
Constructor Detail
-
LayoutManagerMapping
public LayoutManagerMapping(FOUserAgent userAgent)
default constructor
-
-
Method Detail
-
initialize
protected void initialize()
Initializes the set of maker objects associated with this LayoutManagerMapping
-
registerMaker
protected void registerMaker(java.lang.Class clazz, LayoutManagerMapping.Maker maker)
Registers a Maker class for a specific formatting object.- Parameters:
clazz
- the formatting object classmaker
- the maker for the layout manager
-
makeLayoutManagers
public void makeLayoutManagers(FONode node, java.util.List lms)
Make LayoutManagers for the node and add them to the list lms.- Specified by:
makeLayoutManagers
in interfaceLayoutManagerMaker
- Parameters:
node
- the FO node for which the LayoutManagers are madelms
- the list to which the LayoutManagers are added
-
makeLayoutManager
public LayoutManager makeLayoutManager(FONode node)
Make a specific LayoutManager for the node. If not exactly one LayoutManagers is available, an IllegalStateException is thrown.- Specified by:
makeLayoutManager
in interfaceLayoutManagerMaker
- Parameters:
node
- the FO node for which the LayoutManagers are made- Returns:
- The created LayoutManager
-
makePageSequenceLayoutManager
public PageSequenceLayoutManager makePageSequenceLayoutManager(AreaTreeHandler ath, PageSequence ps)
Make a PageSequenceLayoutManager object.- Specified by:
makePageSequenceLayoutManager
in interfaceLayoutManagerMaker
- Parameters:
ath
- the AreaTreeHandler object the PSLM interacts withps
- the fo:page-sequence object this PSLM will process- Returns:
- The created PageSequenceLayoutManager object
-
makeExternalDocumentLayoutManager
public ExternalDocumentLayoutManager makeExternalDocumentLayoutManager(AreaTreeHandler ath, ExternalDocument ed)
Make a ExternalDocumentLayoutManager object for the fox:external-document extension.- Specified by:
makeExternalDocumentLayoutManager
in interfaceLayoutManagerMaker
- Parameters:
ath
- the AreaTreeHandler object the external-document interacts withed
- the fox:external-document object to be processed- Returns:
- The created ExternalDocumentLayoutManager object
-
makeFlowLayoutManager
public FlowLayoutManager makeFlowLayoutManager(PageSequenceLayoutManager pslm, Flow flow)
Make a FlowLayoutManager object.- Specified by:
makeFlowLayoutManager
in interfaceLayoutManagerMaker
- Parameters:
pslm
- the parent PageSequenceLayoutManager objectflow
- the fo:flow object this FLM will process- Returns:
- The created FlowLayoutManager object
-
makeContentLayoutManager
public ContentLayoutManager makeContentLayoutManager(PageSequenceLayoutManager pslm, Title title)
Make a ContentLayoutManager object.- Specified by:
makeContentLayoutManager
in interfaceLayoutManagerMaker
- Parameters:
pslm
- the parent PageSequenceLayoutManager objecttitle
- the fo:title object this CLM will process- Returns:
- The created ContentLayoutManager object
-
makeStaticContentLayoutManager
public StaticContentLayoutManager makeStaticContentLayoutManager(PageSequenceLayoutManager pslm, StaticContent sc, SideRegion reg)
Make a StaticContentLayoutManager object.- Specified by:
makeStaticContentLayoutManager
in interfaceLayoutManagerMaker
- Parameters:
pslm
- the parent PageSequenceLayoutManager objectsc
- the fo:static-content object this SCLM will processreg
- the side region indicating where the static content needs to be processed.- Returns:
- The created StaticContentLayoutManager object
-
makeStaticContentLayoutManager
public StaticContentLayoutManager makeStaticContentLayoutManager(PageSequenceLayoutManager pslm, StaticContent sc, Block block)
Make a StaticContentLayoutManager object for a footnote-separator.- Specified by:
makeStaticContentLayoutManager
in interfaceLayoutManagerMaker
- Parameters:
pslm
- the parent PageSequenceLayoutManager objectsc
- the fo:static-content object this SCLM will processblock
- the Block area this SCLM must add its areas to- Returns:
- The created StaticContentLayoutManager object
-
-