Uses of Class org.apache.fop.area.PageViewport (Apache FOP 2.7 API)
Date: 2022-01-12

## Uses of Class
org.apache.fop.area.PageViewport

- Packages that use PageViewport
  Package | Description
  --- | ---
  org.apache.fop.area | FOP's area tree.
  org.apache.fop.area.inline | FOP's area tree: inline-level areas
  org.apache.fop.layoutmgr | FOP's layout engine.
  org.apache.fop.layoutmgr.inline | Layout managers for inline formatting objects and line building.
  org.apache.fop.render | Generic renderer interface.
  org.apache.fop.render.awt | AWT Renderer used for displaying rendered pages in Java applications.
  org.apache.fop.render.intermediate |
  org.apache.fop.render.java2d | Java2D Renderer which paints rendered pages on Graphics2D instances.
  org.apache.fop.render.print | Renderer which prints rendered pages directly to a printer.
  org.apache.fop.render.txt | Plain Text Renderer
  org.apache.fop.render.xml | Area Tree XML Renderer.

- - ### Uses of PageViewport in org.apache.fop.area

    Fields in org.apache.fop.area with type parameters of type PageViewport
    Modifier and Type | Field and Description
    --- | ---
    `protected java.util.List<PageViewport>` | RenderPagesModel.`prepared` Pages that have been prepared but not rendered yet.

    Methods in org.apache.fop.area that return PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `PageViewport` | IDTracker.`getFirstPageViewportContaining(java.lang.String id)` Get the first `PageViewport` containing content generated by the FO with the given `id`.
    `PageViewport` | IDTracker.`getLastPageViewportContaining(java.lang.String id)` Get the last `PageViewport` containing content generated by the FO with the given `id`.
    `PageViewport` | PageSequence.`getPage(int idx)` Returns the page at the given index.
    `PageViewport` | AreaTreeModel.`getPage(int seq, int count)` Get the page for a position in the document.
    `PageViewport` | BookmarkData.`getPageViewport()` Get the PageViewport object that this bookmark refers to
    `PageViewport` | DestinationData.`getPageViewport()` Get the PageViewport object that this destination refers to

    Methods in org.apache.fop.area that return types with arguments of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<PageViewport>` | IDTracker.`getPageViewportsContainingID(java.lang.String id)` Get the list of page viewports that have an area with a given id.
    `java.util.List<PageViewport>` | AreaTreeHandler.`getPageViewportsContainingID(java.lang.String id)` Deprecated. use getIDTracker().getPageViewportsContainingID(id) instead

    Methods in org.apache.fop.area with parameters of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `void` | PageSequence.`addPage(PageViewport page)` Adds a new page to the page sequence
    `void` | AreaTreeModel.`addPage(PageViewport page)` Add a page to this model.
    `void` | RenderPagesModel.`addPage(PageViewport page)` Add a page to the render page model.
    `void` | IDTracker.`associateIDWithPageViewport(java.lang.String id, PageViewport pv)` Tie a PageViewport with an ID found on a child area of the PV.
    `void` | AreaTreeHandler.`associateIDWithPageViewport(java.lang.String id, PageViewport pv)` Deprecated. use getIDTracker().associateIDWithPageViewport(id, pv) instead
    `protected boolean` | CachedRenderPagesModel.`checkPreparedPages(PageViewport newpage, boolean renderUnresolved)` Check prepared pages
    `protected boolean` | RenderPagesModel.`checkPreparedPages(PageViewport newPageViewport, boolean renderUnresolved)` Check prepared pages
    `boolean` | PageSequence.`isFirstPage(PageViewport page)` Indicates whether a page is the first in this page sequence.
    `protected void` | RenderPagesModel.`preparePage(PageViewport page)` Prepare a page.
    `protected void` | RenderPagesModel.`renderPage(PageViewport pageViewport)` Renders the given page and notified about unresolved IDs if any.
    `void` | PageViewport.`replace(PageViewport oldViewPort)` Replace the old view port.
    `void` | IDTracker.`replacePageViewPort(PageViewport oldPageViewPort, PageViewport newPageViewPort)` Replace all id locations pointing to the old page view port with a new one.
    `void` | LinkResolver.`resolveIDRef(java.lang.String id, PageViewport pv)` Resolve by adding an InternalLink trait to the area
    `protected void` | CachedRenderPagesModel.`savePage(PageViewport page)` Save a page.
    `void` | IDTracker.`tryIDResolution(PageViewport pv)` Tries to resolve all unresolved ID references on the given page.
    `void` | AreaTreeHandler.`tryIDResolution(PageViewport pv)` Deprecated. use getIDTracker().tryIDResolution(pv) instead

    Method parameters in org.apache.fop.area with type arguments of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `void` | Resolvable.`resolveIDRef(java.lang.String id, java.util.List<PageViewport> pages)` This method allows the Resolvable object to resolve one of its unresolved idrefs with the actual set of PageViewports containing the target ID.
    `void` | PageViewport.`resolveIDRef(java.lang.String id, java.util.List<PageViewport> pages)` This method allows the Resolvable object to resolve one of its unresolved idrefs with the actual set of PageViewports containing the target ID.
    `void` | BookmarkData.`resolveIDRef(java.lang.String id, java.util.List<PageViewport> pages)` Resolve this resolvable object.
    `void` | LinkResolver.`resolveIDRef(java.lang.String id, java.util.List<PageViewport> pages)` Resolve by adding an internal link to the first PageViewport in the list.
    `void` | DestinationData.`resolveIDRef(java.lang.String id, java.util.List<PageViewport> pages)` Resolves the idref of this object by getting the PageViewport object that corresponds to the IDRef This method allows the Resolvable object to resolve one of its unresolved idrefs with the actual set of PageViewports containing the target ID. TODO check to make sure it works if multiple bookmark-items have the same idref

    Constructors in org.apache.fop.area with parameters of type PageViewport
    Constructor and Description
    `BookmarkData(java.lang.String title, boolean showChildren, PageViewport pv, java.lang.String idRef)` Create a new bookmark data object.
    `PageViewport(PageViewport original)` Copy constructor.

  - ### Uses of PageViewport in org.apache.fop.area.inline

    Method parameters in org.apache.fop.area.inline with type arguments of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `void` | UnresolvedPageNumber.`resolveIDRef(java.lang.String id, java.util.List<PageViewport> pages)` Resolve the page number idref This resolves the idref for this object by getting the page number string from the first page in the list of pages that apply for this ID.

  - ### Uses of PageViewport in org.apache.fop.layoutmgr

    Methods in org.apache.fop.layoutmgr that return PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `PageViewport` | AbstractLayoutManager.`getCurrentPV()`
    `PageViewport` | AbstractPageSequenceLayoutManager.`getFirstPVWithID(java.lang.String idref)` This returns the first PageViewport that contains an id trait matching the idref argument, or null if no such PV exists.
    `PageViewport` | AbstractPageSequenceLayoutManager.`getLastPVWithID(java.lang.String idref)` This returns the last PageViewport that contains an id trait matching the idref argument, or null if no such PV exists.
    `PageViewport` | Page.`getPageViewport()`

  - ### Uses of PageViewport in org.apache.fop.layoutmgr.inline

    Methods in org.apache.fop.layoutmgr.inline that return PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `protected PageViewport` | PageNumberCitationLayoutManager.`getCitedPage()`
    `protected PageViewport` | PageNumberCitationLastLayoutManager.`getCitedPage()`
    `protected abstract PageViewport` | AbstractPageNumberCitationLayoutManager.`getCitedPage()`

  - ### Uses of PageViewport in org.apache.fop.render

    Fields in org.apache.fop.render declared as PageViewport
    Modifier and Type | Field and Description
    --- | ---
    `protected PageViewport` | AbstractRenderer.`currentPageViewport` the currently active PageViewport

    Methods in org.apache.fop.render that return PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `protected PageViewport` | AbstractRenderer.`getCurrentPageViewport()`

    Methods in org.apache.fop.render with parameters of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `void` | AbstractRenderer.`preparePage(PageViewport page)` This is called if the renderer supports out of order rendering.
    `void` | Renderer.`preparePage(PageViewport page)` This is called if the renderer supports out of order rendering.
    `void` | AbstractRenderer.`renderPage(PageViewport page)` Tells the renderer to render a particular page.
    `void` | Renderer.`renderPage(PageViewport page)` Tells the renderer to render a particular page.

  - ### Uses of PageViewport in org.apache.fop.render.awt

    Methods in org.apache.fop.render.awt with parameters of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `void` | AWTRenderer.`renderPage(PageViewport pageViewport)` This method override only stores the PageViewport in a List.

  - ### Uses of PageViewport in org.apache.fop.render.intermediate

    Methods in org.apache.fop.render.intermediate with parameters of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `void` | IFRenderer.`preparePage(PageViewport page)` This is called if the renderer supports out of order rendering.
    `void` | IFRenderer.`renderPage(PageViewport page)` Tells the renderer to render a particular page.

  - ### Uses of PageViewport in org.apache.fop.render.java2d

    Methods in org.apache.fop.render.java2d that return PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `PageViewport` | Java2DRenderer.`getPageViewport(int pageIndex)` Returns a page viewport.

    Methods in org.apache.fop.render.java2d with parameters of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `java.awt.image.BufferedImage` | Java2DRenderer.`getPageImage(PageViewport pageViewport)` Generates a desired page from the renderer's page viewport list.
    `protected void` | Java2DRenderer.`rememberPage(PageViewport pageViewport)` Stores the pageViewport in a list of page viewports so they can be rendered later.
    `void` | Java2DRenderer.`renderPage(PageViewport pageViewport)` This method override only stores the PageViewport in a List.

  - ### Uses of PageViewport in org.apache.fop.render.print

    Methods in org.apache.fop.render.print with parameters of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | PageableRenderer.`rememberPage(PageViewport pageViewport)` Stores the pageViewport in a list of page viewports so they can be rendered later.

  - ### Uses of PageViewport in org.apache.fop.render.txt

    Methods in org.apache.fop.render.txt with parameters of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `void` | TXTRenderer.`renderPage(PageViewport page)` Tells the renderer to render a particular page.

  - ### Uses of PageViewport in org.apache.fop.render.xml

    Methods in org.apache.fop.render.xml with parameters of type PageViewport
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | AbstractXMLRenderer.`handlePageExtensionAttachments(PageViewport page)` Handles page extension attachments
    `void` | XMLRenderer.`renderPage(PageViewport page)` Tells the renderer to render a particular page.

Copyright 1999-2022 The Apache Software Foundation. All Rights Reserved.