Package org.apache.fop.layoutmgr

Class PageSequenceLayoutManager

    • Field Detail

      • log

        private static org.apache.commons.logging.Log log

      • tableHeaderFootnotes

        private java.util.List<java.util.List<KnuthElement>> tableHeaderFootnotes
        Footnotes coming from repeated table headers, to be added before any other footnote.

      • tableFooterFootnotes

        private java.util.List<java.util.List<KnuthElement>> tableFooterFootnotes
        Footnotes coming from repeated table footers, to be added after any other footnote.

      • startIntrusionAdjustment

        private int startIntrusionAdjustment

      • endIntrusionAdjustment

        private int endIntrusionAdjustment

    • Constructor Detail

      • PageSequenceLayoutManager

        public PageSequenceLayoutManager​(AreaTreeHandler ath,
                                 PageSequence pseq)
        Constructor
        Parameters:
        ath - the area tree handler object
        pseq - fo:page-sequence to process

    • Method Detail

      • getPageProvider

        public PageProvider getPageProvider()
        Returns:
        the PageProvider applicable to this page-sequence.

      • getPageSequence

        protected PageSequence getPageSequence()
        Returns:
        the PageSequence being managed by this layout manager

      • activateLayout

        public void activateLayout()
        Activate the layout of this page sequence. PageViewports corresponding to each page generated by this page sequence will be created and sent to the AreaTreeModel for rendering.

      • finishPageSequence

        public void finishPageSequence()
        Finished the page-sequence and notifies everyone about it.

      • createPage

        protected Page createPage​(int pageNumber,
                          boolean isBlank)
        Creates and returns a new page.
        Specified by:
        createPage in class AbstractPageSequenceLayoutManager
        Parameters:
        pageNumber - the page number
        isBlank - true if it's a blank page
        Returns:
        the newly created page

      • makeNewPage

        protected Page makeNewPage​(boolean isBlank,
                           boolean emptyContent)

      • flowNameEquals

        private boolean flowNameEquals​(Page newPage,
                               boolean strict)

      • layoutSideRegion

        private void layoutSideRegion​(int regionID)

      • getForcedLastPageNum

        protected int getForcedLastPageNum​(int lastPageNum)
        The last page number of the sequence may be incremented, as determined by the force-page-count formatting property semantics
        Parameters:
        lastPageNum - number of sequence
        Returns:
        the forced last page number of sequence

      • isOnFirstPage

        boolean isOnFirstPage​(int partIndex)
        Indicates whether the column/page at the given index is on the first page of this page sequence.
        Returns:
        true if the given part is on the first page of the sequence

      • getWidthOfCurrentPage

        protected int getWidthOfCurrentPage()

      • addTableHeaderFootnotes

        public void addTableHeaderFootnotes​(java.util.List<java.util.List<KnuthElement>> headerFootnotes)
        Registers the given footnotes so that they can be added to the current page, before any other footnote.
        Parameters:
        headerFootnotes - footnotes coming from a repeated table header

      • getTableHeaderFootnotes

        public java.util.List<java.util.List<KnuthElement>> getTableHeaderFootnotes()

      • addTableFooterFootnotes

        public void addTableFooterFootnotes​(java.util.List<java.util.List<KnuthElement>> footerFootnotes)
        Registers the given footnotes so that they can be added to the current page, after any other footnote.
        Parameters:
        footerFootnotes - footnotes coming from a repeated table footer

      • getTableFooterFootnotes

        public java.util.List<java.util.List<KnuthElement>> getTableFooterFootnotes()

      • getTableFootnotes

        private java.util.List<java.util.List<KnuthElement>> getTableFootnotes​(java.util.List<java.util.List<KnuthElement>> tableFootnotes)

      • clearTableHeadingFootnotes

        public void clearTableHeadingFootnotes()
        Clears the footnotes coming from repeated table headers/footers, in order to start afresh for a new page.

      • setStartIntrusionAdjustment

        public void setStartIntrusionAdjustment​(int sia)

      • setEndIntrusionAdjustment

        public void setEndIntrusionAdjustment​(int eia)

      • getStartIntrusionAdjustment

        public int getStartIntrusionAdjustment()

      • getEndIntrusionAdjustment

        public int getEndIntrusionAdjustment()

      • recordEndOfFloat

        public void recordEndOfFloat​(int fHeight)

      • handlingEndOfFloat

        public boolean handlingEndOfFloat()

      • getOffsetDueToFloat

        public int getOffsetDueToFloat()

      • recordStartOfFloat

        public void recordStartOfFloat​(int fHeight,
                               int fYOffset)

      • handlingStartOfFloat

        public boolean handlingStartOfFloat()

      • getFloatHeight

        public int getFloatHeight()

      • getFloatYOffset

        public int getFloatYOffset()

      • getCurrentColumnWidth

        public int getCurrentColumnWidth()

      • holdFootnotes

        public void holdFootnotes​(java.util.List fl,
                          java.util.List<java.lang.Integer> ll,
                          int tfl,
                          int ifl,
                          boolean fp,
                          boolean nf,
                          int fnfi,
                          int fli,
                          int fei,
                          MinOptMax fsl,
                          int pfli,
                          int pfei)