Package org.apache.fop.layoutmgr

Class Page

java.lang.Object
org.apache.fop.layoutmgr.Page
public class Page extends Object
This object is used by the layout engine to represent a page. It provides access to the simple-page-master that was used as a template for this page and it provides access to the PageViewport which is the top-level area tree element. This class helps to decouple the FO tree from the area tree to make the latter easily serializable.

  • Field Details

    • isPagePositionOnly

      protected boolean isPagePositionOnly

  • Constructor Details

    • Page

      public Page(SimplePageMaster spm, int pageNumber, String pageNumberStr, boolean blank, boolean spanAll, boolean isPagePositionOnly)
      Main constructor
      Parameters:
      spm - the simple-page-master used for this page
      pageNumber - the page number (as an int)
      pageNumberStr - the page number (as a String)
      blank - true if this is a blank page
      spanAll - true if the first span area spans all columns

    • Page

      public Page(Rectangle viewArea, int pageNumber, String pageNumberStr, boolean blank)
      Auxiliary constructor used when there's no SimplePageMaster.
      Parameters:
      viewArea - the view area of the page
      pageNumber - the page number (as an int)
      pageNumberStr - the page number (as a String)
      blank - true if this is a blank page

  • Method Details

    • getSimplePageMaster

      public SimplePageMaster getSimplePageMaster()
      Returns:
      the simple-page-master that created this page

    • getPageViewport

      public PageViewport getPageViewport()
      Returns:
      the page viewport representing this page in the area tree