Class FitHeightDestination


  • public class FitHeightDestination
    extends DirectDestination

    A destination fits the height of a page into the viewport.

    Note: Many PDF viewers support different viewing modes like "fit page" or "fit width". A FitHeightDestination will change the current viewing mode to "fit height" in those viewers.

    Changing the viewing mode is usually not very well received by users and thus a LocationZoomDestination should be preferred in most cases.

    • Method Detail

      • create

        public static FitHeightDestination create​(Document targetDocument,
                                                  Page page,
                                                  boolean fitActualContent)

        Create a new FitHeightDestination

        The returned object is not yet used on any page, but it is associated with the given target document.
        Parameters:
        targetDocument - The output document with which the returned object is associated
        page - The page in the document that this destination is pointing to.
        fitActualContent -

        If true, the viewport is fitted to the actual content of the page, instead of the size of the page.

        See property getFitActualContent() for more information.

        Returns:
        The newly created destination object.
        Throws:
        java.lang.IllegalArgumentException - if the targetDocument argument has already been closed
        java.lang.IllegalArgumentException - if the targetDocument argument is read-only
        java.lang.IllegalArgumentException - if the targetDocumentdiffers from the document associated with page
        java.lang.IllegalArgumentException - If the document associated with the page argument has already been closed
        java.lang.IllegalArgumentException - if targetDocument is null
        java.lang.IllegalArgumentException - if page is null
      • getFitActualContent

        public boolean getFitActualContent()

        If true, the viewport is fitted to the width of the actual content of the page, instead of the width of the page.

        Note: Many PDF viewers simply ignore this property and always treat it as false, i.e. switching to "fit page" mode anyway.

        Throws:
        java.lang.IllegalStateException - the object has already been closed.
        java.lang.IllegalStateException - the associated document has already been closed.