public class PDFParameter
extends java.lang.Object
implements java.io.Serializable
PDFParameter
class is used for exporting to PDF. It contains all the
information for exporting report results.Modifier and Type | Field and Description |
---|---|
static int |
AllowAll
The operation permitted when the document is opened with the user password
|
static int |
AllowAnyExceptExtract
The operation permitted when the document is opened with the user password
|
static int |
AllowCommentFillIn
The operation permitted when the document is opened with the user password
|
static int |
AllowCopy
The operation permitted when the document is opened with the user password
|
static int |
AllowFillInSign
The operation permitted when the document is opened with the user password
|
static int |
AllowHighResPrint
The operation permitted when the document is opened with the user password
|
static int |
AllowInsertDeleteRotate
The operation permitted when the document is opened with the user password
|
static int |
AllowLayoutFillInSign
The operation permitted when the document is opened with the user password
|
static int |
AllowLowResPrint
The operation permitted when the document is opened with the user password
|
static int |
AllowNone
The operation permitted when the document is opened with the user password
|
static int |
AllowScreenReaders
The operation permitted when the document is opened with the user password
|
static int |
SELF_SIGNED
The self signed method.
|
static boolean |
STRENGTH128BITS
Type of encryption
|
static boolean |
STRENGTH40BITS
Type of encryption
|
static int |
TAG_ORDER_CONTENT_COORDINATE
Predefined Item for tag order.
|
static int |
TAG_ORDER_TEMPLATE_OBJ
Predefined Item for tag order.
|
static int |
VERISIGN_SIGNED
The VeriSign method.
|
static int |
WINCER_SIGNED
The Windows Certificate Security method.
|
static java.lang.String |
ZOOM_STR_100_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_125_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_150_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_1600_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_200_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_2400_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_25_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_3200_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_400_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_50_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_6400_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_75_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_800_PERCENT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_ACTUAL_SIZE
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_DEFAULT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_FIT_HEIGHT
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_FIT_PAGE
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_FIT_VISIBLE
A predefined item for the zooming.
|
static java.lang.String |
ZOOM_STR_FIT_WIDTH
A predefined item for the zooming.
|
Constructor and Description |
---|
PDFParameter()
constructor
|
Modifier and Type | Method and Description |
---|---|
PDFParameter |
copy()
Adding this method for MailInformation can clone this object.
|
boolean |
getAccessibility() |
boolean |
getClippingArea()
Get PDF clipping area control.
|
java.lang.String |
getDigitalIDFilePassword()
Gets the password of the digital ID file.
|
java.io.InputStream |
getDigitalIDFileStream()
Gets the digital ID file path.
|
int[][] |
getExportPageRange()
Gets the exporting page range.
|
int[] |
getExportPages()
Gets the exporting page number.
|
int |
getImageCompressRatio()
Gets the image compression ratio of the pdf file.
|
int |
getMaxPageOfOneFile()
Gets the max size of one PDF file.
|
int |
getMaxSizeOfOneFile()
Gets the max size of one PDF file.
|
java.lang.String |
getOwnerPassword()
Gets the owner password of the pdf document.
|
int |
getPermissions()
Gets the permissions of pdf document.
|
int |
getSignatureMethod()
Gets the signature method for the document, which can be
SELF_SIGNED, WINCER_SIGNED and VERISIGN_SIGNED.
|
java.lang.String |
getSigningContact()
Gets the signing contact.
|
java.lang.String |
getSigningLocation()
Gets the signing location.
|
java.lang.String |
getSigningReason()
Gets the signing reason.
|
java.lang.String |
getSubject()
Gets the subject of PDF document.
|
int |
getTagOrder()
Returns the tag order
|
java.lang.String |
getTitle()
Gets the title of PDF document.
|
java.lang.String |
getUserPassword()
Gets the user password of the pdf document.
|
PDFZooming |
getZooming() |
boolean |
hasDrill()
Gets the pdf file with Drill Down.
|
boolean |
hasEncryption() |
boolean |
hasSignature() |
boolean |
hasToc()
Gets the pdf file with TOC.
|
boolean |
isNoFileExt() |
boolean |
isPDFACompliant()
get the status of PDF/A compliant .
|
boolean |
isSimPrintMode()
Gets the pdf print mode when generating charts and barcodes.
|
boolean |
isStrength128Bits()
Gets if the pdf document Encryption level is High(128-bit RC4) or Low(40-bit RC4).
|
boolean |
isTransparent()
Deprecated.
this is replaced by the method setImageCompressRatio(int imageCompressRatio)
|
boolean |
noMargin()
Gets the document whether it has margin or not.
|
void |
setAccessibility(boolean b)
Set the flag that indicates whether the PDF doc should be compliant with
the accessibility standard.
|
void |
setClippingArea(boolean clip)
This method is used for PDF clipping area control.
|
void |
setDigitalSignature(int signatureMethod,
byte[] digitalIDValues,
java.lang.String digitalIDFilePassword)
Sets the digital signature options for this document.
|
void |
setDigitalSignature(int signatureMethod,
java.io.InputStream digitalIDFileStream,
java.lang.String digitalIDFilePassword)
Sets the digital signature options for this document.
|
void |
setDigitalSignature(int signatureMethod,
java.lang.String digitalIDFilePath,
java.lang.String digitalIDFilePassword)
Sets the digital signature options for this document.
|
void |
setDrill(boolean hasDrill)
Sets the pdf file with Drill Down.
|
void |
setEncryption(boolean strength128Bits,
java.lang.String userPassword,
java.lang.String ownerPassword,
int permissions)
Sets the encryption options for this document.
|
void |
setExportPageRange(int[][] pageRange)
Sets the exporting page range.
|
void |
setExportPages(int[] pages)
Sets the exporting page number.
|
void |
setImageCompressRatio(int imageCompressRatio)
Sets the image compression ratio of the pdf file.
|
void |
setIsSimPrintMode(boolean isSimPrintMode)
Sets the pdf print mode when generating charts and barcodes.
|
void |
setMaxPageOfOneFile(int maxPageOfOneFile)
Sets the max size of one PDF File.
|
void |
setMaxSizeOfOneFile(int maxSizeOfOneFile)
Sets the max size of one PDF File.
|
void |
setNoFileExt(boolean noFileExt) |
void |
setNoMargin(boolean noMargin)
Sets the pdf file without page margin.
|
void |
setPassword(java.lang.String password) |
void |
setPDFACompliant(boolean pdfaCom)
set status of PDF/A compliant.
|
void |
setSigningContact(java.lang.String contact)
Sets the signing contact.
|
void |
setSigningLocation(java.lang.String location)
Sets the signing location.
|
void |
setSigningReason(java.lang.String reason)
Sets the signing reason.
|
void |
setSubject(java.lang.String subject) |
void |
setTagOrder(int tagOrder)
Specify how to determine the tag order of report content.
|
void |
setTitle(java.lang.String title) |
void |
setToc(boolean hasToc)
Sets the pdf file with TOC.
|
void |
setTransparent(boolean transparent)
Deprecated.
this is replaced by the method setImageCompressRatio(int imageCompressRatio)
|
boolean |
setZooming(java.lang.String zooming)
Set the zooming used to display the page when opening the result PDF file.
|
public static final int AllowNone
public static final int AllowLowResPrint
public static final int AllowHighResPrint
public static final int AllowInsertDeleteRotate
public static final int AllowFillInSign
public static final int AllowCommentFillIn
public static final int AllowAnyExceptExtract
public static final int AllowCopy
public static final int AllowScreenReaders
public static final int AllowLayoutFillInSign
public static final int AllowAll
public static final boolean STRENGTH40BITS
public static final boolean STRENGTH128BITS
public static final int SELF_SIGNED
public static final int VERISIGN_SIGNED
public static final int WINCER_SIGNED
public static final int TAG_ORDER_TEMPLATE_OBJ
public static final int TAG_ORDER_CONTENT_COORDINATE
public static final java.lang.String ZOOM_STR_DEFAULT
public static final java.lang.String ZOOM_STR_ACTUAL_SIZE
public static final java.lang.String ZOOM_STR_FIT_PAGE
public static final java.lang.String ZOOM_STR_FIT_WIDTH
public static final java.lang.String ZOOM_STR_FIT_HEIGHT
public static final java.lang.String ZOOM_STR_FIT_VISIBLE
public static final java.lang.String ZOOM_STR_25_PERCENT
public static final java.lang.String ZOOM_STR_50_PERCENT
public static final java.lang.String ZOOM_STR_75_PERCENT
public static final java.lang.String ZOOM_STR_100_PERCENT
public static final java.lang.String ZOOM_STR_125_PERCENT
public static final java.lang.String ZOOM_STR_150_PERCENT
public static final java.lang.String ZOOM_STR_200_PERCENT
public static final java.lang.String ZOOM_STR_400_PERCENT
public static final java.lang.String ZOOM_STR_800_PERCENT
public static final java.lang.String ZOOM_STR_1600_PERCENT
public static final java.lang.String ZOOM_STR_2400_PERCENT
public static final java.lang.String ZOOM_STR_3200_PERCENT
public static final java.lang.String ZOOM_STR_6400_PERCENT
public void setTagOrder(int tagOrder)
TAG_ORDER_TEMPLATE_OBJ
the order is determined by the objects order in Inspector tree of designer.
TAG_ORDER_CONTENT_COORDINATE
the order is determined by the coordinate of content objects on the pages.
The tag corresponding to the content object with smaller y value will be in the front;
the tag corresponding to the content object with smaller x value will be in the front
if 2 content objects' y values are the same.
If the difference between 2 content objects' y values is less than 40 (0.5 point),
it should be regarded as that these 2 content objects' y values are the same.
This option takes effect only when accessibility is set to true.tagOrder
- one of TAG_ORDER_TEMPLATE_OBJ
or TAG_ORDER_CONTENT_COORDINATE
public int getTagOrder()
public void setPDFACompliant(boolean pdfaCom)
pdfaCom
- the value of PDF/A compliant.
When it is true, it will generate Logi report PDF/A3 result.public boolean isPDFACompliant()
public void setNoMargin(boolean noMargin)
noMargin
- indicates to generate the pdf file without page marginpublic void setIsSimPrintMode(boolean isSimPrintMode)
isSimPrintMode
- if the value is true, then specifies to generate the
charts and barcodes using Vector graphics, else generates charts and barcodes
using images(recommended)public void setImageCompressRatio(int imageCompressRatio)
imageCompressRatio
- specifies to generate the pdf file with compressed imagepublic void setToc(boolean hasToc)
hasToc
- specifies to generate the pdf file with TOCpublic void setDrill(boolean hasDrill)
hasDrill
- specifies to generate the pdf file with Drill Downpublic void setExportPages(int[] pages)
pages
- the exporting page numberpublic void setExportPageRange(int[][] pageRange)
pageRange
- the exporting page rangepublic boolean noMargin()
public boolean isSimPrintMode()
public int getImageCompressRatio()
public boolean hasToc()
public boolean hasDrill()
public int[] getExportPages()
public int[][] getExportPageRange()
public void setMaxSizeOfOneFile(int maxSizeOfOneFile)
maxSizeOfOnePage
- public int getMaxSizeOfOneFile()
public void setMaxPageOfOneFile(int maxPageOfOneFile)
maxSizeOfOnePage
- public int getMaxPageOfOneFile()
public void setPassword(java.lang.String password)
public void setEncryption(boolean strength128Bits, java.lang.String userPassword, java.lang.String ownerPassword, int permissions)
strength128Bits
- true
for 128 bit key length, false
for 40 bit key lengthuserPassword
- the user password. It can be null or empty.ownerPassword
- the owner password. It can be null or empty.permissions
- the user permissionspublic void setDigitalSignature(int signatureMethod, java.io.InputStream digitalIDFileStream, java.lang.String digitalIDFilePassword)
signatureMethod
- the digital signature methoddigitalIDFileStream
- the stream of the digital id filedigitalIDFilePassword
- the Digital ID file passwordpublic void setDigitalSignature(int signatureMethod, byte[] digitalIDValues, java.lang.String digitalIDFilePassword)
signatureMethod
- the digital signature methoddigitalIDValues
- the contents of the digital id filedigitalIDFilePassword
- the Digital ID file passwordpublic void setDigitalSignature(int signatureMethod, java.lang.String digitalIDFilePath, java.lang.String digitalIDFilePassword)
signatureMethod
- the digital signature methoddigitalIDFilePath
- the Digital ID file pathdigitalIDFilePassword
- the Digital ID file passwordpublic boolean hasSignature()
public boolean hasEncryption()
public void setSigningReason(java.lang.String reason)
reason
- the signing reasonpublic void setSigningLocation(java.lang.String location)
location
- the signing locationpublic void setSigningContact(java.lang.String contact)
contact
- the signing contactpublic boolean isStrength128Bits()
public java.lang.String getUserPassword()
public java.lang.String getOwnerPassword()
public int getPermissions()
public int getSignatureMethod()
public java.io.InputStream getDigitalIDFileStream()
public java.lang.String getDigitalIDFilePassword()
public java.lang.String getSigningReason()
public java.lang.String getSigningLocation()
public java.lang.String getSigningContact()
public boolean isTransparent()
public void setTransparent(boolean transparent)
transparent
- public void setClippingArea(boolean clip)
clip
- If true, clipping area will be kept in PDF; if false, clipping area will be removed from PDF.public boolean getClippingArea()
public void setAccessibility(boolean b)
b
- True means being compliant. False otherwise. The default value is false.public boolean getAccessibility()
public boolean setZooming(java.lang.String zooming)
zooming
- The zooming value can be one of the predefined ZOOM_STR_DEFAULT
,
ZOOM_STR_ACTUAL_SIZE
, ZOOM_STR_FIT_PAGE
, ZOOM_STR_FIT_WIDTH
,
ZOOM_STR_FIT_HEIGHT
, ZOOM_STR_FIT_VISIBLE
, ZOOM_STR_25_PERCENT
,
ZOOM_STR_50_PERCENT
, ZOOM_STR_75_PERCENT
, ZOOM_STR_100_PERCENT
,
ZOOM_STR_125_PERCENT
, ZOOM_STR_150_PERCENT
, ZOOM_STR_200_PERCENT
,
ZOOM_STR_400_PERCENT
, ZOOM_STR_800_PERCENT
, ZOOM_STR_1600_PERCENT
,
ZOOM_STR_2400_PERCENT
, ZOOM_STR_3200_PERCENT
, and ZOOM_STR_6400_PERCENT
.
It also can be a customized percent value which is greater than 0% and smaller than
or equal to 6400%. For example, 26.5%.
If the zooming value is invalid, the effect is the same as that of not invoking
this method.public PDFZooming getZooming()
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
public java.lang.String getSubject()
public void setSubject(java.lang.String subject)
public PDFParameter copy()
public void setNoFileExt(boolean noFileExt)
public boolean isNoFileExt()