Package org.apache.fop.layoutmgr
Class PageBreaker
java.lang.Object
org.apache.fop.layoutmgr.AbstractBreaker
org.apache.fop.layoutmgr.PageBreaker
Handles the breaking of pages in an fo:flow
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.fop.layoutmgr.AbstractBreaker
AbstractBreaker.BlockSequence, AbstractBreaker.FloatPosition, AbstractBreaker.PageBreakPosition
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate FlowLayoutManager
The FlowLayoutManager object, which processes the single fo:flow of the fo:page-sequenceprivate boolean
private int
private int
private StaticContentLayoutManager
private boolean
private boolean
private boolean
private boolean
private boolean
private PageProvider
private int
private int
private int
private int
private int
private int
private int
private MinOptMax
private List
private boolean
private int
private List
private boolean
private int
private Block
private boolean
Fields inherited from class org.apache.fop.layoutmgr.AbstractBreaker
alignment, blockListIndex, blockLists, firstElementsForRestart, footnoteSeparatorLength, log, originalRestartAtLM, positionAtBreak, pslm
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addAreas
(PositionIterator posIter, LayoutContext context) Adds an area to the flow layout managerprotected void
addAreasForFloats
(PageBreakingAlgorithm alg, int startPart, int partCount, AbstractBreaker.BlockSequence originalList, AbstractBreaker.BlockSequence effectiveList, LayoutContext childLC, int lastBreak, int startElementIndex, int endElementIndex) private void
addFootnoteAreas
(List<KnuthElement> footnote) private void
addFootnoteAreas
(List<KnuthElement> footnote, int startIndex, int endIndex) private boolean
containsFootnotes
(List contentList, LayoutContext context) Creates and returns a PageBreakingLayoutListener for the PageBreakingAlgorithm to notify about layout problems.(package private) boolean
doLayout
(int flowBPD) Starts the page breaking process.protected void
doPhase3
(PageBreakingAlgorithm alg, int partCount, AbstractBreaker.BlockSequence originalList, AbstractBreaker.BlockSequence effectiveList) Phase 3 of Knuth algorithm: Adds the areasprotected void
Finish part.protected FlowLayoutManager
protected int
protected int
protected int
static List<List<KnuthElement>>
getFootnoteKnuthElements
(FlowLayoutManager flowLM, LayoutContext context, List<FootnoteBodyLayoutManager> footnoteBodyLMs) protected int
getNextBlockList
(LayoutContext childLC, int nextSequenceStartsOn) Gets the next block list (sequence) and adds it to a list of block lists if it's not empty.protected int
getNextBlockList
(LayoutContext childLC, int nextSequenceStartsOn, Position positionAtIPDChange, LayoutManager restartLM, List firstElements) Gets the next block list (sequence) and adds it to a list of block lists if it's not empty.protected List
getNextKnuthElements
(LayoutContext context, int alignment) Get a sequence of KnuthElements representing the content of the node assigned to the LMprotected List
getNextKnuthElements
(LayoutContext context, int alignment, Position positionAtIPDChange, LayoutManager restartAtLM) Get a sequence of KnuthElements representing the content of the node assigned to the LMint
protected PageProvider
Returns the PageProvider if any.protected LayoutManager
private void
handleBreakBeforeFollowingPage
(int breakVal) private void
handleBreakTrait
(int breakVal) Depending on the kind of break condition, move to next column or page.private void
handleBreakTrait
(int breakVal, boolean emptyContent) protected void
This method is called when no content is available for a part.protected void
handleEndOfFloat
(int fHeight) protected int
handleFloatLayout
(PageBreakingAlgorithm alg, int optimalPageCount, AbstractBreaker.BlockSequence blockList, LayoutContext childLC) private void
protected int
handleSpanChange
(LayoutContext childLC, int nextSequenceStartsOn) Handles span changes reported through theLayoutContext
.protected void
handleStartOfFloat
(int fHeight, int fYOffset) protected boolean
protected boolean
protected boolean
protected boolean
void
holdFootnotes
(List fl, List ll, int tfl, int ifl, boolean fp, boolean nf, int fnfi, int fli, int fei, MinOptMax fsl, int pfli, int pfei) protected boolean
lastPageHasIPDChange
(int optimalPageCount) private boolean
needBlankPageBeforeNew
(int breakVal) Check if a blank page is needed to accommodate desired even or odd page number.private boolean
needNewPage
(int breakVal) See if need to generate a new pageprotected void
observeElementList
(List elementList) Used for debugging purposes.protected void
prepareToRedoLayout
(PageBreakingAlgorithm alg, int partCount, AbstractBreaker.BlockSequence originalList, AbstractBreaker.BlockSequence effectiveList) private void
redoLayout
(PageBreakingAlgorithm alg, int partCount, AbstractBreaker.BlockSequence originalList, AbstractBreaker.BlockSequence effectiveList) Restart the algorithm at the break corresponding to the given partCount.void
private void
setLastPageIndex
(int currentPageNum) protected boolean
protected boolean
shouldRedoLayout
(int partCount) protected void
startPart
(AbstractBreaker.BlockSequence list, int breakClass, boolean emptyContent) Start part.protected void
updateLayoutContext
(LayoutContext context) Used to update the LayoutContext in subclasses prior to starting a new element list.protected boolean
Methods inherited from class org.apache.fop.layoutmgr.AbstractBreaker
addAreas, addAreas, addAreas, containsNonRestartableLM, createLayoutContext, doLayout, getBreakClassName, isEmpty, isPartOverflowRecoveryActivated, isSinglePartFavored
-
Field Details
-
firstPart
private boolean firstPart -
pageBreakHandled
private boolean pageBreakHandled -
needColumnBalancing
private boolean needColumnBalancing -
pageProvider
-
separatorArea
-
spanAllActive
private boolean spanAllActive -
layoutRedone
private boolean layoutRedone -
previousIndex
private int previousIndex -
handlingStartOfFloat
private boolean handlingStartOfFloat -
handlingEndOfFloat
private boolean handlingEndOfFloat -
floatHeight
private int floatHeight -
floatYOffset
private int floatYOffset -
relayedFootnotesList
-
relayedLengthList
-
relayedTotalFootnotesLength
private int relayedTotalFootnotesLength -
relayedInsertedFootnotesLength
private int relayedInsertedFootnotesLength -
relayedFootnotesPending
private boolean relayedFootnotesPending -
relayedNewFootnotes
private boolean relayedNewFootnotes -
relayedFirstNewFootnoteIndex
private int relayedFirstNewFootnoteIndex -
relayedFootnoteListIndex
private int relayedFootnoteListIndex -
relayedFootnoteElementIndex
private int relayedFootnoteElementIndex -
relayedFootnoteSeparatorLength
-
previousFootnoteListIndex
private int previousFootnoteListIndex -
previousFootnoteElementIndex
private int previousFootnoteElementIndex -
prevousColumnCount
private int prevousColumnCount -
childFLM
The FlowLayoutManager object, which processes the single fo:flow of the fo:page-sequence -
footnoteSeparatorLM
-
-
Constructor Details
-
PageBreaker
Construct page breaker.- Parameters:
pslm
- the page sequence layout manager
-
-
Method Details
-
updateLayoutContext
Used to update the LayoutContext in subclasses prior to starting a new element list.- Overrides:
updateLayoutContext
in classAbstractBreaker
- Parameters:
context
- the LayoutContext to update
-
getTopLevelLM
- Specified by:
getTopLevelLM
in classAbstractBreaker
- Returns:
- top level layout manager
-
getPageProvider
Returns the PageProvider if any. PageBreaker overrides this method because each page may have a different available BPD which needs to be accessible to the breaking algorithm.- Overrides:
getPageProvider
in classAbstractBreaker
- Returns:
- the applicable PageProvider, or null if not applicable
-
doLayout
boolean doLayout(int flowBPD) Starts the page breaking process.- Parameters:
flowBPD
- the constant available block-progression-dimension (used for every part)
-
createLayoutListener
Creates and returns a PageBreakingLayoutListener for the PageBreakingAlgorithm to notify about layout problems.- Overrides:
createLayoutListener
in classAbstractBreaker
- Returns:
- the listener instance or null if no notifications are needed
-
handleSpanChange
Handles span changes reported through theLayoutContext
. Only used by the PSLM and called bygetNextBlockList()
.- Overrides:
handleSpanChange
in classAbstractBreaker
- Parameters:
childLC
- the LayoutContextnextSequenceStartsOn
- previous value for break handling- Returns:
- effective value for break handling
-
getNextBlockList
Gets the next block list (sequence) and adds it to a list of block lists if it's not empty.- Overrides:
getNextBlockList
in classAbstractBreaker
- Parameters:
childLC
- LayoutContext to usenextSequenceStartsOn
- indicates on what page the next sequence should start- Returns:
- the page on which the next content should appear after a hard break
-
getNextBlockList
protected int getNextBlockList(LayoutContext childLC, int nextSequenceStartsOn, Position positionAtIPDChange, LayoutManager restartLM, List firstElements) Gets the next block list (sequence) and adds it to a list of block lists if it's not empty.- Overrides:
getNextBlockList
in classAbstractBreaker
- Parameters:
childLC
- LayoutContext to usenextSequenceStartsOn
- indicates on what page the next sequence should startpositionAtIPDChange
- last element on the part before an IPD changerestartLM
- the layout manager from which to restart, if IPD change occurs between two LMsfirstElements
- elements from non-restartable LMs on the new page- Returns:
- the page on which the next content should appear after a hard break
-
containsFootnotes
-
getFootnoteKnuthElements
public static List<List<KnuthElement>> getFootnoteKnuthElements(FlowLayoutManager flowLM, LayoutContext context, List<FootnoteBodyLayoutManager> footnoteBodyLMs) -
handleFootnoteSeparator
private void handleFootnoteSeparator() -
getNextKnuthElements
Get a sequence of KnuthElements representing the content of the node assigned to the LM- Specified by:
getNextKnuthElements
in classAbstractBreaker
- Parameters:
context
- the LayoutContext used to store layout informationalignment
- the desired text alignment- Returns:
- the list of KnuthElements
-
getNextKnuthElements
protected List getNextKnuthElements(LayoutContext context, int alignment, Position positionAtIPDChange, LayoutManager restartAtLM) Get a sequence of KnuthElements representing the content of the node assigned to the LM- Overrides:
getNextKnuthElements
in classAbstractBreaker
- Parameters:
context
- the LayoutContext used to store layout informationalignment
- the desired text alignmentpositionAtIPDChange
- last element on the part before an IPD changerestartAtLM
- the layout manager from which to restart, if IPD change occurs between two LMs- Returns:
- the list of KnuthElements
-
getCurrentDisplayAlign
protected int getCurrentDisplayAlign()- Specified by:
getCurrentDisplayAlign
in classAbstractBreaker
- Returns:
- current display alignment
-
hasMoreContent
protected boolean hasMoreContent()- Specified by:
hasMoreContent
in classAbstractBreaker
- Returns:
- whether or not this flow has more page break opportunities
-
addAreas
Adds an area to the flow layout manager- Specified by:
addAreas
in classAbstractBreaker
- Parameters:
posIter
- the position iteratorcontext
- the layout context
-
doPhase3
protected void doPhase3(PageBreakingAlgorithm alg, int partCount, AbstractBreaker.BlockSequence originalList, AbstractBreaker.BlockSequence effectiveList) Phase 3 of Knuth algorithm: Adds the areas This implementation checks whether to trigger column-balancing, or whether to take into account a 'last-page' condition.- Specified by:
doPhase3
in classAbstractBreaker
- Parameters:
alg
- PageBreakingAlgorithm instance which determined the breakspartCount
- number of parts (pages) to be renderedoriginalList
- original Knuth element listeffectiveList
- effective Knuth element list (after adjustments)
-
prepareToRedoLayout
protected void prepareToRedoLayout(PageBreakingAlgorithm alg, int partCount, AbstractBreaker.BlockSequence originalList, AbstractBreaker.BlockSequence effectiveList) - Overrides:
prepareToRedoLayout
in classAbstractBreaker
-
redoLayout
private void redoLayout(PageBreakingAlgorithm alg, int partCount, AbstractBreaker.BlockSequence originalList, AbstractBreaker.BlockSequence effectiveList) Restart the algorithm at the break corresponding to the given partCount. Used to re-do the part after the last break in case of either column-balancing or a last page-master. -
setLastPageIndex
private void setLastPageIndex(int currentPageNum) -
startPart
Start part.- Overrides:
startPart
in classAbstractBreaker
- Parameters:
list
- a block sequencebreakClass
- a break class
-
handleEmptyContent
protected void handleEmptyContent()This method is called when no content is available for a part. Used to force empty pages.- Overrides:
handleEmptyContent
in classAbstractBreaker
-
finishPart
Finish part.- Specified by:
finishPart
in classAbstractBreaker
- Parameters:
alg
- a page breaking algorithmpbp
- a page break posittion
-
addFootnoteAreas
-
addFootnoteAreas
-
getCurrentChildLM
- Specified by:
getCurrentChildLM
in classAbstractBreaker
- Returns:
- current child layout manager
-
observeElementList
Used for debugging purposes. Notifies all registered observers about the element list. Override to set different parameters.- Overrides:
observeElementList
in classAbstractBreaker
- Parameters:
elementList
- the Knuth element list
-
handleBreakTrait
private void handleBreakTrait(int breakVal) Depending on the kind of break condition, move to next column or page. May need to make an empty page if next page would not have the desired "handedness".- Parameters:
breakVal
- - value of break-before or break-after trait.
-
handleBreakTrait
private void handleBreakTrait(int breakVal, boolean emptyContent) -
handleBreakBeforeFollowingPage
private void handleBreakBeforeFollowingPage(int breakVal) -
needBlankPageBeforeNew
private boolean needBlankPageBeforeNew(int breakVal) Check if a blank page is needed to accommodate desired even or odd page number.- Parameters:
breakVal
- - value of break-before or break-after trait.
-
needNewPage
private boolean needNewPage(int breakVal) See if need to generate a new page- Parameters:
breakVal
- - value of break-before or break-after trait.
-
shouldRedoLayout
protected boolean shouldRedoLayout()- Overrides:
shouldRedoLayout
in classAbstractBreaker
-
shouldRedoLayout
protected boolean shouldRedoLayout(int partCount) -
wasLayoutRedone
protected boolean wasLayoutRedone()- Overrides:
wasLayoutRedone
in classAbstractBreaker
-
lastPageHasIPDChange
protected boolean lastPageHasIPDChange(int optimalPageCount) - Overrides:
lastPageHasIPDChange
in classAbstractBreaker
-
handlingStartOfFloat
protected boolean handlingStartOfFloat() -
handleStartOfFloat
protected void handleStartOfFloat(int fHeight, int fYOffset) -
getFloatHeight
protected int getFloatHeight() -
getFloatYOffset
protected int getFloatYOffset() -
handlingEndOfFloat
protected boolean handlingEndOfFloat() -
handleEndOfFloat
protected void handleEndOfFloat(int fHeight) -
handlingFloat
protected boolean handlingFloat() -
getOffsetDueToFloat
public int getOffsetDueToFloat() -
handleFloatLayout
protected int handleFloatLayout(PageBreakingAlgorithm alg, int optimalPageCount, AbstractBreaker.BlockSequence blockList, LayoutContext childLC) - Overrides:
handleFloatLayout
in classAbstractBreaker
-
addAreasForFloats
protected void addAreasForFloats(PageBreakingAlgorithm alg, int startPart, int partCount, AbstractBreaker.BlockSequence originalList, AbstractBreaker.BlockSequence effectiveList, LayoutContext childLC, int lastBreak, int startElementIndex, int endElementIndex) - Overrides:
addAreasForFloats
in classAbstractBreaker
-
holdFootnotes
-
retrieveFootones
-