EasyPDF Java SDK
v5.1

com.bcl.easypdf.EasyPDFPrinter
Class IPDFSetting

java.lang.Object
  extended by com.bcl.easypdf.EasyPDFPrinter.IPDFSetting
Direct Known Subclasses:
IPrinterSetting

public class IPDFSetting
extends java.lang.Object

To review and modify PDF conversion setting for a given print job, create an object of this class.


Method Summary
 int getFolderDefaultOutputPath()
           
 boolean getFolderRememberOutputPath()
           
 java.lang.String getFolderSpecifiedOutputPath()
           
 boolean getFontEmbedAsType0()
           
 int getFontEmbedding()
          Gets true type font embedding setting.
 int getFontSubstitution()
          Gets font substitution setting.
 int getImageCompression()
           
 int getImageDownsizeResolution()
           
 boolean getImageDownsizing()
           
 int getImageJPEGQuality()
           
 int getImageQuality()
           
 boolean getMetaData()
          Meta data can be viewed by selecting "Document Properties" from the File menu of Adobe Reader.
 java.lang.String getMetaDataAuthor()
           
 java.lang.String getMetaDataCreator()
           
 java.lang.String getMetaDataKeywords()
           
 java.lang.String getMetaDataSubject()
           
 java.lang.String getMetaDataTitle()
           
 boolean getSecurity()
           
 int getSecurityAnnotation()
           
 int getSecurityEncryption()
           
 int getSecurityExtraction()
           
 int getSecurityModification()
           
 java.lang.String getSecurityOwnerPassword()
           
 int getSecurityPrinting()
           
 java.lang.String getSecurityUserPassword()
          Returns the user password used to protect the PDF file against unauthorized viewing.
 boolean getSignature()
           
 java.lang.String getSignatureDigitalIDFileName()
           
 boolean getSignatureImage()
           
 java.lang.String getSignatureImageFileName()
           
 double getSignatureImagePosLeft()
           
 double getSignatureImagePosTop()
           
 int getSignatureImageZoom()
           
 java.lang.String getSignatureInfoContact()
           
 java.lang.String getSignatureInfoLocation()
           
 java.lang.String getSignatureInfoPurpose()
           
 boolean getStamp(int Index)
           
 int getStampCount()
           
 java.lang.String getStampFileName(int Index)
           
 boolean getStampFirstPageOnly(int Index)
           
 double getStampHOffset(int Index)
           
 int getStampHPosition(int Index)
           
 int getStampTransparentColor(int Index)
           
 double getStampVOffset(int Index)
           
 int getStampVPosition(int Index)
           
 int getStampZoom(int Index)
           
 int getStampZOrder(int Index)
           
 boolean getUiAlerts()
           
 boolean getUiFileDialog()
           
 boolean getUiPropertiesDialog()
           
 boolean getViewerHideMenuBar()
           
 boolean getViewerHideToolBar()
           
 boolean getViewerHideWinControls()
           
 int getViewerMagnification()
          Gets PDF viewer page magnification setting.
 int getViewerPageLayout()
          Gets PDF viewer page layout setting.
 int getViewerPanel()
          Gets PDF viewer panel setting.
 int getViewerPrintScaling()
          Gets PDF viewer print scaling setting.
 boolean getWatermark(int Index)
           
 int getWatermarkAngle(int Index)
           
 int getWatermarkColor(int Index)
           
 int getWatermarkCount()
           
 boolean getWatermarkFirstPageOnly(int Index)
           
 java.lang.String getWatermarkFontName(int Index)
           
 int getWatermarkFontSize(int Index)
           
 double getWatermarkHOffset(int Index)
           
 int getWatermarkHPosition(int Index)
           
 int getWatermarkOpacity(int Index)
           
 boolean getWatermarkOutlineOnly(int Index)
           
 java.lang.String getWatermarkText(int Index)
           
 int getWatermarkTextAlignment(int Index)
           
 double getWatermarkVOffset(int Index)
           
 int getWatermarkVPosition(int Index)
           
 int getWatermarkZOrder(int Index)
           
 void Reset()
           
 void Save()
           
 void setFolderDefaultOutputPath(int EprnFolderDefault)
           
 void setFolderRememberOutputPath(boolean newVal)
           
 void setFolderSpecifiedOutputPath(java.lang.String newVal)
          Before calling this method, you must call setFolderDefaultOutputPath with prnFolderDefault.PRN_FOLDER_DEFAULT_SPECIFY.
 void setFontEmbedAsType0(boolean newVal)
           
 void setFontEmbedding(int EprnFontEmbedding)
          Sets true type font embedding.
 void setFontSubstitution(int EprnFontSubstitution)
          Sets the font substitution setting.
 void setImageCompression(int EprnImageCompression)
           
 void setImageDownsizeResolution(int newVal)
           
 void setImageDownsizing(boolean newVal)
          If image downsizing is set to true, then the resolution of images is reduced to the DPI value returned from the method call getImageDownsizeResolution().
 void setImageJPEGQuality(int newVal)
          Before calling this method, you must make sure that image compression is set to JPEG or JPEG 2000.
 void setImageQuality(int newVal)
           
 void setMetaData(boolean newVal)
           
 void setMetaDataAuthor(java.lang.String newVal)
           
 void setMetaDataCreator(java.lang.String newVal)
           
 void setMetaDataKeywords(java.lang.String newVal)
           
 void setMetaDataSubject(java.lang.String newVal)
           
 void setMetaDataTitle(java.lang.String newVal)
           
 void setSecurity(boolean newVal)
          Call this method with true if you want to apply security to the PDF; otherwise, call it with false.
 void setSecurityAnnotation(int EprnSecAnnotationPerm)
           
 void setSecurityEncryption(int EprnSecEncryption)
           
 void setSecurityExtraction(int EprnSecExtractionPerm)
           
 void setSecurityModification(int EprnSecModificationPerm)
           
 void setSecurityOwnerPassword(java.lang.String newVal)
          Sets the owner password, which is used to prevent the PDF security setting from being modified.
 void setSecurityPrinting(int EprnSecPrintingPerm)
           
 void setSecurityUserPassword(java.lang.String newVal)
          Sets the user password for the PDF.
 void setSignature(boolean newVal)
           
 void setSignatureDigitalIDFileName(java.lang.String newVal)
          Sets digtial ID file name.
 void setSignatureImage(boolean newVal)
          You can use an image to represent a signature.
 void setSignatureImageFileName(java.lang.String newVal)
           
 void setSignatureImagePosLeft(double newVal)
           
 void setSignatureImagePosTop(double newVal)
           
 void setSignatureImageZoom(int newVal)
           
 void setSignatureInfoContact(java.lang.String newVal)
           
 void setSignatureInfoLocation(java.lang.String newVal)
           
 void setSignatureInfoPurpose(java.lang.String newVal)
           
 void setStamp(int Index, boolean newVal)
           
 void setStampFileName(int Index, java.lang.String newVal)
           
 void setStampFirstPageOnly(int Index, boolean newVal)
           
 void setStampHOffset(int Index, double newVal)
           
 void setStampHPosition(int Index, int EprnStampHPosition)
           
 void setStampTransparentColor(int Index, int newVal)
           
 void setStampVOffset(int Index, double newVal)
           
 void setStampVPosition(int Index, int EprnStampVPosition)
           
 void setStampZoom(int Index, int newVal)
           
 void setStampZOrder(int Index, int EprnStampZOrder)
           
 void setUiAlerts(boolean newVal)
           
 void setUiFileDialog(boolean newVal)
           
 void setUiPropertiesDialog(boolean newVal)
           
 void setViewerHideMenuBar(boolean newVal)
           
 void setViewerHideToolBar(boolean newVal)
           
 void setViewerHideWinControls(boolean newVal)
           
 void setViewerMagnification(int EprnViewerMagnification)
          Sets PDF viewer page magnification setting.
 void setViewerPageLayout(int EprnViewerPageLayout)
          Sets PDF viewer page layout setting.
 void setViewerPanel(int EprnViewerPanel)
          Sets PDF viewer panel setting.
 void setViewerPrintScaling(int EprnViewerPrintScaling)
          Sets PDF viewer print scaling setting.
 void setWatermark(int Index, boolean newVal)
           
 void setWatermarkAngle(int Index, int newVal)
           
 void setWatermarkColor(int Index, int newVal)
           
 void setWatermarkFirstPageOnly(int Index, boolean newVal)
           
 void setWatermarkFontName(int Index, java.lang.String newVal)
           
 void setWatermarkFontSize(int Index, int newVal)
           
 void setWatermarkHOffset(int Index, double newVal)
           
 void setWatermarkHPosition(int Index, int EprnWmarkHPosition)
           
 void setWatermarkOpacity(int Index, int newVal)
           
 void setWatermarkOutlineOnly(int Index, boolean newVal)
           
 void setWatermarkText(int Index, java.lang.String newVal)
           
 void setWatermarkTextAlignment(int Index, int EprnWmarkAlignment)
           
 void setWatermarkVOffset(int Index, double newVal)
           
 void setWatermarkVPosition(int Index, int EprnWmarkVPosition)
           
 void setWatermarkZOrder(int Index, int EprnWmarkZOrder)
           
 void ShowPropertiesDialog(java.lang.Object HwndParent)
           
 void SignatureCreateDigitalID(java.lang.String IDFileName, java.lang.String IDPassword, java.lang.String Name, java.lang.String Country, java.lang.String OrganizationName, java.lang.String OrganizationUnit, java.lang.String Email, int EprnSigKeyLength)
           
 void SignatureExportCertificate(java.lang.String CertificateFileName, java.lang.String IDFileName, java.lang.String IDPassword)
          Exports certificate from a digital ID
 void Update()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

Reset

public void Reset()
           throws EasyPDFException
Throws:
EasyPDFException

Update

public void Update()
            throws EasyPDFException
Throws:
EasyPDFException

Save

public void Save()
          throws EasyPDFException
Throws:
EasyPDFException

ShowPropertiesDialog

public void ShowPropertiesDialog(java.lang.Object HwndParent)
                          throws EasyPDFException
Throws:
EasyPDFException

getFontEmbedding

public int getFontEmbedding()
                     throws EasyPDFException
Gets true type font embedding setting.

Returns:
an integral value defined in interfce prnFontEmbedding
Throws:
EasyPDFException
See Also:
prnFontEmbedding

setFontEmbedding

public void setFontEmbedding(int EprnFontEmbedding)
                      throws EasyPDFException
Sets true type font embedding. The PRN_FONT_EMBED_FULLSET (embedding fullset of font) will cause significant increase in PDF file size, especially for CJK font, and is therefore not recommended. If you need to embed font, PRN_FONT_EMBED_SUBSET (embed subset of font) will be a better choice.

Parameters:
EprnFontEmbedding - font embedding setting defined in prnFontEmbedding
Throws:
EasyPDFException
See Also:
prnFontEmbedding

getFontSubstitution

public int getFontSubstitution()
                        throws EasyPDFException
Gets font substitution setting.

Returns:
a font substitutiong defined in prnFontSubstitution
Throws:
EasyPDFException
See Also:
prnFontSubstitution

setFontSubstitution

public void setFontSubstitution(int EprnFontSubstitution)
                         throws EasyPDFException
Sets the font substitution setting.

Parameters:
EprnFontSubstitution - font substitution setting defined in prnFontSubstitution
Throws:
EasyPDFException
See Also:
prnFontSubstitution

getImageDownsizing

public boolean getImageDownsizing()
                           throws EasyPDFException
Returns:
a boolean value indicating whether image downsizing is enabled
Throws:
EasyPDFException

setImageDownsizing

public void setImageDownsizing(boolean newVal)
                        throws EasyPDFException
If image downsizing is set to true, then the resolution of images is reduced to the DPI value returned from the method call getImageDownsizeResolution().

Parameters:
newVal - true if image downsizing is enabled; false otherwise
Throws:
EasyPDFException

getImageDownsizeResolution

public int getImageDownsizeResolution()
                               throws EasyPDFException
Returns:
image downsize resolution, which lies between 10 and 600.
Throws:
EasyPDFException

setImageDownsizeResolution

public void setImageDownsizeResolution(int newVal)
                                throws EasyPDFException
Parameters:
newVal - new resolution within 10 to 600
Throws:
EasyPDFException

getImageCompression

public int getImageCompression()
                        throws EasyPDFException
Returns:
image compression setting defined in prnImageCompression
Throws:
EasyPDFException
See Also:
prnImageCompression

setImageCompression

public void setImageCompression(int EprnImageCompression)
                         throws EasyPDFException
Parameters:
EprnImageCompression - a compression defined in prnImageCompression
Throws:
EasyPDFException
See Also:
prnImageCompression

getImageJPEGQuality

public int getImageJPEGQuality()
                        throws EasyPDFException
Returns:
JPEG image quality value lying between 5 and 100, 100 being the highest quality
Throws:
EasyPDFException

setImageJPEGQuality

public void setImageJPEGQuality(int newVal)
                         throws EasyPDFException
Before calling this method, you must make sure that image compression is set to JPEG or JPEG 2000.

Parameters:
newVal - new image quality within the range 5 to 100
Throws:
EasyPDFException

getSecurity

public boolean getSecurity()
                    throws EasyPDFException
Returns:
true if security is applied to the PDF; false otherwise
Throws:
EasyPDFException

setSecurity

public void setSecurity(boolean newVal)
                 throws EasyPDFException
Call this method with true if you want to apply security to the PDF; otherwise, call it with false.

Throws:
EasyPDFException

getSecurityEncryption

public int getSecurityEncryption()
                          throws EasyPDFException
Returns:
one of the values defined in prnSecEncryption
Throws:
EasyPDFException
See Also:
prnSecEncryption

setSecurityEncryption

public void setSecurityEncryption(int EprnSecEncryption)
                           throws EasyPDFException
Parameters:
EprnSecEncryption - a value defined in prnSecEncryption
Throws:
EasyPDFException
See Also:
prnSecEncryption

getSecurityUserPassword

public java.lang.String getSecurityUserPassword()
                                         throws EasyPDFException
Returns the user password used to protect the PDF file against unauthorized viewing.

Throws:
EasyPDFException

setSecurityUserPassword

public void setSecurityUserPassword(java.lang.String newVal)
                             throws EasyPDFException
Sets the user password for the PDF. Once you call this method to set it, you must supply the user password to open the PDF file.

Throws:
EasyPDFException

getSecurityOwnerPassword

public java.lang.String getSecurityOwnerPassword()
                                          throws EasyPDFException
Throws:
EasyPDFException

setSecurityOwnerPassword

public void setSecurityOwnerPassword(java.lang.String newVal)
                              throws EasyPDFException
Sets the owner password, which is used to prevent the PDF security setting from being modified.

Throws:
EasyPDFException

getSecurityAnnotation

public int getSecurityAnnotation()
                          throws EasyPDFException
Returns:
one of the values defined in prnSecAnnotationPerm
Throws:
EasyPDFException
See Also:
prnSecAnnotationPerm

setSecurityAnnotation

public void setSecurityAnnotation(int EprnSecAnnotationPerm)
                           throws EasyPDFException
Parameters:
EprnSecAnnotationPerm - a value defined in prnSecAnnotationPerm
Throws:
EasyPDFException
See Also:
prnSecAnnotationPerm

getSecurityExtraction

public int getSecurityExtraction()
                          throws EasyPDFException
Returns:
one of the values defined in prnSecExtractionPerm
Throws:
EasyPDFException
See Also:
prnSecExtractionPerm

setSecurityExtraction

public void setSecurityExtraction(int EprnSecExtractionPerm)
                           throws EasyPDFException
Parameters:
EprnSecExtractionPerm - a value defined in prnSecExtractionPerm
Throws:
EasyPDFException
See Also:
prnSecExtractionPerm

getSecurityModification

public int getSecurityModification()
                            throws EasyPDFException
Returns:
one of the values defined in prnSecModificationPerm
Throws:
EasyPDFException
See Also:
prnSecModificationPerm

setSecurityModification

public void setSecurityModification(int EprnSecModificationPerm)
                             throws EasyPDFException
Parameters:
EprnSecModificationPerm - a value defined in prnSecModification
Throws:
EasyPDFException
See Also:
prnSecModificationPerm

getSecurityPrinting

public int getSecurityPrinting()
                        throws EasyPDFException
Returns:
one of the values defined in prnSecPrintingPerm
Throws:
EasyPDFException
See Also:
prnSecPrintingPerm

setSecurityPrinting

public void setSecurityPrinting(int EprnSecPrintingPerm)
                         throws EasyPDFException
Parameters:
EprnSecPrintingPerm - a value defiend in prnSecPrintingPerm
Throws:
EasyPDFException
See Also:
prnSecPrintingPerm

getWatermarkCount

public int getWatermarkCount()
                      throws EasyPDFException
Throws:
EasyPDFException

getWatermark

public boolean getWatermark(int Index)
                     throws EasyPDFException
Parameters:
Index - watermark index starts at 0
Returns:
true if the i-th watermark is enabled; false otherwise
Throws:
EasyPDFException

setWatermark

public void setWatermark(int Index,
                         boolean newVal)
                  throws EasyPDFException
Throws:
EasyPDFException

getWatermarkText

public java.lang.String getWatermarkText(int Index)
                                  throws EasyPDFException
Returns:
the text of the watermark indexed at "Index"
Throws:
EasyPDFException

setWatermarkText

public void setWatermarkText(int Index,
                             java.lang.String newVal)
                      throws EasyPDFException
Throws:
EasyPDFException

getWatermarkFontName

public java.lang.String getWatermarkFontName(int Index)
                                      throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
wartermark font name
Throws:
EasyPDFException

setWatermarkFontName

public void setWatermarkFontName(int Index,
                                 java.lang.String newVal)
                          throws EasyPDFException
Throws:
EasyPDFException

getWatermarkFontSize

public int getWatermarkFontSize(int Index)
                         throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
watermark font size
Throws:
EasyPDFException

setWatermarkFontSize

public void setWatermarkFontSize(int Index,
                                 int newVal)
                          throws EasyPDFException
Throws:
EasyPDFException

getWatermarkColor

public int getWatermarkColor(int Index)
                      throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
watermark color
Throws:
EasyPDFException

setWatermarkColor

public void setWatermarkColor(int Index,
                              int newVal)
                       throws EasyPDFException
Throws:
EasyPDFException

getWatermarkAngle

public int getWatermarkAngle(int Index)
                      throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
watermark angle
Throws:
EasyPDFException

setWatermarkAngle

public void setWatermarkAngle(int Index,
                              int newVal)
                       throws EasyPDFException
Throws:
EasyPDFException

getWatermarkFirstPageOnly

public boolean getWatermarkFirstPageOnly(int Index)
                                  throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
a boolean value indicating whether to apply wartermark on the first page only
Throws:
EasyPDFException

setWatermarkFirstPageOnly

public void setWatermarkFirstPageOnly(int Index,
                                      boolean newVal)
                               throws EasyPDFException
Throws:
EasyPDFException

getWatermarkZOrder

public int getWatermarkZOrder(int Index)
                       throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
one of the value defined in prnWmarkZOrder
Throws:
EasyPDFException
See Also:
prnWmarkZOrder

setWatermarkZOrder

public void setWatermarkZOrder(int Index,
                               int EprnWmarkZOrder)
                        throws EasyPDFException
Throws:
EasyPDFException

getWatermarkOutlineOnly

public boolean getWatermarkOutlineOnly(int Index)
                                throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
a boolean value indicating wether to outline the text only
Throws:
EasyPDFException

setWatermarkOutlineOnly

public void setWatermarkOutlineOnly(int Index,
                                    boolean newVal)
                             throws EasyPDFException
Throws:
EasyPDFException

getWatermarkHPosition

public int getWatermarkHPosition(int Index)
                          throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
one of the values defined in prnWmarkHPosition
Throws:
EasyPDFException
See Also:
prnWmarkHPosition

setWatermarkHPosition

public void setWatermarkHPosition(int Index,
                                  int EprnWmarkHPosition)
                           throws EasyPDFException
Throws:
EasyPDFException

getWatermarkVPosition

public int getWatermarkVPosition(int Index)
                          throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
vertical position of the watermark
Throws:
EasyPDFException
See Also:
prnWmarkVPosition

setWatermarkVPosition

public void setWatermarkVPosition(int Index,
                                  int EprnWmarkVPosition)
                           throws EasyPDFException
Throws:
EasyPDFException

getWatermarkTextAlignment

public int getWatermarkTextAlignment(int Index)
                              throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
text alignment
Throws:
EasyPDFException
See Also:
prnWmarkAlignment

setWatermarkTextAlignment

public void setWatermarkTextAlignment(int Index,
                                      int EprnWmarkAlignment)
                               throws EasyPDFException
Throws:
EasyPDFException

getWatermarkHOffset

public double getWatermarkHOffset(int Index)
                           throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
horizontal offset
Throws:
EasyPDFException

setWatermarkHOffset

public void setWatermarkHOffset(int Index,
                                double newVal)
                         throws EasyPDFException
Throws:
EasyPDFException

getWatermarkVOffset

public double getWatermarkVOffset(int Index)
                           throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
vertical offset
Throws:
EasyPDFException

setWatermarkVOffset

public void setWatermarkVOffset(int Index,
                                double newVal)
                         throws EasyPDFException
Throws:
EasyPDFException

getWatermarkOpacity

public int getWatermarkOpacity(int Index)
                        throws EasyPDFException
Parameters:
Index - index of the watermark
Returns:
watermark text opacity (in percent)
Throws:
EasyPDFException

setWatermarkOpacity

public void setWatermarkOpacity(int Index,
                                int newVal)
                         throws EasyPDFException
Throws:
EasyPDFException

getStampCount

public int getStampCount()
                  throws EasyPDFException
Throws:
EasyPDFException

getStamp

public boolean getStamp(int Index)
                 throws EasyPDFException
Parameters:
Index - index of the stamp
Returns:
a boolean value indicating whether image stamp is enabled
Throws:
EasyPDFException

setStamp

public void setStamp(int Index,
                     boolean newVal)
              throws EasyPDFException
Throws:
EasyPDFException

getStampFileName

public java.lang.String getStampFileName(int Index)
                                  throws EasyPDFException
Parameters:
Index - index of the stamp
Returns:
stamp image file name
Throws:
EasyPDFException

setStampFileName

public void setStampFileName(int Index,
                             java.lang.String newVal)
                      throws EasyPDFException
Throws:
EasyPDFException

getStampHPosition

public int getStampHPosition(int Index)
                      throws EasyPDFException
Parameters:
Index - index of the stamp
Returns:
stamp horizontal position
Throws:
EasyPDFException
See Also:
prnStampHPosition

setStampHPosition

public void setStampHPosition(int Index,
                              int EprnStampHPosition)
                       throws EasyPDFException
Throws:
EasyPDFException

getStampVPosition

public int getStampVPosition(int Index)
                      throws EasyPDFException
Parameters:
Index - index of the stamp
Returns:
stamp vertical position
Throws:
EasyPDFException
See Also:
prnStampVPosition

setStampVPosition

public void setStampVPosition(int Index,
                              int EprnStampVPosition)
                       throws EasyPDFException
Throws:
EasyPDFException

getStampZOrder

public int getStampZOrder(int Index)
                   throws EasyPDFException
Parameters:
Index - of the stamp
Returns:
stamp z-order
Throws:
EasyPDFException
See Also:
prnStampZOrder

setStampZOrder

public void setStampZOrder(int Index,
                           int EprnStampZOrder)
                    throws EasyPDFException
Throws:
EasyPDFException

getStampFirstPageOnly

public boolean getStampFirstPageOnly(int Index)
                              throws EasyPDFException
Parameters:
Index - of the stamp
Returns:
a boolean value indicating whether to apply stamp on only the first page
Throws:
EasyPDFException

setStampFirstPageOnly

public void setStampFirstPageOnly(int Index,
                                  boolean newVal)
                           throws EasyPDFException
Throws:
EasyPDFException

getStampHOffset

public double getStampHOffset(int Index)
                       throws EasyPDFException
Parameters:
Index - of the stamp
Returns:
stamp horizontal offset
Throws:
EasyPDFException

setStampHOffset

public void setStampHOffset(int Index,
                            double newVal)
                     throws EasyPDFException
Throws:
EasyPDFException

getStampVOffset

public double getStampVOffset(int Index)
                       throws EasyPDFException
Parameters:
Index - of the stamp
Returns:
stamp vertical offset
Throws:
EasyPDFException

setStampVOffset

public void setStampVOffset(int Index,
                            double newVal)
                     throws EasyPDFException
Throws:
EasyPDFException

getStampTransparentColor

public int getStampTransparentColor(int Index)
                             throws EasyPDFException
Parameters:
Index - of the stamp
Returns:
stamp transparent color
Throws:
EasyPDFException

setStampTransparentColor

public void setStampTransparentColor(int Index,
                                     int newVal)
                              throws EasyPDFException
Throws:
EasyPDFException

getStampZoom

public int getStampZoom(int Index)
                 throws EasyPDFException
Parameters:
Index - of the stamp
Returns:
stamp zoom (in percent)
Throws:
EasyPDFException

setStampZoom

public void setStampZoom(int Index,
                         int newVal)
                  throws EasyPDFException
Throws:
EasyPDFException

getMetaData

public boolean getMetaData()
                    throws EasyPDFException
Meta data can be viewed by selecting "Document Properties" from the File menu of Adobe Reader.

Returns:
a boolean value indicating whether meta data is enabled
Throws:
EasyPDFException

setMetaData

public void setMetaData(boolean newVal)
                 throws EasyPDFException
Parameters:
newVal - true (enable meta data); false (disable meta data)
Throws:
EasyPDFException

getMetaDataCreator

public java.lang.String getMetaDataCreator()
                                    throws EasyPDFException
Returns:
meta data creator, e.g., a company name
Throws:
EasyPDFException

setMetaDataCreator

public void setMetaDataCreator(java.lang.String newVal)
                        throws EasyPDFException
Parameters:
newVal - the new creator
Throws:
EasyPDFException

getMetaDataTitle

public java.lang.String getMetaDataTitle()
                                  throws EasyPDFException
Returns:
title of the PDF document
Throws:
EasyPDFException

setMetaDataTitle

public void setMetaDataTitle(java.lang.String newVal)
                      throws EasyPDFException
Parameters:
newVal - the title of the PDF document
Throws:
EasyPDFException

getMetaDataAuthor

public java.lang.String getMetaDataAuthor()
                                   throws EasyPDFException
Returns:
the author of the PDF document
Throws:
EasyPDFException

setMetaDataAuthor

public void setMetaDataAuthor(java.lang.String newVal)
                       throws EasyPDFException
Parameters:
newVal - the author of the PDF document
Throws:
EasyPDFException

getMetaDataSubject

public java.lang.String getMetaDataSubject()
                                    throws EasyPDFException
Returns:
the subject of the PDF document
Throws:
EasyPDFException

setMetaDataSubject

public void setMetaDataSubject(java.lang.String newVal)
                        throws EasyPDFException
Parameters:
newVal - the subject of the PDF document
Throws:
EasyPDFException

getMetaDataKeywords

public java.lang.String getMetaDataKeywords()
                                     throws EasyPDFException
Returns:
keywords listed in the PDF document properties
Throws:
EasyPDFException

setMetaDataKeywords

public void setMetaDataKeywords(java.lang.String newVal)
                         throws EasyPDFException
Parameters:
newVal - the keywords for the PDF document
Throws:
EasyPDFException

getFolderDefaultOutputPath

public int getFolderDefaultOutputPath()
                               throws EasyPDFException
Returns:
the default output folder where the created PDF is stored
Throws:
EasyPDFException
See Also:
prnFolderDefault

setFolderDefaultOutputPath

public void setFolderDefaultOutputPath(int EprnFolderDefault)
                                throws EasyPDFException
Parameters:
EprnFolderDefault - default folder for created PDFs
Throws:
EasyPDFException
See Also:
prnFolderDefault

getFolderSpecifiedOutputPath

public java.lang.String getFolderSpecifiedOutputPath()
                                              throws EasyPDFException
Returns:
user specified output folder
Throws:
EasyPDFException

setFolderSpecifiedOutputPath

public void setFolderSpecifiedOutputPath(java.lang.String newVal)
                                  throws EasyPDFException
Before calling this method, you must call setFolderDefaultOutputPath with prnFolderDefault.PRN_FOLDER_DEFAULT_SPECIFY.

Parameters:
newVal - user specified output folder
Throws:
EasyPDFException

getFolderRememberOutputPath

public boolean getFolderRememberOutputPath()
                                    throws EasyPDFException
Returns:
true if PDF is saved to the previous output folder; false otherwise
Throws:
EasyPDFException

setFolderRememberOutputPath

public void setFolderRememberOutputPath(boolean newVal)
                                 throws EasyPDFException
Parameters:
newVal - true if PDFs are saved in previous output folder; false otherwise
Throws:
EasyPDFException

<