public class PdfDestination extends PdfArray
PdfDestination
is a reference to a location in a PDF file.
Modifier and Type | Field and Description |
---|---|
static int |
FIT
This is a possible destination type
|
static int |
FITB
This is a possible destination type
|
static int |
FITBH
This is a possible destination type
|
static int |
FITBV
This is a possible destination type
|
static int |
FITH
This is a possible destination type
|
static int |
FITR
This is a possible destination type
|
static int |
FITV
This is a possible destination type
|
static int |
XYZ
This is a possible destination type
|
Constructor and Description |
---|
PdfDestination(int type)
Constructs a new PdfDestination .
|
PdfDestination(int type, float parameter)
Constructs a new PdfDestination .
|
PdfDestination(int type, float left, float top, float zoom)
Constructs a new PdfDestination .
|
PdfDestination(int type, float left, float bottom, float right, float top)
Constructs a new PdfDestination .
|
PdfDestination(PdfDestination d) |
PdfDestination(String dest)
Creates a PdfDestination based on a String.
|
Modifier and Type | Method and Description |
---|---|
boolean |
addPage(PdfIndirectReference page)
Adds the indirect reference of the destination page.
|
boolean |
hasPage()
Checks if an indirect reference to a page has been added.
|
add, add, add, add, addFirst, asDoubleArray, asLongArray, contains, getArrayList, getAsArray, getAsBoolean, getAsDict, getAsIndirectObject, getAsName, getAsNumber, getAsStream, getAsString, getDirectObject, getPdfObject, isEmpty, iterator, listIterator, remove, set, size, toPdf, toString
canBeInObjStm, getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
forEach, spliterator
public static final int XYZ
public static final int FIT
public static final int FITH
public static final int FITV
public static final int FITR
public static final int FITB
public static final int FITBH
public static final int FITBV
public PdfDestination(PdfDestination d)
public PdfDestination(int type)
PdfDestination
.
If type equals FITB, the bounding box of a page will fit the window of the Reader. Otherwise the type will be set to FIT so that the entire page will fit to the window.
type
- The destination type
public PdfDestination(int type, float parameter)
PdfDestination
.
If type equals FITBH / FITBV, the width / height of the bounding box of a page will fit the window of the Reader. The parameter will specify the y / x coordinate of the top / left edge of the window. If the type equals FITH or FITV the width / height of the entire page will fit the window and the parameter will specify the y / x coordinate of the top / left edge. In all other cases the type will be set to FITH.
type
- the destination type
parameter
- a parameter to combined with the destination type
public PdfDestination(int type, float left, float top, float zoom)
PdfDestination
.
Display the page, with the coordinates (left, top) positioned at the top-left corner of the window and the contents of the page magnified by the factor zoom. A negative value for any of the parameters left or top, or a zoom value of 0 specifies that the current value of that parameter is to be retained unchanged.
type
- must be a PdfDestination.XYZ
left
- the left value. Negative to place a null
top
- the top value. Negative to place a null
zoom
- The zoom factor. A value of 0 keeps the current value
public PdfDestination(int type, float left, float bottom, float right, float top)
PdfDestination
.
Display the 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. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.
type
- must be PdfDestination.FITR
left
- a parameter
bottom
- a parameter
right
- a parameter
top
- a parameter
public PdfDestination(String dest)
dest
- a String notation of a destination.
public boolean hasPage()
true
or false
public boolean addPage(PdfIndirectReference page)
page
- an indirect reference
Copyright © 2016. All rights reserved.