Module org.sejda.sambox
Class PDPageFitRectangleDestination
java.lang.Object
org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDDestination
org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageFitRectangleDestination
- All Implemented Interfaces:
COSObjectable,PDDestinationOrAction
Display the page designated by page, with its contents magnified just enough to fit the rectangle
specified by the coordinates left, bottom, right, and top entirely within the window both
horizontally and vertically
- Author:
- Ben Litchfield
-
Field Summary
FieldsFields inherited from class org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
array -
Constructor Summary
ConstructorsConstructorDescriptionConstructor from an existing destination array. -
Method Summary
Modifier and TypeMethodDescriptionintGet the bottom y coordinate.intgetLeft()Get the left x coordinate.intgetRight()Get the right x coordinate.intgetTop()Get the top y coordinate.voidsetBottom(int y) Set the bottom y-coordinate, a value of -1 implies that the current y-coordinate will be used.voidsetLeft(int x) Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.voidsetRight(int x) Set the right x-coordinate, a value of -1 implies that the current x-coordinate will be used.voidsetTop(int y) Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.voidTransforms the destination target coordinates based on the given transformationMethods inherited from class org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDPageDestination
getCOSObject, getPage, getPageNumber, retrievePageNumber, setPage, setPageNumberMethods inherited from class org.sejda.sambox.pdmodel.interactive.documentnavigation.destination.PDDestination
create
-
Field Details
-
TYPE
The type of this destination.- See Also:
-
-
Constructor Details
-
PDPageFitRectangleDestination
public PDPageFitRectangleDestination() -
PDPageFitRectangleDestination
Constructor from an existing destination array.- Parameters:
arr- The destination array.
-
-
Method Details
-
getLeft
public int getLeft()Get the left x coordinate. A return value of -1 implies that the current x-coordinate will be used.- Returns:
- The left x coordinate.
-
setLeft
public void setLeft(int x) Set the left x-coordinate, a value of -1 implies that the current x-coordinate will be used.- Parameters:
x- The left x coordinate.
-
getBottom
public int getBottom()Get the bottom y coordinate. A return value of -1 implies that the current y-coordinate will be used.- Returns:
- The bottom y coordinate.
-
setBottom
public void setBottom(int y) Set the bottom y-coordinate, a value of -1 implies that the current y-coordinate will be used.- Parameters:
y- The bottom y coordinate.
-
getRight
public int getRight()Get the right x coordinate. A return value of -1 implies that the current x-coordinate will be used.- Returns:
- The right x coordinate.
-
setRight
public void setRight(int x) Set the right x-coordinate, a value of -1 implies that the current x-coordinate will be used.- Parameters:
x- The right x coordinate.
-
getTop
public int getTop()Get the top y coordinate. A return value of -1 implies that the current y-coordinate will be used.- Returns:
- The top y coordinate.
-
setTop
public void setTop(int y) Set the top y-coordinate, a value of -1 implies that the current y-coordinate will be used.- Parameters:
y- The top ycoordinate.
-
transform
Description copied from class:PDPageDestinationTransforms the destination target coordinates based on the given transformation- Specified by:
transformin classPDPageDestination
-