|
|
File representing PDF content
Method DetailaddPage(int destinationPage, PdfFile sourcePdf, int sourcePage) Adds the page from the source PDF to this PDF at the specified location. Controlled by Max Export Size of activation key.
Parameters:
Since: 02-17-2012 Data analyze() Performs a top level analysis of the PDF and returns summary information. Returns: Data Since: 07-23-2015 appendPdf(PdfFile sourcePdf) Appends the source PDF to this PDF. Controlled by Max Export Size of activation key.
Parameters:
Since: 02-17-2012 String cache(String scope, int expire) Caches this file for the amount of time specified and restricts the access scope. Returns a file url that can be used in an audio or image tag for rendering the file. Throws error if this file does not have a standard rendering or streaming capability. This is not a high performance and high scale method. It is meant to be used for displaying or streaming a single file to a single user.
Parameters:
Returns: String Since: 07-09-2015 This method has been deprecated since 02-26-2016. Use CacheManager.cacheFile String calcMD5() Returns an MD5 checksum of the contents of this file. Returns: String Since: 11-23-2012 clip(int x, int y, int w, int h) If file is an image type, clips the image
Parameters:
Since: 09-05-2008 closeReader() Resets the capability to read lines to the beginning of the file. Since: 08-13-2013 File copy() Returns a copy of the file Returns: File Since: 11-17-2011 ImageFile copy() Returns a copy of the file Returns: ImageFile Since: 11-17-2011 PdfFile copyCompatible() Creates a new PdfFile with version 1.5 or greater, making it compatible for usage as a Document. Returns: PdfFile Since: 06-23-2020 FileBuffer createFileBuffer() Reads this compressed file and returns a FileBuffer. Throws exception if this not a supported type (zip and jar). Returns: FileBuffer Since: 08-27-2013 boolean createPdfTamperSeal() Creates a Digital Signature 'tamper seal' on this file. This should be called only once, when all data have been applied. Returns false if this method has already been applied to the file. Returns: boolean Since: 06-23-2011 ImageFile createSprite(int spacing, int padding, float scale, boolean horizontal, boolean includePageNumbers) Creates a sprite image for the PDF. Restricted by max upload of the activation key and by the cloud max pdf page count.
Parameters:
Returns: ImageFile Since: 09-21-2012 ImageFile createSprite(int spacing, int padding, int height, int width, boolean horizontal, boolean includePageNumbers) Creates a sprite image for the PDF. Restricted by max upload of the activation key and by the cloud max pdf page count. Height and width will not exceed 30% of normal page size.
Parameters:
Returns: ImageFile Since: 11-18-2013 boolean decrypt(String password) Sets password for pdf decryption. Call this method before any other modification method if pdf file is password protected. Returns false if decryption fails.
Parameters:
Returns: boolean Since: 10-21-2011 File decrypt(String password, String filename) Returns a new file. Assumes the content of this file is PGP encrypted.
Parameters:
Returns: File Since: 03-17-2014 boolean deletePage(int pageNumber) Deletes the specified page. Returns false if the page cannot be deleted.
Parameters:
Returns: boolean Since: 07-13-2011 File encrypt(String password) Returns a new file with the content of this file PGP encrypted. The new file's filename will be existing filename+.txt
Parameters:
Returns: File Since: 05-16-2011 File encrypt(String password, String filename) Returns a new file with the content of this file PGP encrypted having the specified file name. Extensions allowed: pgp, gpg, txt, asc. Extension is required.
Parameters:
Returns: File Since: 10-07-2016 String getContentType() Returns the content type of this file Returns: String Since: 02-03-2010 String getFailureMessage() When isValid is false, contains failure message. Returns: String Since: 04-01-2009 String getFileExtension() Returns the file extension. 'Myfile.doc' returns 'doc' Returns: String Since: 06-10-2010 int getFileLength() Returns the size of the file in bytes. Returns: int Since: 08-23-2018 int getFileSize() Returns the size of the file in kilobytes. Returns: int Since: 04-10-2007 String getFileType() Returns the type of the file as specified by the upload tag or API. This may be null if the file was obtained by means other than an upload. Returns: String Since: 04-10-2007 String getFilename() Returns the name of the uploaded file (without the full path). Returns: String Since: 11-07-2007 int getHeight() Returns image height Returns: int Since: 11-17-2011 Data getImageMetadata() Returns metadata of this image file (not all of which might be present): longitude,latitude,date,camera,manufacturer,focalLength,fStop,exposureTime,isoSpeedRatings shutterSpeedValueAPEX,shutterSpeedExposureTime,apertureValueAPEX,subjectDistance,dateTimeOriginal,orientation,height,width,p0-p12. p0-p12 contains pixel colors for 13 points on the image in hex. Returns: Data Since: 01-26-2017 Payload getNativeLayer() Obtains the native layer for this PDF from the underlying content. Changes to this layer are not persisted. Returns: Payload Since: 04-26-2012 ImageFile getPage(String filename, int page, float scale, boolean grayscale) Creates a PNG of the specified page.
Parameters:
Returns: ImageFile Since: 07-19-2011 int getPageCount() Returns the number of pages in this PDF. Returns: int Since: 07-19-2011 DataReader getReader() Opens a data reader for this file. File type should be list compatible. Returns: DataReader Since: 11-20-2019 DataList getSpriteMap(String name) Returns a DataList containing sprite coordinate information that can be used to create an HTML image map for the sprite. Call createSprite before calling this method.
Parameters:
Returns: DataList DataList Name: map DataList Fields: page, coords, left, top, height, width Since: 11-13-2012 TiffBuilder getTiffBuilder() Returns a new TiffBuilder for this PdfFile. Throws exception if the content is invalid. Returns: TiffBuilder Since: 01-28-2013 int getWidth() Returns image width Returns: int Since: 11-17-2011 XMLReader getXMLReader(boolean removeNamespaces) Returns a ServicePayload for processing XML-based files. Returns null if the file is not XML.
Parameters:
Returns: XMLReader Since: 04-11-2023 hidePdfMenubar() Adds viewer setting to not display its menu bar Since: 06-23-2011 hidePdfToolbar() Adds viewer setting to not display its toolbar Since: 06-23-2011 hidePdfUI() Adds viewer setting to not display its UI Since: 06-23-2011 boolean isAdHocConversionSupported() Returns true if the content supports immediate conversion to adhoc. See Packet.createAdHocDocument(File,...) Returns: boolean Since: 11-09-2009 boolean isCompatible() Returns true if this PDF can be converted to a Document. Returns: boolean Since: 07-23-2015 boolean isCorrectType() Returns true if the type of the file is within the specified restriction. Returns: boolean Since: 04-10-2007 boolean isDataListSupported() Returns true if this file content can be used as a DataList. See Attachment.toDataList Returns: boolean Since: 02-03-2010 boolean isDecryptSupported(String password) Checks if this pdf file can be decrypted
Parameters:
Returns: boolean Since: 10-21-2011 This method has been deprecated since 11-16-2012. Use boolean: decrypt(password) boolean isEncrypted() Checks if this pdf file is password protected Returns: boolean Since: 10-21-2011 boolean isGreyscale() Is pdf or tiff converted in greyscale Returns: boolean Since: 05-23-2011 This method has been deprecated since 12-23-2015. Use PdfFile.getTiffBuilder().setGrayScale boolean isMacro() Returns true if the content of the file contains macro. Returns: boolean Since: 02-23-2010 boolean isPdfConversionSupported() Returns true if the content supports conversion to PDF. Returns: boolean Since: 03-10-2008 boolean isSealed() Returns true if this PDF has been tamper sealed. Returns: boolean Since: 02-17-2012 boolean isSizeExceeded() Returns true if the size of the file exceeds the specified restriction. Returns: boolean Since: 04-10-2007 boolean isValid() Returns true if the content of the file is valid. Returns: boolean Since: 04-10-2007 boolean isVirus() Returns true if the content of the file contains a virus. Returns: boolean Since: 04-10-2007 File pgpDecrypt(File keyFile, String password, String filename) Returns a new file with the content of this PGP encrypted file decrypted using the provided private key. The content type is guessed from the file name extension
Parameters:
Returns: File Since: 08-03-2016 File pgpEncrypt(File keyFile) Returns a new file with the content of this file PGP encrypted using the provided public key. The new file's filename will be existing filename+.txt
Parameters:
Returns: File Since: 08-03-2016 PacketDataList readDataList(String name) Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format.
Parameters:
Returns: PacketDataList Since: 06-03-2020 Payload readDataLists() Creates a Payload of PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls). If xls, this will execute formulas. This method also takes liberties with regard to column names. If it encounters any blank column name it assumes the first row is data and renames all the columns as col0 - colN. Throws exception if invalid or unsupported file format. Returns: Payload Since: 05-11-2021 String readFile() Reads all of the text-based file and returns the content as a string. Returns null if there is no content. Throws exception if this file is not a text-based file. Returns: String Since: 01-20-2015 String readLine() Reads one line (of the presumably text file) and returns it, advancing the reader to the next line for subsequent reads. Returns null if this file is not text based or there are no more lines to read. Best practice-call closeReader when finished. Returns: String Since: 08-13-2013 DataList readText() Returns a datalist of text contained in this PDF. Returns null if the PDF cannot be read. Returns: DataList DataList Name: textList DataList Fields: text, left, top, height, width, page Since: 02-16-2024 File removeSignature() Removes the digital signature, if any. Returns: File Since: 02-26-2016 resizeWidth(int maxWidth) Transforms the size of the file (only works on images) by reducing the width to the specified with. If the width is already less than the specified width, this does nothing.
Parameters:
Since: 04-10-2007 rotate(int degrees) Rotates this image by an angle provided in degrees. Image rotated clockwise if angle is a positive number and counter-clockwise if angle is a negative number
Parameters:
Since: 10-19-2011 setData(Data data) Updates pdf form fields with provided data. Note - further changes to data object are not reflected on document fields
Parameters:
Since: 06-23-2011 setGreyscale(boolean greyscale) Sets whether pdf or tiff converted in greyscale or color
Parameters:
Since: 05-23-2011 This method has been deprecated since 12-23-2015. Use PdfFile.getTiffBuilder().setGrayScale File sign() Applies a digital signature to the file. Content must be well formed XML. Returns: File Since: 02-26-2016 AudioFile toAudioFile() Returns AudioFile created from this File. Method returns null if current file cannot be represented as an audio. Returns: AudioFile Since: 03-09-2018 Data toData() Returns the content of this file as a Data object with three properties: fileName, contentType, and base64. base64 will be a Base64 encoded string of the file contents. Returns: Data Since: 05-16-2011 PacketDataList toDataList(String name) Creates a non persistent PacketDataList from the contents of this file. The contents must support DataList conversion (currently .csv and .xls)
Parameters:
Returns: PacketDataList Since: 05-15-2010 ExcelFile toExcelFile() Returns ExcelFile created from this File. Method returns null if current file cannot be represented as an excel file. Returns: ExcelFile Since: 01-17-2022 ImageFile toImage() Returns ImageFile created from this File. Method returns null if current file cannot be represented as an image. The file must already be a supported image content type to use this method. If you are trying convert a PDF to an image you should just get a specified page or use toTIFF to get a multi-page TIFF file. Returns: ImageFile Since: 10-19-2011 PdfFile toPdf(String filename) Converts this file to PDF if possible. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
Parameters:
Returns: PdfFile Since: 07-04-2011 PdfFile toPdf(String filename, String password) This method expects the document to already be a PDF. Call isPdfConversionSupported() to check if file can be converted to PDF. Returns PDF file or null if PDF conversion is not supported
Parameters:
Returns: PdfFile Since: 10-05-2017 String toString() Returns a description of this object. Returns: String Since: 06-14-2007 File toTiff(String filename, float scale, boolean grayscale) Converts this pdf file to multi-page tiff image
Parameters:
Returns: File Since: 06-07-2011 This method has been deprecated since 01-28-2013. Use getTiffBuilder().build() UnknownFile toUnknownFile(String ext) Converts this file to an UnknownFile (used for testing purposes).
Parameters:
Returns: UnknownFile Since: 08-23-2018 VCardFile toVCardFile() Returns VCard representation of this file. Returns invalid file if current file cannot be parsed as VCard Returns: VCardFile Since: 12-12-2011 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. | API Date: May 01, 2024 05:15 AM |