Public Member Functions | |
Destination (PDFArray dest_array) | |
Constructor, with a specified PDF array object. More... | |
Destination (Destination other) | |
Constructor, with another Destination object. More... | |
float | getBottom () throws com.foxit.sdk.PDFException |
Get bottom position value. More... | |
PDFArray | getDestArray () throws com.foxit.sdk.PDFException |
Get the destination PDF array. More... | |
float | getLeft () throws com.foxit.sdk.PDFException |
Get left position value. More... | |
int | getPageIndex (PDFDoc document) throws com.foxit.sdk.PDFException |
Get the index of the destination page. More... | |
float | getRight () throws com.foxit.sdk.PDFException |
Get right position value. More... | |
float | getTop () throws com.foxit.sdk.PDFException |
Get top position value. More... | |
float | getZoomFactor () throws com.foxit.sdk.PDFException |
Get zoom factor. More... | |
int | getZoomMode () throws com.foxit.sdk.PDFException |
Get the zoom mode. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
boolean | isLeftNull () throws com.foxit.sdk.PDFException |
Check if left value is a null object. More... | |
boolean | isTopNull () throws com.foxit.sdk.PDFException |
Check if top value is a null object. More... | |
Static Public Member Functions | |
static Destination | createFitBBox (PDFDoc document, int page_index) throws com.foxit.sdk.PDFException |
Create a Destination object for zoom mode e_ZoomFitBBox. More... | |
static Destination | createFitBHorz (PDFDoc document, int page_index, float top) throws com.foxit.sdk.PDFException |
Create a Destination object for zoom mode e_ZoomFitBHorz. More... | |
static Destination | createFitBVert (PDFDoc document, int page_index, float left) throws com.foxit.sdk.PDFException |
Create a Destination object for zoom mode e_ZoomFitBVert. More... | |
static Destination | createFitHorz (PDFDoc document, int page_index, float top) throws com.foxit.sdk.PDFException |
Create a Destination object for zoom mode e_ZoomFitHorz. More... | |
static Destination | createFitPage (PDFDoc document, int page_index) throws com.foxit.sdk.PDFException |
Create a Destination object for zoom mode e_ZoomFitPage. More... | |
static Destination | createFitRect (PDFDoc document, int page_index, float left, float bottom, float right, float top) throws com.foxit.sdk.PDFException |
Create a Destination object for zoom mode e_ZoomFitRect. More... | |
static Destination | createFitVert (PDFDoc document, int page_index, float left) throws com.foxit.sdk.PDFException |
Create a Destination object for zoom mode e_ZoomFitVert. More... | |
static Destination | createFromPDFArray (PDFDoc document, PDFArray pdf_array) throws com.foxit.sdk.PDFException |
Create a Destination object from an existing destination array. More... | |
static Destination | createXYZ (PDFDoc document, int page_index, float left, float top, float zoom_factor) throws com.foxit.sdk.PDFException |
Create a Destination object for zoom mode e_ZoomXYZ. More... | |
Static Public Attributes | |
static final int | e_ZoomFitBBox = 6 |
Fit the bounding box of page entirely within the display area when display the page. More... | |
static final int | e_ZoomFitBHorz = 7 |
Fit the entire width of the page's bounding box within the display area when display the page. More... | |
static final int | e_ZoomFitBVert = 8 |
Fit the entire height of the page's bounding box within the display area when display the page. More... | |
static final int | e_ZoomFitHorz = 3 |
Fit the entire width of the page within the display area when display the page. More... | |
static final int | e_ZoomFitPage = 2 |
Fit the entire page within the display area when display the page. More... | |
static final int | e_ZoomFitRect = 5 |
Fit the page content in a specified rectangle entirely within the display area when display the page. More... | |
static final int | e_ZoomFitVert = 4 |
Fit the entire height of the page within the display area when display the page. More... | |
static final int | e_ZoomXYZ = 1 |
Display page with a specified position and a specified zoom factor. More... | |
A destination defines a particular view of a PDF document, consisting of the following items:
The page of the document to be displayed.
The location of the document window on that page.
The magnification (zoom) factor to use when displaying the page.
Destinations may be associated with bookmarks, or some types of actions. In each case, the destination specifies the view of the document to be presented when the bookmark item or link annotation is opened or the action is performed.
This class offers functions to create destination objects for different zoom mode, and get destination data.
com.foxit.sdk.pdf.actions.Destination.Destination | ( | PDFArray | dest_array | ) |
Constructor, with a specified PDF array object.
dest_array | A PDF array object that represents destination data. |
com.foxit.sdk.pdf.actions.Destination.Destination | ( | Destination | other | ) |
Constructor, with another Destination object.
other | Another Destination object. |
|
static |
Create a Destination object for zoom mode e_ZoomFitBBox.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
|
static |
Create a Destination object for zoom mode e_ZoomFitBHorz.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
top | The vertical coordinate of top edge |
|
static |
Create a Destination object for zoom mode e_ZoomFitBVert.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
left | Horizontal coordinate of left edge. |
|
static |
Create a Destination object for zoom mode e_ZoomFitHorz.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
top | Vertical coordinate of top edge. |
|
static |
Create a Destination object for zoom mode e_ZoomFitPage.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
|
static |
Create a Destination object for zoom mode e_ZoomFitRect.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
left | The coordinate left of a rectangle. |
bottom | The coordinate bottom of a rectangle. |
right | The coordinate right of a rectangle. |
top | The coordinate top of a rectangle. |
|
static |
Create a Destination object for zoom mode e_ZoomFitVert.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
left | Horizontal coordinate of left edge. |
|
static |
Create a Destination object from an existing destination array.
document | A valid PDF document object. |
pdf_array | A destination PDF array. This PDF array can be retrieved from a PDFNameTree in type objects::e_Dests. |
|
static |
Create a Destination object for zoom mode e_ZoomXYZ.
document | A valid PDF document object. |
page_index | The index of the destination page in the PDF document. |
left | Horizontal coordinate value of a position as page's left-top position. |
top | Vertical coordinate value of a position as page's left-top position. |
zoom_factor | Zoom factor value. |
float com.foxit.sdk.pdf.actions.Destination.getBottom | ( | ) | throws com.foxit.sdk.PDFException |
Get bottom position value.
This is only useful when zoom mode is e_ZoomFitRect. For other zoom mode, this function will be 0.0f.
PDFArray com.foxit.sdk.pdf.actions.Destination.getDestArray | ( | ) | throws com.foxit.sdk.PDFException |
Get the destination PDF array.
float com.foxit.sdk.pdf.actions.Destination.getLeft | ( | ) | throws com.foxit.sdk.PDFException |
Get left position value.
This is only useful when zoom mode is e_ZoomXYZ, e_ZoomFitVert, e_ZoomFitRect or e_ZoomFitBVert. Specially for e_ZoomXYZ, e_ZoomFitVert and e_ZoomFitBVert, left value may be a null object, which means that just use current left value of application as the destination's left value. For this case, this function will return 0.0f. In order to check if the left value is just 0 or a null object, user is recommended to call function Destination::isLeftNull.
For other zoom mode, this function will return 0.0f.
int com.foxit.sdk.pdf.actions.Destination.getPageIndex | ( | PDFDoc | document | ) | throws com.foxit.sdk.PDFException |
Get the index of the destination page.
document | A valid PDF document object. |
float com.foxit.sdk.pdf.actions.Destination.getRight | ( | ) | throws com.foxit.sdk.PDFException |
Get right position value.
This is only useful when zoom mode is e_ZoomFitRect. For other zoom mode, this function will be 0.0f.
float com.foxit.sdk.pdf.actions.Destination.getTop | ( | ) | throws com.foxit.sdk.PDFException |
Get top position value.
This is only useful when zoom mode is e_ZoomXYZ, e_ZoomFitHorz, e_ZoomFitBHorz or e_ZoomFitRect. Specially for e_ZoomXYZ, e_ZoomFitHorz and e_ZoomFitBHorz, top value may be a null object, which means that just use current top value of application as the destination's top value. For this case, this function will return 0.0f. In order to check if the left value is just 0 or a null object, user is recommended to call function Destination::isTopNull.
For other zoom mode, this function will return 0.0f.
float com.foxit.sdk.pdf.actions.Destination.getZoomFactor | ( | ) | throws com.foxit.sdk.PDFException |
int com.foxit.sdk.pdf.actions.Destination.getZoomMode | ( | ) | throws com.foxit.sdk.PDFException |
Get the zoom mode.
boolean com.foxit.sdk.pdf.actions.Destination.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
boolean com.foxit.sdk.pdf.actions.Destination.isLeftNull | ( | ) | throws com.foxit.sdk.PDFException |
Check if left value is a null object.
This is only useful when zoom mode is e_ZoomXYZ, e_ZoomFitVert or e_ZoomFitBVert. This function can be used to check if the left value is a null object. For other zoom mode, this function will return false.
boolean com.foxit.sdk.pdf.actions.Destination.isTopNull | ( | ) | throws com.foxit.sdk.PDFException |
Check if top value is a null object.
This is only useful when zoom mode is e_ZoomXYZ, e_ZoomFitHorz, or e_ZoomFitBHorz. This function can be used to check if the top value is a null object. For other zoom mode, this function will return false.
|
static |
Fit the bounding box of page entirely within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit its bounding box entirely within the display area both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the display area in the other dimension.
|
static |
Fit the entire width of the page's bounding box within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire width of the page's bounding box within the display area.
|
static |
Fit the entire height of the page's bounding box within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire height of the page's bounding box within the display area.
|
static |
Fit the entire width of the page within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire width of the page within the display area.
|
static |
Fit the entire page within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire page within the display area both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
|
static |
Fit the page content in a specified rectangle entirely within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the page content in the specified rectangle entirely within the display area 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 display area in the other dimension.
|
static |
Fit the entire height of the page within the display area when display the page.
If this is used, that means the contents of the page should be magnified just enough to fit the entire height of the page within the display area.
|
static |
Display page with a specified position and a specified zoom factor.
If this is used, that means the specified position of the page will be treated as the left-top position when the page is rendered and this position should be at the upper-left corner of the display area. Contents of the page should be magnified by the specified zoom factor.