Package com.pdf_tools.fourheights.pdftoolbox.pdf.navigation

Class FitPageDestination

java.lang.Object

com.pdf_tools.fourheights.pdftoolbox.internal.NativeBase

com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

com.pdf_tools.fourheights.pdftoolbox.pdf.navigation.Destination

com.pdf_tools.fourheights.pdftoolbox.pdf.navigation.DirectDestination

com.pdf_tools.fourheights.pdftoolbox.pdf.navigation.FitPageDestination

public class FitPageDestination
extends DirectDestination

A destination fits an entire page into the viewport.

Note: Many PDF viewers support different viewing modes like "fit page" or "fit width". A FitPageDestination will change the current viewing mode to "fit page" 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 Summary

Modifier and Type	Method	Description
static FitPageDestination	create(Document targetDocument, Page page, boolean fitActualContent)	Create a new FitPageDestination
boolean	getFitActualContent()	If true, the viewport is fitted to the actual content of the page, instead of the size of the page.

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.navigation.DirectDestination

getPage

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.pdf.navigation.Destination

getTarget

Methods inherited from class com.pdf_tools.fourheights.pdftoolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

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

Create a new FitPageDestination

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 actual content of the page, instead of the size 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.