Package com.pdftools.toolbox.pdf.navigation

Class FitRectangleDestination

java.lang.Object

com.pdftools.toolbox.internal.NativeBase

com.pdftools.toolbox.internal.NativeObject

com.pdftools.toolbox.pdf.navigation.Destination

com.pdftools.toolbox.pdf.navigation.DirectDestination

com.pdftools.toolbox.pdf.navigation.FitRectangleDestination

public class FitRectangleDestination
extends DirectDestination

A destination that fits a specified area of a page into the viewport.

Note: Many PDF viewers support different viewing modes like "fit page" or "fit width". A FitRectangleDestination will change the current viewing mode to standard mode in those viewers, i.e. deactivate any special mode like "fit page" or "fit width".

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 FitRectangleDestination	create(Document targetDocument, Page page, Rectangle rectangle)	Create a new FitRectangleDestination
Rectangle	getRectangle()	The rectangle that is displayed in the viewport.

Methods inherited from class com.pdftools.toolbox.pdf.navigation.DirectDestination

getPage

Methods inherited from class com.pdftools.toolbox.pdf.navigation.Destination

getTarget

Methods inherited from class com.pdftools.toolbox.internal.NativeObject

equals, hashCode

Methods inherited from class java.lang.Object

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

Method Detail

create

public static FitRectangleDestination create(Document targetDocument,
                                             Page page,
                                             Rectangle rectangle)

Create a new FitRectangleDestination

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.

rectangle -

The rectangle that is displayed in the viewport.

See property getRectangle() 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

java.lang.IllegalArgumentException - if rectangle is null

getRectangle

public Rectangle getRectangle()

The rectangle that is displayed in the viewport.

Throws:

java.lang.IllegalStateException - the object has already been closed.

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