Foxit PDF SDK
|
Public Member Functions | |
PagingSealConfig (int paging_seal_position, float offset, float first_page_percent, boolean is_on_perforation) | |
Constructor, with parameter. More... | |
synchronized void | delete () |
Clean up related resources immediately. More... | |
float | getFirst_page_percent () |
Get the percent of the first paging seal. More... | |
boolean | getIs_on_perforation () |
Get decide whether to chop a seal that covering the left or right margin of each two pages. More... | |
float | getOffset () |
Get the offset of paging seal signature. More... | |
int | getPaging_seal_position () |
Get the position of paging seal. More... | |
void | set (int paging_seal_position, float offset, float first_page_percent, boolean is_on_perforation) |
Set value. More... | |
void | setFirst_page_percent (float value) |
Set the percent of the first paging seal. More... | |
void | setIs_on_perforation (boolean value) |
Set decide whether to chop a seal that covering the left or right margin of each two pages. More... | |
void | setOffset (float value) |
Set the offset of paging seal signature. More... | |
void | setPaging_seal_position (int value) |
Set the position of paging seal. More... | |
Static Public Attributes | |
static final int | e_PagingSealPositionBottom = 4 |
Bottom Paging Seal. | |
static final int | e_PagingSealPositionLeft = 1 |
Left Paging Seal. | |
static final int | e_PagingSealPositionRight = 2 |
Right Paging Seal. | |
static final int | e_PagingSealPositionTop = 3 |
Top Paging Seal. | |
This class represents paging seal configuration. This configuration can be set by function PagingSealSignature.setPagingSealConfig .
com.foxit.sdk.pdf.PagingSealConfig.PagingSealConfig | ( | int | paging_seal_position, |
float | offset, | ||
float | first_page_percent, | ||
boolean | is_on_perforation | ||
) |
Constructor, with parameter.
[in] | paging_seal_position | The position of paging seal. Please refer to values starting from PagingSealSignature::e_PagingSealPositionLeft and this would be one of these values. |
[in] | offset | The offset of paging seal. This value should not be a negative number. |
[in] | first_page_percent | The percent of the first paging seal. This parameter should larger than 0.0, less than 1.0. |
[in] | is_on_perforation | Decide whether to chop a seal that covering the margin of each two pages. |
synchronized void com.foxit.sdk.pdf.PagingSealConfig.delete | ( | ) |
Clean up related resources immediately.
com.foxit.sdk.pdf.PagingSealConfig.getFirst_page_percent | ( | ) |
Get the percent of the first paging seal.
com.foxit.sdk.pdf.PagingSealConfig.getIs_on_perforation | ( | ) |
Get decide whether to chop a seal that covering the left or right margin of each two pages.
com.foxit.sdk.pdf.PagingSealConfig.getOffset | ( | ) |
Get the offset of paging seal signature.
This value should not be a negative number. The maximum value of offset is the value of page width or page height minus the width or height of rectangle of paging seal signature. If offset bigger than the maximum value, the maximum will be used.
For top paging seal and bottom paging seal, this value will be the horizontal offset of the left of signature rectangle.
For right paging seal,left paging seal, this value will be the vertical offset of the bottom of signature rectangle.
For the parameter is_on_perforation is true, this value will be the vertical offset of the bottom of signature rectangle.
com.foxit.sdk.pdf.PagingSealConfig.getPaging_seal_position | ( | ) |
Get the position of paging seal.
void com.foxit.sdk.pdf.PagingSealConfig.set | ( | int | paging_seal_position, |
float | offset, | ||
float | first_page_percent, | ||
boolean | is_on_perforation | ||
) |
Set value.
[in] | paging_seal_position | The position of paging seal. Please refer to values starting from PagingSealSignature::e_PagingSealPositionLeft and this would be one of these values. |
[in] | offset | The offset of paging seal. This value should not be a negative number. |
[in] | first_page_percent | The percent of the first paging seal. This parameter should larger than 0.0, less than 1.0. |
[in] | is_on_perforation | Decide whether to chop a seal that covering the margin of each two pages. |
@ return None.
com.foxit.sdk.pdf.PagingSealConfig.setFirst_page_percent | ( | float | value | ) |
Set the percent of the first paging seal.
[in] | value | The percent of the first paging seal. The rest percent will be divided equally by the other paging seals. This parameter should bigger than 0.0, less than 1.0. |
com.foxit.sdk.pdf.PagingSealConfig.setIs_on_perforation | ( | boolean | value | ) |
Set decide whether to chop a seal that covering the left or right margin of each two pages.
[in] | value | Decide whether to chop a seal that covering the left or right margin of each two pages. true means the paging seal signatures will be added to pages in pairs, and the parameter paging_seal_position and the parameter first_page_percent will have no effect. false means not. |
com.foxit.sdk.pdf.PagingSealConfig.setOffset | ( | float | value | ) |
Set the offset of paging seal signature.
This value should not be a negative number. The maximum value of offset is the value of page width or page height minus the width or height of rectangle of paging seal signature. If offset bigger than the maximum value, the maximum will be used.
For top paging seal and bottom paging seal, this value will be the horizontal offset of the left of signature rectangle.
For right paging seal,left paging seal, this value will be the vertical offset of the bottom of signature rectangle.
For the parameter is_on_perforation is true, this value will be the vertical offset of the bottom of signature rectangle.
[in] | value | The offset of paging seal signature. |
com.foxit.sdk.pdf.PagingSealConfig.setPaging_seal_position | ( | int | value | ) |
Set the position of paging seal.
[in] | value | The position of paging seal. Please refer to values starting from PagingSealSignature::e_PagingSealPositionLeft and this would be one of these values. |