## Uses of Class
org.faceless.pdf2.PDFPage

- Packages that use PDFPage
  Package | Description
  --- | ---
  org.faceless.pdf2 | Contains the classes used to create a PDF document
  org.faceless.pdf2.viewer2 | The "viewer" package contains the classes required to create a Swing application to display PDFs.
  org.faceless.pdf2.viewer2.feature | Contains a list of all the features that are available to the PDFViewer.

- - ### Uses of PDFPage in org.faceless.pdf2

    Methods in org.faceless.pdf2 that return PDFPage
    Modifier and Type | Method and Description
    --- | ---
    `PDFPage` | PDF.`getLastPage()` Return the last page of this PDF.
    `PDFPage` | EGIZSignatureHandler.`getPage()` Return the page this signature is on (if signed) or will be (if unsigned).
    `PDFPage` | EGIZSignatureHandler.Factory.`getPage()` Return the PDFPage set set by `EGIZSignatureHandler.Factory.setPage(org.faceless.pdf2.PDFPage, int, int, int, int)`
    `PDFPage` | PDFAction.`getPage()` For actions that refer to a page - any of the "GoTo" actions except "GoToURL" - return the page the action refers to.
    `PDFPage` | PDFAnnotation.`getPage()` Return the page that this annotation is on, or `null` if it a new annotation which has not yet been placed on a page
    `PDFPage` | PageExtractor.`getPage()` Return the `PDFPage` this PageExtractor relates to
    `PDFPage` | PageExtractor.Text.`getPage()` Return the `PDFPage` this text was found on - simply the page the parent `PageExtractor` was created from.
    `PDFPage` | PageExtractor.Image.`getPage()` Return the `PDFPage` this image was found on - simply the page the parent `PageExtractor` was created from
    `PDFPage` | PagePainter.`getPage()` Return the PDFPage being painted by this object
    `PDFPage` | PDF.`getPage(int pagenumber)` Return the specified page.
    `PDFPage` | PDF.`getPage(String name)` Get a "Named Page" from the PDF.
    `PDFPage` | PDF.`newPage(int w, int h)` Create a new `PDFPage` object of the specified size and add it to this PDF.
    `PDFPage` | PDF.`newPage(PDFPage page)` Create a new `PDFPage` object that is a clone of the specified page, and add it to this PDF.
    `PDFPage` | PDF.`newPage(String pagesize)` Create a new page of the specified page size and add it to this PDF.

    Methods in org.faceless.pdf2 that return types with arguments of type PDFPage
    Modifier and Type | Method and Description
    --- | ---
    `List<PDFPage>` | PDF.`getPages()` Returns a List of the documents pages which may be manipulated to reorder, delete or append pages to the document.

    Methods in org.faceless.pdf2 with parameters of type PDFPage
    Modifier and Type | Method and Description
    --- | ---
    `WidgetAnnotation` | FormBarCode.`addAnnotation(PDFPage page, float x1, float y1, float x2, float y2)` Create and add a new widget annotation for this field.
    `WidgetAnnotation` | FormButton.`addAnnotation(PDFPage page, float x1, float y1, float x2, float y2)` Add an annotation for this Form element at the specified position on the specified page.
    `WidgetAnnotation` | FormChoice.`addAnnotation(PDFPage page, float x1, float y1, float x2, float y2)` Add an annotation for this element at the specified location on the page
    `WidgetAnnotation` | FormSignature.`addAnnotation(PDFPage page, float x1, float y1, float x2, float y2)` Add an annotation for this Signature to the specified page at the specified location.
    `WidgetAnnotation` | FormText.`addAnnotation(PDFPage page, float x1, float y1, float x2, float y2)` Add an annotation for this element at the specified location on the page
    `void` | Redactor.`addArea(PDFPage page, Area area)` Adds an area to redact out of the document.
    `void` | Redactor.`addStructuredElementByID(PDFPage page, String id)` Adds a marked content ID to redact out of the document.
    `float` | PDFPage.`continueText(float x1, float y1, float x2, float y2, PDFPage page)` As for beginText, but continue any text that overflowed from the specified page.
    `PageExtractor` | PDFParser.`getPageExtractor(PDFPage page)` Returns a `PageExtractor` for the specified page.
    `PagePainter` | PDFParser.`getPagePainter(PDFPage page)` Returns a `PagePainter` for the specified page.
    `static PDFAction` | PDFAction.`goTo(PDFPage page)` Return a new PDFAction which jumps to the specified page in the PDF document.
    `static PDFAction` | PDFAction.`goTo(PDFPage page, float x, float y, float zoom)` Return a new PDFAction which jumps to the specified page in the PDF document, at the specified x, y and zoom level.
    `static PDFAction` | PDFAction.`goToFit(PDFPage page)` Return a new PDFAction which jumps to the specified page in the PDF document.
    `static PDFAction` | PDFAction.`goToFitHeight(PDFPage page, float x)` Return a new PDFAction which jumps to the specified page in the PDF document.
    `static PDFAction` | PDFAction.`goToFitRectangle(PDFPage page, float x1, float y1, float x2, float y2)` Return a new PDFAction which jumps to the specified page in the PDF document.
    `static PDFAction` | PDFAction.`goToFitWidth(PDFPage page, float y)` Return a new PDFAction which jumps to the specified page in the PDF document.
    `PDFPage` | PDF.`newPage(PDFPage page)` Create a new `PDFPage` object that is a clone of the specified page, and add it to this PDF.
    `void` | PDFParser.`resetPageExtractor(PDFPage page)` Reset the previously created PageExtractor.
    `void` | PDFAnnotation.`setPage(PDFPage page)` Set the page for this annotation.
    `void` | EGIZSignatureHandler.Factory.`setPage(PDFPage page, int x1, int y1, int x2, int y2)` Set the page and size of the stamp that will be added by the signature

    Constructors in org.faceless.pdf2 with parameters of type PDFPage
    Constructor and Description
    `FormBarCode(PDFPage page, float x1, float y1, float x2, float y2)` Create a new BarCode field and add an annotation for it to the page
    `FormButton(PDFPage page, float x1, float y1, float x2, float y2)` Create a new FormButton element, and add a single annotation at the specified position.
    `FormCheckbox(PDFPage page, float x1, float y1, float x2, float y2)` Create a new FormCheckbox with a single annotation at the specified position.
    `FormChoice(int type, PDFPage page, float x1, float y1, float x2, float y2)` Create a new `FormChoice` element with an annotation at the specified location.
    `FormText(PDFPage page, float x1, float y1, float x2, float y2)` Create a new FormText object, and add an annotation at the specified location.
    `PDFCanvas(PDFPage page)` Create a new Canvas that's a clone of the specified `PDFPage`.
    `PDFPage(PDFPage page)` Create a new `PDFPage` object that's a clone of the specified page but is not connected to any document.

  - ### Uses of PDFPage in org.faceless.pdf2.viewer2

    Methods in org.faceless.pdf2.viewer2 that return PDFPage
    Modifier and Type | Method and Description
    --- | ---
    `PDFPage` | DocumentPanel.`getPage()` Return the PDFPage currently being displayed by the `DocumentViewport`.
    `PDFPage` | DocumentViewport.`getPage()` Return the PDFPage in use by `DocumentViewport.getPagePanel()`
    `PDFPage` | DualPageDocumentViewport.`getPage()`
    `PDFPage` | NullDocumentViewport.`getPage()`
    `PDFPage` | PagePanel.`getPage()` Return the `PDFPage` currently being displayed by this viewport.
    `PDFPage` | PagePanelEvent.`getPage()` Get the Page this event refers to
    `PDFPage` | PagePanelInteractionEvent.`getPage()` Get the Page this event refers to
    `abstract PDFPage` | DocumentViewport.`getRenderingPage()` Return the page that is currently in the process of rendering.
    `PDFPage` | DualPageDocumentViewport.`getRenderingPage()`
    `PDFPage` | MultiPageDocumentViewport.`getRenderingPage()`
    `PDFPage` | NullDocumentViewport.`getRenderingPage()`
    `PDFPage` | SinglePageDocumentViewport.`getRenderingPage()`

    Methods in org.faceless.pdf2.viewer2 with parameters of type PDFPage
    Modifier and Type | Method and Description
    --- | ---
    `static PagePanelEvent` | PagePanelEvent.`createPageHidden(PagePanel panel, PDFPage page)` Create a "hidden" PagePanelEvent
    `static PagePanelEvent` | PagePanelEvent.`createPageRedrawing(PagePanel panel, PDFPage page)` Create a "redrawing" PagePanelEvent
    `static PagePanelEvent` | PagePanelEvent.`createPageRedrawn(PagePanel panel, PDFPage page)` Create a "redrawn" PagePanelEvent
    `static PagePanelEvent` | PagePanelEvent.`createPageVisible(PagePanel panel, PDFPage page)` Create a "visible" PagePanelEvent
    `void` | DocumentViewport.`ensureVisible(PDFPage page, double x, double y)` Ensure the specified point on the page is visible.
    `void` | DualPageDocumentViewport.`ensureVisible(PDFPage page, double x, double y)`
    `void` | MultiPageDocumentViewport.`ensureVisible(PDFPage page, double x, double y)`
    `void` | SinglePageDocumentViewport.`ensureVisible(PDFPage page, double x, double y)`
    `static Rectangle2D` | PagePanel.`getFullPageView(PDFPage page)` Return the area of the page that is considered to be the "whole page" as far as the viewer is concerned - the `ViewBox`
    `int` | DocumentViewport.`getNextSelectablePageIndex(PDFPage page)` Return the index of the page that should be displayed when the specified page is selected in this viewport and the "next page" is requested, via a button or other action.
    `int` | DualPageDocumentViewport.`getNextSelectablePageIndex(PDFPage page)`
    `int` | DocumentViewport.`getPreviousSelectablePageIndex(PDFPage page)` Return the index of the page that should be displayed when the specified page is selected in this viewport and the "previous page" is requested, via a button or other action.
    `int` | DualPageDocumentViewport.`getPreviousSelectablePageIndex(PDFPage page)`
    `float` | DocumentViewport.`getTargetZoom(int zoommode, PDFPage page)` Return the appropriate zoom level when switching to the specified page.
    `float` | DualPageDocumentViewport.`getTargetZoom(int zoommode, PDFPage page)`
    `float` | MultiPageDocumentViewport.`getTargetZoom(int zoommode, PDFPage page)`
    `float` | SinglePageDocumentViewport.`getTargetZoom(int zoommode, PDFPage page)`
    `boolean` | DocumentViewport.`isPageVisible(PDFPage page, double x, double y)` Indicates whether the specified point in the specified page is visible in the viewport.
    `boolean` | DualPageDocumentViewport.`isPageVisible(PDFPage page, double x, double y)`
    `boolean` | MultiPageDocumentViewport.`isPageVisible(PDFPage page, double x, double y)`
    `boolean` | SinglePageDocumentViewport.`isPageVisible(PDFPage page, double x, double y)`
    `JSEvent` | JSManager.`runEventPageClose(DocumentPanel panel, PDFPage page)` Raise the `Page/Close` JavaScript method
    `JSEvent` | JSManager.`runEventPageOpen(DocumentPanel panel, PDFPage page)` Raise the `Page/Open` JavaScript method
    `void` | DocumentPanel.`setPage(PDFPage page)` Set the page to display in the `DocumentViewport`.
    `abstract void` | DocumentViewport.`setPage(PDFPage page, double x, double y, double zoom)` Set the currently displayed page.
    `void` | DualPageDocumentViewport.`setPage(PDFPage page, double x, double y, double zoom)`
    `void` | MultiPageDocumentViewport.`setPage(PDFPage page, double x, double y, double zoom)`
    `void` | NullDocumentViewport.`setPage(PDFPage page, double x, double y, double zoom)`
    `void` | SinglePageDocumentViewport.`setPage(PDFPage page, double x, double y, double zoom)`
    `void` | DocumentPanel.`setPage(PDFPage page, float x, float y, float zoom)` Set the page to display in the `DocumentViewport`.
    `void` | PagePanel.`setPage(PDFPage page, float x1, float y1, float x2, float y2, float dpi)` Redraw the page.
    `void` | PagePanel.`setPage(PDFPage page, float x1, float y1, float x2, float y2, float dpi, Rectangle clip)` Redraw the page.
    `void` | PagePanel.`setPage(PDFPage page, Rectangle2D position, float dpi)` Redraw the page.
    `void` | PagePanel.`setPage(PDFPage page, Rectangle2D position, float dpi, Rectangle clip)` Redraw the page.
    `void` | DocumentPanel.`setPDF(PDFParser parser, PDFPage page)` Set the PDF to be displayed by this `DocumentPanel`, and specify the initial page to display and the exact `PDFParser` to use.
    `void` | DocumentPanel.`setPDF(PDF pdf, PDFPage page)` Set the PDF to be displayed by this `DocumentPanel`, and specify the initial page to display.

  - ### Uses of PDFPage in org.faceless.pdf2.viewer2.feature

    Methods in org.faceless.pdf2.viewer2.feature that return PDFPage
    Modifier and Type | Method and Description
    --- | ---
    `PDFPage` | TextSelection.Range.`getPage()` Return the `PDFPage` this range object relates to.
    `PDFPage` | ThumbnailPanel.SinglePagePanel.`getPage()` Get the Page this SinglePagePanel contains

    Methods in org.faceless.pdf2.viewer2.feature that return types with arguments of type PDFPage
    Modifier and Type | Method and Description
    --- | ---
    `Set<PDFPage>` | TextSelection.RangeList.`getPages()` Return the list of Pages included with this Range
    `List<PDFPage>` | ThumbnailPanel.View.`getSelectedPages()` Return a `List` of selected pages

    Methods in org.faceless.pdf2.viewer2.feature with parameters of type PDFPage
    Modifier and Type | Method and Description
    --- | ---
    `float[]` | TextSelection.RangeList.`getCorners(PDFPage page)` Get the Corners of the area marked by this highlight.
    `JComponent` | Info.`getInfoPanel(PDF pdf, PDFPage page, File file)`

    Method parameters in org.faceless.pdf2.viewer2.feature with type arguments of type PDFPage
    Modifier and Type | Method and Description
    --- | ---
    `void` | ThumbnailPanel.View.`setSelectedPages(List<PDFPage> pages)` Set the list of selected pages.

Copyright © 2001-2015 Big Faceless Organization