com.gnostice.documents.pdf

Class PDF

java.lang.Object

com.gnostice.documents.pdf.PDF

All Implemented Interfaces:

IDocument, Usable, Serializable

public class PDF
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION_1_4 PDF version 1.4
static String	VERSION_1_5 PDF version 1.5
static String	VERSION_1_6 PDF version 1.6
static String	VERSION_1_7 PDF version 1.7

Fields inherited from interface com.gnostice.documents.pdf.Usable

INCHES_TO_POINTS, MM_TO_INCHES, MM_TO_POINTS, PDF_A, PDF_AA, PDF_AC, PDF_ACROFORM, PDF_ACTION, PDF_ALTERNATEPRESENTATIONS, PDF_ANNOT, PDF_ANNOT_DEFAULT_TITLE, PDF_ANNOT_NAME, PDF_ANNOT_SUBJECT, PDF_ANNOTS, PDF_AP, PDF_ARRAYEND, PDF_ARRAYSTART, PDF_ARTBOX, PDF_AS, PDF_ASCENT, PDF_ASCII85, PDF_ASCII85_NEW, PDF_ASCIIHEX, PDF_ASCIIHEX_NEW, PDF_AuthEvent, PDF_AUTHOR, PDF_AVGWIDTH, PDF_B, PDF_BASEFONT, PDF_BBOX, PDF_BC, PDF_BE, PDF_BEFOREFORMAT, PDF_BEGINTEXT, PDF_BG, PDF_BINARYDATA, PDF_BITS_PER_COMPONENT, PDF_BL, PDF_BLEEDBOX, PDF_BLINDS, PDF_BMC, PDF_BORDER, PDF_BOX, PDF_BS, PDF_BTN, PDF_BYTERANGE, PDF_C, PDF_CA, PDF_CA_SMALL, PDF_CAPHEIGHT, PDF_CARETANNOT, PDF_CARRIAGE, PDF_CATALOG, PDF_CENTER_WINDOW, PDF_CF, PDF_CFM, PDF_CH, PDF_CID_TO_GID_MAP, PDF_CIDFONT_TYPE0, PDF_CIDFONT_TYPE1, PDF_CIDFONT_TYPE2, PDF_CIDSYSTEM_INFO, PDF_CIRCLEANNOT, PDF_CL, PDF_CM, PDF_COLLLECTION, PDF_COLOMNS, PDF_COLOR, PDF_COLORSPACE, PDF_COLORSPACE_CALGRAY, PDF_COLORSPACE_CALRGB, PDF_COLORSPACE_DEVICEN, PDF_COLORSPACE_ICCBASED, PDF_COLORSPACE_LAB, PDF_COLORSPACE_SEPARATION, PDF_CONTACTINFO, PDF_CONTENTS, PDF_COUNT, PDF_COVER, PDF_CREATIONDATE, PDF_CREATOR, PDF_CROPBOX, PDF_CS, PDF_CSP, PDF_D, PDF_DA, PDF_DATE, PDF_DATE_FORMAT, PDF_DCTDECODE, PDF_DCTDECODE_NEW, PDF_DECODEPARMS, PDF_DESC, PDF_DESCENDANT, PDF_DESCENDANT_FONTS, PDF_DESCENDENTFONTS, PDF_DESCENT, PDF_DESTINATION, PDF_DESTS, PDF_DEVICE_CMYK, PDF_DEVICE_GRAY, PDF_DEVICE_RGB, PDF_DI, PDF_DICTEND, PDF_DICTSTART, PDF_DIFFERENCES, PDF_DIRECTION, PDF_DISPLAY_DOCTITLE, PDF_DISPLAY_DURATION, PDF_DISSOLVE, PDF_DM, PDF_DOC_SUBJECT, PDF_DOCMDP, PDF_DOS, PDF_DP, PDF_DR, PDF_DS, PDF_DV, PDF_DW, PDF_E, PDF_EF, PDF_EMBEDDEDFILE, PDF_EMBEDDEDFILES, PDF_EMC, PDF_ENCODING, PDF_ENCRYPT, PDF_ENCRYPTMETADATA, PDF_ENDOBJ, PDF_ENDPATH, PDF_ENDSTREAM, PDF_ENDTEXT, PDF_EOCLIP, PDF_EOF, PDF_EXTGSTATE, PDF_F, PDF_FADE, PDF_FALSE, PDF_FDESCRIPTOR, PDF_FIELD_FLAG, PDF_FIELDS, PDF_FILEATTACHMENTANNOT, PDF_FILESPEC, PDF_FILTER, PDF_FIRST, PDF_FIRST_PAGE, PDF_FIRSTCHAR, PDF_FIT, PDF_FIT_WINDOW, PDF_FITB, PDF_FITBH, PDF_FITBV, PDF_FITH, PDF_FITR, PDF_FITV, PDF_FIXEDPRINT, PDF_FLAGS, PDF_FLATE, PDF_FLATE_NEW, PDF_FLY, PDF_FO, PDF_FONT, PDF_FONTBBOX, PDF_FONTDESCRIPTOR, PDF_FONTFILE, PDF_FONTFILE_2, PDF_FontFile_3, PDF_FONTFILE2, PDF_FONTNAME, PDF_FONTNAMEPREFIX, PDF_FORM, PDF_FORMFEED, PDF_FORMFONTPREFIX, PDF_FREE_TEXT_CALLOUT, PDF_FREE_TEXT_TYPEWRITER, PDF_FREETEXTANNOT, PDF_FS, PDF_FT, PDF_FULLSCREEN, PDF_GLITTER, PDF_GOTO_ACTION, PDF_GROUP, PDF_GS, PDF_H, PDF_HEADER, PDF_HEIGHT, PDF_HEXSTRINGEND, PDF_HEXSTRINGSTART, PDF_HIDE_MENUBAR, PDF_HIDE_TOOLBAR, PDF_HIDE_WINDOWUI, PDF_HIGHLIGHT, PDF_HORIZ_STEM, PDF_HORIZONTAL, PDF_I, PDF_IC, PDF_ID, PDF_IDS, PDF_IF, PDF_IMAGE, PDF_IMAGEB, PDF_IMAGEC, PDF_IMAGEI, PDF_IMPORTDATA, PDF_INDEX, PDF_INDEXED, PDF_INFO, PDF_INK, PDF_INKLIST, PDF_INWARD, PDF_IT, PDF_ITALANGLE, PDF_IX, PDF_JAVASCRIPT, PDF_JAVASCRIPT_ACTION, PDF_JS, PDF_KEYSTROKE, PDF_KEYWORDS, PDF_KIDS, PDF_L, PDF_L2R, PDF_LANG, PDF_LAST, PDF_LAST_PAGE, PDF_LASTCHAR, PDF_LAUNCH_ACTION, PDF_LE, PDF_LEGAL, PDF_LENGTH, PDF_LENGTH_1, PDF_LENGTH_2, PDF_LENGTH_3, PDF_LF, PDF_LINEANNOT, PDF_LINKANNOT, PDF_LITERALSTRINGEND, PDF_LITERALSTRINGSTART, PDF_LOCATION, PDF_LZWDECODE, PDF_M, PDF_MAC, PDF_MARKINFO, PDF_MATRIX, PDF_MAXLEN, PDF_MAXWIDTH, PDF_MEDIABOX, PDF_METADATA, PDF_MISSINGWIDTH, PDF_MK, PDF_MODDATE, PDF_N, PDF_NAME, PDF_NAMED, PDF_NAMED_ACT_FIND, PDF_NAMED_ACT_OPEN, PDF_NAMED_ACT_PRINT, PDF_NAMED_ACT_SEARCH, PDF_NAMES, PDF_NAMESTART, PDF_NEEDAPPEARANCES, PDF_NEWLINE, PDF_NEWWINDOW, PDF_NEXT, PDF_NEXT_PAGE, PDF_NO_COMP_OBJ, PDF_NONFULLSCREEN_PAGEMODE, PDF_NULL, PDF_O, PDF_OBJ, PDF_OBJSTREAM, PDF_OCPROPERTIES, PDF_OFF, PDF_ONECOLUMN, PDF_OPEN, PDF_OPEN_ACTION, PDF_OPT, PDF_OUTLINES, PDF_OUTPUTINTENTS, PDF_OUTWARD, PDF_P, PDF_PAGE, PDF_PAGECLOSE, PDF_PAGEINVISIBLE, PDF_PAGELABELS, PDF_PAGELAYOUT, PDF_PAGEMODE, PDF_PAGEOPEN, PDF_PAGES, PDF_PAGEVISIBLE, PDF_PAINT_TYPE, PDF_PARAMS, PDF_PARENT, PDF_PATTERN, PDF_PATTERN_TYPE, PDF_PBD, PDF_PC, PDF_PDC, PDF_PDF, PDF_PERMS, PDF_PFD, PDF_PH, PDF_PIECEINFO, PDF_POLYGONANNOT, PDF_POLYLINEANNOT, PDF_POPUP, PDF_PREDICTOR, PDF_PREV, PDF_PREV_PAGE, PDF_PROCSET, PDF_PRODUCER, PDF_PROPERTIES, PDF_PUSH, PDF_PV, PDF_Q, PDF_QUADPOINTS, PDF_R, PDF_R2L, PDF_RC, PDF_RD, PDF_RE, PDF_REASON, PDF_RECALCULATE, PDF_RECT, PDF_REMOTEGOTO_ACTION, PDF_RENDITIONS, PDF_REPLACE, PDF_RESET_FORM, PDF_RESOURCES, PDF_RESTORE_GS, PDF_RI, PDF_ROOT, PDF_ROTATE, PDF_RUNLENGTH, PDF_RUNLENGTH_NEW, PDF_S, PDF_SCN, PDF_SHADING, PDF_SHOWIMG, PDF_SHOWTEXT, PDF_SHOWTEXT_TJ, PDF_SIG, PDF_SIG_FILTER_ADOBE_PPKLITE, PDF_SIG_FILTER_ADOBE_PPKMS, PDF_SIG_SUBFILTER_ADBE_PKCS7_DETACHED, PDF_SIG_SUBFILTER_ADBE_PKCS7_SHA1, PDF_SINGLE_QUOTES, PDF_SINGLEPAGE, PDF_SIZE, PDF_SP, PDF_SPIDERINFO, PDF_SPLIT, PDF_SQUAREANNOT, PDF_SQUIGGLY, PDF_SS, PDF_STAMPANNOT, PDF_STARTXREF, PDF_StmF, PDF_STORE_GS, PDF_STREAM, PDF_StrF, PDF_STRIKEOUT, PDF_STRUCT_TREE, PDF_SUBFILTER, PDF_SUBMIT_FORM, PDF_SUBTYPE, PDF_T, PDF_TAB, PDF_TEMPLATES, PDF_TEXT, PDF_TEXTANNOT, PDF_TEXTDIMENSION, PDF_TEXTFONT, PDF_TEXTLEAD, PDF_TEXTMATRIX, PDF_TEXTNEWLINESTART, PDF_TEXTRENDER, PDF_TEXTWIDTH, PDF_THREADS, PDF_THUMB, PDF_TILING_TYPE, PDF_TITLE, PDF_TJ_OPERAND_END, PDF_TJ_OPERAND_START, PDF_TM, PDF_TOUNICODE, PDF_TP, PDF_TRAILER, PDF_TRANSITION, PDF_TRIMBOX, PDF_TRUE, PDF_TRUETYPE, PDF_TU, PDF_TWOCOLUMN_LEFT, PDF_TWOCOLUMN_RIGHT, PDF_TWOPAGE_LEFT, PDF_TWOPAGE_RIGHT, PDF_TX, PDF_TYPE, PDF_TYPE0, PDF_TYPE1, PDF_U, PDF_UNCOVER, PDF_UNDERLINE, PDF_UNIX, PDF_URI_ACTION, PDF_URL, PDF_URLS, PDF_USEATTACHMENTS, PDF_USENONE, PDF_USEOC, PDF_USEOUTLINES, PDF_USETHUMBS, PDF_V, PDF_VALUECHANGE, PDF_VERSION, PDF_VERT_STEM, PDF_VERTICAL, PDF_VERTICES, PDF_VIEW, PDF_VIEWER_PREFERENCES, PDF_W, PDF_WATERMARKANNOT, PDF_WIDGET, PDF_WIDTH, PDF_WIDTHS, PDF_WINANSIENCODING, PDF_WIPE, PDF_X, PDF_XOBJECT, PDF_XREF, PDF_XREFSTMOFFSET, PDF_XREFSTREAM, PDF_XSTEP, PDF_XYZ, PDF_YES, PDF_YSTEP, PIXEL_PER_INCH, RUBICON_EMBEDDED, SITE, TEXT, TWIPS_TO_POINTS

Constructor Summary

Constructors

Constructor and Description
PDF()

Method Summary

Modifier and Type	Method and Description
void	addAttachment(PDFFileAttachment fileAttachment) Adds specified file attachment to the document.
void	addDocumentListener(DocumentListener documentListener)
void	addNeedSplitFileNameListener(PDFNeedSplitFileNameListener needSplitFileNameListener)
int	appendPagesFrom(PDF d, PageRangeSettings pageRange) Extracts specified pages from a specified document and then appends them to this document.
int	appendPagesFrom(String path, PageRangeSettings pageRange) Extracts specified pages from a document (specified by its pathname) and then appends them to this document.
boolean	check(InputStream inputStream)
boolean	check(String filePath)
void	closeDocument()
void	copyFrom(IDocument sourceDocument, PageRangeSettings pageRangeSettings)
void	copyFrom(IDocument sourceDocument, PageRangeSettings pageRangeSettings, DigitizerSettings digitizerSettings)
List	getAttachments()
int	getAttachmentsCount()
CurrentPageCount	getCurrentPageCount()
DocumentInfo	getDocumentInfo()
DocumentListener[]	getDocumentListeners()
EncoderSettings	getEncoderSettings()
PDFEncryption	getEncryptor() Retrieves current encryption settings of this PdfDocument.
String[]	getFileExtensionsForMIMEType(String MIMEType)
FileInfo	getFileInfo(InputStream inStream, String password)
FileInfo	getFileInfo(String fileName, String password)
String	getFileName()
FormatKind	getFormatKind()
MeasurementUnit	getMeasurementUnit() Returns default measurement unit currently in use for this PdfDocument.
String	getMIMEType()
String[]	getMIMETypesForFileExtension(String fileExtension)
PDFNeedSplitFileNameListener[]	getNeedSplitFileNameListeners()
PDFPage	getPage(int pageIndex)
IPage	getPage(int pageIndex, long timeoutInMS)
int	getPageCount()
List	getPageElements(int pageNum, int elementTypes) Returns a list of page elements of specified type in specified page.
List	getPageElements(PageRangeSettings pageRange, int elementTypes) Returns list of all page elements of specified type in specified page range.
PDFPageLayout	getPageLayout() Returns constant identifying page layout used as default when opening this document.
PDFPageMode	getPageMode() Returns constant identifying this PdfDocument's default page mode.
Preferences	getPreferences()
String[]	getSupportedFileExtensions()
String[]	getSupportedMIMETypes()
String	getVersion() Returns constant identifying this PdfDocument's PDF version.
String	getXMLMetadata() Returns XML metadata of this PdfDocument.
boolean	isEncrypted() Returns whether the document is encrypted.
boolean	isLoaded()
boolean	isOpenAfterSave() Returns whether document is set to be executed after data is saved to file.
boolean	isPageEmpty(int pageNum)
void	loadDocument(InputStream inputStream, String password)
void	loadDocument(String fileName, String password) Loads PDF document in specified path.
LoadDocumentFutureTask	loadDocumentAsync(InputStream inStream, String password)
LoadDocumentFutureTask	loadDocumentAsync(String fileName, String password)
void	redactText(List<SearchItem> searchItems, PageRangeSettings pageRange)
void	redactText(List<SearchItem> searchItems, PageRangeSettings pageRange, FillSettings fillSettings, RedactSettings redactSettings)
void	redactText(PageRangeSettings pageRange, List searchStringList, List searchModeList, List searchOptionsList, PDFPen pen, PDFBrush brush, String replaceString, PDFFont font, Color replaceStringColor, boolean fontSizeAuto) Deprecated. Instead use redactText(List, PageRangeSettings, FillSettings, RedactSettings)
DocumentListener	removeDocumentListener(DocumentListener documentListener)
PDFNeedSplitFileNameListener	removeNeedSplitFileNameListener(PDFNeedSplitFileNameListener needSplitFileNameListener)
void	save(OutputStream outputStream) Save loaded document to specified output stream object.
long	save(String outputFilePath) Save loaded document with specified pathname.
void	save(String outputDir, String baseFileName)
void	setEncoderSettings(EncoderSettings encoderSettings)
void	setEncryptor(PDFEncryption encrypto) Specify encryption settings for this PdfDocument.
void	setMeasurementUnit(MeasurementUnit measurementUnit) Specifies default measurement unit to be used for this PdfDocument.
void	setOnNeedFileName(PDFNeedFileNameHandler needFileNameHandler) Deprecated. Instead use addNeedSplitFileNameListener(PDFNeedSplitFileNameListener)
void	setOpenAfterSave(boolean openAfterSave) Specifies whether document needs to be launched by the Operating System (OS) shell program (such as explorer.exe in Windows™) after it is saved to a file.
void	setVersion(String version) Specifies PDF version of this PdfDocument.
int	split(PageRangeSettings pageRange) Extracts all pages in the specified page range to a new document.
int[]	split(PageRangeSettings[] pageRanges)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION_1_4

public static final String VERSION_1_4

PDF version 1.4

See Also:

Constant Field Values

VERSION_1_5

public static final String VERSION_1_5

PDF version 1.5

See Also:

Constant Field Values

VERSION_1_6

public static final String VERSION_1_6

PDF version 1.6

See Also:

Constant Field Values

VERSION_1_7

public static final String VERSION_1_7

PDF version 1.7

See Also:

Constant Field Values

Constructor Detail

PDF

public PDF()

Method Detail

setOpenAfterSave

public void setOpenAfterSave(boolean openAfterSave)

Specifies whether document needs to be launched by the Operating System (OS) shell program (such as explorer.exe in Windows™) after it is saved to a file. This method is currently supported only in Windows OSs.

Parameters:

openAfterSave - whether document needs to be executed after data is saved to file

See Also:

isOpenAfterSave(), setPrintAfterSave(boolean)

isOpenAfterSave

public boolean isOpenAfterSave()

Returns whether document is set to be executed after data is saved to file.

Returns:

whether document is set to be executed after data is saved to file

See Also:

setOpenAfterSave(boolean)

setMeasurementUnit

public void setMeasurementUnit(MeasurementUnit measurementUnit)

Specifies default measurement unit to be used for this PdfDocument.

Parameters:

measurementUnit - constant specifying the new default measurement unit

getMeasurementUnit

public MeasurementUnit getMeasurementUnit()

Returns default measurement unit currently in use for this PdfDocument.

Returns:

constant identifying the current default measurement unit

getPageLayout

public PDFPageLayout getPageLayout()

Returns constant identifying page layout used as default when opening this document.

Returns:

constant identifying the page layout

getPageMode

public PDFPageMode getPageMode()

Returns constant identifying this PdfDocument's default page mode. This page mode is applied by default when the document is opened in a viewer application.

Returns:

constant identifying page mode

setVersion

public void setVersion(String version)

Specifies PDF version of this PdfDocument.

Parameters:

version - constant specifying PDF version

getVersion

public String getVersion()

Returns constant identifying this PdfDocument's PDF version.

Returns:

constant identifying PDF version

addAttachment

public void addAttachment(PDFFileAttachment fileAttachment)
                   throws PDFException,
                          InsufficientPermissionsException,
                          IOException

Adds specified file attachment to the document.

Parameters:

fileAttachment - file attachment that needs to be added to the document

Throws:

IOException

InsufficientPermissionsException

PDFException

getAttachmentsCount

public int getAttachmentsCount()
                        throws IOException,
                               PDFException

Throws:

IOException

PDFException

getAttachments

public List getAttachments()
                    throws PDFException,
                           IOException

Throws:

PDFException

IOException

getPageElements

public List getPageElements(int pageNum,
                            int elementTypes)
                     throws PDFException,
                            IOException,
                            InsufficientPermissionsException

Returns a list of page elements of specified type in specified page.

Parameters:

pageNum - number of page

elementTypes - constant or a combination of constants specifying the type of the page elements

Returns:

list of page elements

Throws:

PDFException - if an illegal argument is supplied.

IOException - if an I/O error occurs.

InsufficientPermissionsException

getPageElements

public List getPageElements(PageRangeSettings pageRange,
                            int elementTypes)
                     throws PDFException,
                            IOException,
                            InsufficientPermissionsException

Returns list of all page elements of specified type in specified page range.

Parameters:

pageRange - pages whose page elements need to be retrieved

elementTypes - constant or a combination of constants specifying the type of the page elements

Returns:

list of all page elements

Throws:

PDFException - if an illegal argument is supplied.

IOException - if an I/O error occurs.

InsufficientPermissionsException

redactText

public void redactText(PageRangeSettings pageRange,
                       List searchStringList,
                       List searchModeList,
                       List searchOptionsList,
                       PDFPen pen,
                       PDFBrush brush,
                       String replaceString,
                       PDFFont font,
                       Color replaceStringColor,
                       boolean fontSizeAuto)
                throws PDFException,
                       IOException,
                       InsufficientPermissionsException

Deprecated. Instead use redactText(List, PageRangeSettings, FillSettings, RedactSettings)

Throws:

PDFException

IOException

InsufficientPermissionsException

redactText

public void redactText(List<SearchItem> searchItems,
                       PageRangeSettings pageRange)
                throws PDFException,
                       InsufficientPermissionsException,
                       IOException

Throws:

PDFException

InsufficientPermissionsException

IOException

redactText

public void redactText(List<SearchItem> searchItems,
                       PageRangeSettings pageRange,
                       FillSettings fillSettings,
                       RedactSettings redactSettings)
                throws PDFException,
                       IOException,
                       InsufficientPermissionsException

Throws:

PDFException

IOException

InsufficientPermissionsException

closeDocument

public void closeDocument()
                   throws IOException

Specified by:

closeDocument in interface IDocument

Throws:

IOException

isPageEmpty

public boolean isPageEmpty(int pageNum)
                    throws PDFException,
                           IOException,
                           InsufficientPermissionsException

Throws:

PDFException

IOException

InsufficientPermissionsException

check

public boolean check(String filePath)
              throws IOException

Specified by:

check in interface IDocument

Throws:

IOException

check

public boolean check(InputStream inputStream)
              throws IOException

Specified by:

check in interface IDocument

Throws:

IOException

getFileInfo

public FileInfo getFileInfo(String fileName,
                            String password)
                     throws FileCorruptException,
                            XDocException,
                            IOException

Specified by:

getFileInfo in interface IDocument

Throws:

FileCorruptException

XDocException

IOException

getFileInfo

public FileInfo getFileInfo(InputStream inStream,
                            String password)
                     throws FileCorruptException,
                            XDocException,
                            IOException

Specified by:

getFileInfo in interface IDocument

Throws:

FileCorruptException

XDocException

IOException

loadDocumentAsync

public LoadDocumentFutureTask loadDocumentAsync(String fileName,
                                                String password)
                                         throws FormatNotSupportedException,
                                                IncorrectPasswordException,
                                                XDocException,
                                                IOException

Specified by:

loadDocumentAsync in interface IDocument

Throws:

FormatNotSupportedException

IncorrectPasswordException

XDocException

IOException

loadDocumentAsync

public LoadDocumentFutureTask loadDocumentAsync(InputStream inStream,
                                                String password)
                                         throws FormatNotSupportedException,
                                                IncorrectPasswordException,
                                                XDocException,
                                                IOException

Specified by:

loadDocumentAsync in interface IDocument

Throws:

FormatNotSupportedException

IncorrectPasswordException

XDocException

IOException

loadDocument

public void loadDocument(String fileName,
                         String password)
                  throws FormatNotSupportedException,
                         IncorrectPasswordException,
                         XDocException,
                         IOException

Loads PDF document in specified path. The loaded document can then be printed, displayed, modified, or saved.

Specified by:

loadDocument in interface IDocument

Parameters:

fileName - pathname of the PDF document

Throws:

IOException - if an I/O error occurs.

PDFException - if an illegal argument is supplied.

FormatNotSupportedException

IncorrectPasswordException

XDocException

loadDocument

public void loadDocument(InputStream inputStream,
                         String password)
                  throws FormatNotSupportedException,
                         IncorrectPasswordException,
                         XDocException,
                         IOException

Specified by:

loadDocument in interface IDocument

Throws:

FormatNotSupportedException

IncorrectPasswordException

XDocException

IOException

getEncryptor

public PDFEncryption getEncryptor()

Retrieves current encryption settings of this PdfDocument.

Returns:

a PdfEncryption object identifying the current encryption settings of the document

Since:

1.0

See Also:

setEncryptor(PDFEncryption)

Example

See example.

setEncryptor

public void setEncryptor(PDFEncryption encrypto)
                  throws PDFException,
                         IOException,
                         InsufficientPermissionsException

Specify encryption settings for this PdfDocument.

Parameters:

encrypto - PdfEncryption specifying the encryption settings for the document

Throws:

PDFException

IOException

InsufficientPermissionsException

Since:

1.0

See Also:

getEncryptor()

isEncrypted

public boolean isEncrypted()

Returns whether the document is encrypted.

Returns:

whether the document is encrypted

save

public long save(String outputFilePath)
          throws IOException,
                 PDFException,
                 InsufficientPermissionsException

Save loaded document with specified pathname.

Parameters:

outputFilePath - pathname to which the document needs to be saved

Returns:

size of the saved document

Throws:

IOException - if an I/O error occurs.

PDFException - if an illegal argument is supplied.

InsufficientPermissionsException

save

public void save(OutputStream outputStream)
          throws IOException,
                 PDFException,
                 InsufficientPermissionsException

Save loaded document to specified output stream object.

Specified by:

save in interface IDocument

Parameters:

outputStream - output stream to which the document needs to be saved

Throws:

IOException - if an I/O error occurs.

PDFException - if an illegal argument is supplied.

InsufficientPermissionsException

getPage

public PDFPage getPage(int pageIndex)
                throws PDFException,
                       IOException

Specified by:

getPage in interface IDocument

Throws:

PDFException

IOException

getPage

public IPage getPage(int pageIndex,
                     long timeoutInMS)
              throws InterruptedException,
                     XDocException,
                     IOException

Specified by:

getPage in interface IDocument

Throws:

InterruptedException

XDocException

IOException

getPageCount

public int getPageCount()

Specified by:

getPageCount in interface IDocument

getCurrentPageCount

public CurrentPageCount getCurrentPageCount()

Specified by:

getCurrentPageCount in interface IDocument

getXMLMetadata

public String getXMLMetadata()
                      throws IOException,
                             PDFException

Returns XML metadata of this PdfDocument.

Returns:

XML metadata of the document

Throws:

IOException - if an I/O error occurs.

PDFException - if an illegal argument is supplied.

Since:

1.0

Example

See example.

appendPagesFrom

public int appendPagesFrom(PDF d,
                           PageRangeSettings pageRange)
                    throws IOException,
                           PDFException,
                           InsufficientPermissionsException

Extracts specified pages from a specified document and then appends them to this document.

Parameters:

d - document from which pages need to be appended

pageRange - pages that need to be appended

Throws:

IOException - if an I/O error occurs.

PDFException - if an illegal argument is supplied.

InsufficientPermissionsException

See Also:

PDFFormFieldRenameHandler, setOnRenameField(PDFFormFieldRenameHandler)

appendPagesFrom

public int appendPagesFrom(String path,
                           PageRangeSettings pageRange)
                    throws IOException,
                           FormatNotSupportedException,
                           InsufficientPermissionsException,
                           XDocException

Extracts specified pages from a document (specified by its pathname) and then appends them to this document.

Parameters:

path - document from which pages need to be appended

pageRange - pages that need to be appended

Throws:

IOException - if an I/O error occurs.

XDocException

InsufficientPermissionsException

FormatNotSupportedException

Since:

1.0

See Also:

PDFFormFieldRenameHandler, setOnRenameField(PDFFormFieldRenameHandler)

Example

See example.

split

public int split(PageRangeSettings pageRange)
          throws IOException,
                 XDocException,
                 InsufficientPermissionsException

Extracts all pages in the specified page range to a new document.

Specifying pageRange as "1-10" on a 12-page document will create a new document 1-10.pdf containing all pages from 1 to 10.

The name of the new document can be obtained and changed at run time using the needSplitFileName() event.

Parameters:

pageRange - pages that need to be extracted

Throws:

IOException - if an I/O error occurs.

PDFException - if an illegal argument is supplied.

InsufficientPermissionsException

XDocException

See Also:

addNeedSplitFileNameListener(PDFNeedSplitFileNameListener)

split

public int[] split(PageRangeSettings[] pageRanges)
            throws IOException,
                   XDocException,
                   InsufficientPermissionsException

Throws:

IOException

XDocException

InsufficientPermissionsException

setOnNeedFileName

public void setOnNeedFileName(PDFNeedFileNameHandler needFileNameHandler)

Deprecated. Instead use addNeedSplitFileNameListener(PDFNeedSplitFileNameListener)

addNeedSplitFileNameListener

public void addNeedSplitFileNameListener(PDFNeedSplitFileNameListener needSplitFileNameListener)

removeNeedSplitFileNameListener

public PDFNeedSplitFileNameListener removeNeedSplitFileNameListener(PDFNeedSplitFileNameListener needSplitFileNameListener)

getNeedSplitFileNameListeners

public PDFNeedSplitFileNameListener[] getNeedSplitFileNameListeners()

isLoaded

public boolean isLoaded()

Specified by:

isLoaded in interface IDocument

getSupportedFileExtensions

public String[] getSupportedFileExtensions()

Specified by:

getSupportedFileExtensions in interface IDocument

getSupportedMIMETypes

public String[] getSupportedMIMETypes()

Specified by:

getSupportedMIMETypes in interface IDocument

getMIMEType

public String getMIMEType()

Specified by:

getMIMEType in interface IDocument

getFileExtensionsForMIMEType

public String[] getFileExtensionsForMIMEType(String MIMEType)

Specified by:

getFileExtensionsForMIMEType in interface IDocument

getMIMETypesForFileExtension

public String[] getMIMETypesForFileExtension(String fileExtension)

Specified by:

getMIMETypesForFileExtension in interface IDocument

getFileName

public String getFileName()

Specified by:

getFileName in interface IDocument

getDocumentInfo

public DocumentInfo getDocumentInfo()

Specified by:

getDocumentInfo in interface IDocument

addDocumentListener

public void addDocumentListener(DocumentListener documentListener)

Specified by:

addDocumentListener in interface IDocument

removeDocumentListener

public DocumentListener removeDocumentListener(DocumentListener documentListener)

Specified by:

removeDocumentListener in interface IDocument

getDocumentListeners

public DocumentListener[] getDocumentListeners()

Specified by:

getDocumentListeners in interface IDocument

getPreferences

public Preferences getPreferences()

Specified by:

getPreferences in interface IDocument

setEncoderSettings

public void setEncoderSettings(EncoderSettings encoderSettings)

Specified by:

setEncoderSettings in interface IDocument

getFormatKind

public FormatKind getFormatKind()

Specified by:

getFormatKind in interface IDocument

copyFrom

public void copyFrom(IDocument sourceDocument,
                     PageRangeSettings pageRangeSettings)
              throws XDocException,
                     IOException

Specified by:

copyFrom in interface IDocument

Throws:

XDocException

IOException

copyFrom

public void copyFrom(IDocument sourceDocument,
                     PageRangeSettings pageRangeSettings,
                     DigitizerSettings digitizerSettings)
              throws XDocException,
                     IOException

Specified by:

copyFrom in interface IDocument

Throws:

XDocException

IOException

save

public void save(String outputDir,
                 String baseFileName)
          throws XDocException,
                 IOException

Specified by:

save in interface IDocument

Throws:

XDocException

IOException

getEncoderSettings

public EncoderSettings getEncoderSettings()

Specified by:

getEncoderSettings in interface IDocument