com.qoppa.office

Class ExcelDocument

java.lang.Object

com.qoppa.office.ExcelDocument

All Implemented Interfaces:

Printable

public class ExcelDocument
extends Object
implements Printable

This class can read an OOXML (MS Excel .xlsx) file and then convert to PDF, images or print the file. This is a main class of the jOfficeConvert library and is the starting point when working with Excel documents.

Author:

Qoppa Software

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
ExcelDocument(byte[] byteArray) Load an Excel file from a byte array.
ExcelDocument(byte[] byteArray, ExcelConvertOptions opts) Load an Excel file from a byte array.
ExcelDocument(InputStream inputStream) Load an Excel document from an input stream.
ExcelDocument(InputStream inputStream, ExcelConvertOptions opts) Load an Excel document from an input stream.
ExcelDocument(String filePath) Load an Excel document from a file.
ExcelDocument(String filePath, ExcelConvertOptions opts) Load an Excel document from a file - with convert options
ExcelDocument(URL url) Load an Excel file from a URL.
ExcelDocument(URL url, ExcelConvertOptions opts) Load an Excel file from a URL.

Method Summary

Modifier and Type	Method and Description
int	getPageCount() Return the number of pages in the converted document.
static String	getVersion() Returns version string for jOfficeConvert.
List<String>	getWorkSheetNames()
static void	loadLicense(InputStream licenseStream) Method to load a license file from an inputstream.
static void	loadLicense(String licenseFile) Method to load a license file.
int	print(Graphics graphics, PageFormat pageFormat, int pageIndex) Implementation of the print method to make ExcelDocument fulfill the Printable interface.
void	print(PrintOptions options) Prints this Excel document.
void	print(String printerName, PrintOptions options) Prints this Excel document to the specified printer, by name.
void	print(String printerName, PrintOptions options, PrintRequestAttributeSet printAttrSet) Prints this Excel document to the specified printer, by name and passes the attribute set to the printer job.
void	printToDefaultPrinter(PrintOptions options) Prints the Excel document to the default printer.
void	saveAsPDF(OutputStream pdfFileStream) Converts the Excel document into a PDF document then saves the created PDF Document to a file using an Output Stream
void	saveAsPDF(OutputStream pdfFileStream, PDFSecuritySettings securitySettings) Converts the Excel document into a PDF document, applies the security settings and then saves the created PDF Document to a file using an Output Stream
void	saveAsPDF(String pdfFile) Converts the Excel document into a PDF document then saves the created PDF Document to a file using a String filename
void	saveAsPDF(String pdfFile, PDFSecuritySettings securitySettings) Converts the Excel document into a PDF document, applies the security settings and then saves the created PDF Document to a file using a String filename
void	saveDocumentAsTIFF(OutputStream outStream, TIFFOptions options) Save the entire document as a multi-page TIFF image the given OutputStream.
void	saveDocumentAsTIFF(String fileName, TIFFOptions options) Save the entire document as a multi-page TIFF image to the given String Filename.
void	savePageAsGIF(int pageIndex, OutputStream outStream, int dpi) Save the rendered image of the page to the given OutputStream in GIF format.
void	savePageAsGIF(int pageIndex, String fileName, int dpi) Save the rendered image of the page to the given String Filename in GIF format.
void	savePageAsJPEG(int pageIndex, OutputStream outStream, int resDPI, float quality) Save the rendered image of the page to the given OutputStream in JPEG format.
void	savePageAsJPEG(int pageIndex, String fileName, int resDPI, float quality) Save the rendered image of the page to the given String Filename in JPEG format.
void	savePageAsPNG(int pageIndex, OutputStream outStream, int dpi) Save the rendered image of the page to the given OutputStream in PNG format.
void	savePageAsPNG(int pageIndex, String fileName, int dpi) Save the rendered image of the page to the given String Filename in PNG format.
void	savePageAsTIFF(int pageIndex, OutputStream outStream, TIFFOptions options) Render a page to an image and save it in TIFF format.
void	savePageAsTIFF(int pageIndex, String fileName, TIFFOptions options) Render a page to an image and save it in TIFF format.
static boolean	setKey(String key) Sets product key.
static void	setUserFontDirectories(List<String> userFontDirs) Set user font directories.
void	setWorksheetsToConvert(List<String> worksheetNamesToConvert) Set a list of WorkSheet names to restrict PDF conversion to.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelDocument

public ExcelDocument(String filePath,
                     ExcelConvertOptions opts)
              throws IOException,
                     OfficeException

Load an Excel document from a file - with convert options

Parameters:

filePath - The path to the file

opts - Excel file conversion options

Throws:

IOException

OfficeException

ExcelDocument

public ExcelDocument(String filePath)
              throws IOException,
                     OfficeException

Load an Excel document from a file.

Parameters:

filePath - The path to the file

Throws:

IOException

OfficeException

ExcelDocument

public ExcelDocument(InputStream inputStream,
                     ExcelConvertOptions opts)
              throws IOException,
                     OfficeException

Load an Excel document from an input stream.

Parameters:

inputStream - Input Stream representing the Excel file

opts - Excel file conversion options

Throws:

IOException

OfficeException

ExcelDocument

public ExcelDocument(InputStream inputStream)
              throws IOException,
                     OfficeException

Load an Excel document from an input stream.

Parameters:

inputStream - Input Stream representing the Excel file

Throws:

IOException

OfficeException

ExcelDocument

public ExcelDocument(byte[] byteArray,
                     ExcelConvertOptions opts)
              throws IOException,
                     OfficeException

Load an Excel file from a byte array.

Parameters:

byteArray - byteArray representing the Excel file

opts - Excel file conversion options

Throws:

IOException

OfficeException

ExcelDocument

public ExcelDocument(byte[] byteArray)
              throws IOException,
                     OfficeException

Load an Excel file from a byte array.

Parameters:

byteArray - byteArray representing the Excel file

Throws:

IOException

OfficeException

ExcelDocument

public ExcelDocument(URL url,
                     ExcelConvertOptions opts)
              throws IOException,
                     OfficeException

Load an Excel file from a URL.

Parameters:

url - URL representing the Excel file

opts - Excel file conversion options

Throws:

IOException

OfficeException

ExcelDocument

public ExcelDocument(URL url)
              throws IOException,
                     OfficeException

Load an Excel file from a URL.

Parameters:

url - URL representing the Excel file

Throws:

IOException

OfficeException

Method Detail

setKey

public static boolean setKey(String key)

Sets product key. Use this method after purchasing to remove evaluation restrictions.

Parameters:

key - Product key.

loadLicense

public static void loadLicense(InputStream licenseStream)
                        throws com.qoppa.pdf.LicenseException

Method to load a license file from an inputstream. This is useful when the license file is placed in the classpath of the host application and an input stream can be opened to it as a resource.

Parameters:

licenseStream - The input stream for the license file contents.

Throws:

com.qoppa.pdf.LicenseException - If there are any problems with the license file

loadLicense

public static void loadLicense(String licenseFile)
                        throws com.qoppa.pdf.LicenseException,
                               IOException

Method to load a license file.

Parameters:

licenseFile - The full path to the license file.

Throws:

com.qoppa.pdf.LicenseException - If there are any problems with the license file

IOException

getVersion

public static String getVersion()

Returns version string for jOfficeConvert. If this is the demo version, the return string will contain 'Demo Version' at the end.

saveAsPDF

public void saveAsPDF(String pdfFile)
               throws IOException,
                      PDFException

Converts the Excel document into a PDF document then saves the created PDF Document to a file using a String filename

Parameters:

pdfFile - String representing the name of the file to save to

Throws:

PDFException

IOException

saveAsPDF

public void saveAsPDF(OutputStream pdfFileStream)
               throws IOException,
                      PDFException

Converts the Excel document into a PDF document then saves the created PDF Document to a file using an Output Stream

Parameters:

pdfFileStream - Output Stream the PDF document will be written to

Throws:

PDFException

IOException

saveAsPDF

public void saveAsPDF(String pdfFile,
                      PDFSecuritySettings securitySettings)
               throws PDFException,
                      IOException

Converts the Excel document into a PDF document, applies the security settings and then saves the created PDF Document to a file using a String filename

Parameters:

pdfFile - String representing the name of the file to save to

securitySettings - PDFSecuritySettings object containing encryption information

Throws:

IOException

PDFException

saveAsPDF

public void saveAsPDF(OutputStream pdfFileStream,
                      PDFSecuritySettings securitySettings)
               throws PDFException,
                      IOException

Converts the Excel document into a PDF document, applies the security settings and then saves the created PDF Document to a file using an Output Stream

Parameters:

pdfFileStream - Output Stream the PDF document will be written to

securitySettings - PDFSecuritySettings object containing encryption information

Throws:

IOException

PDFException

getPageCount

public int getPageCount()
                 throws PDFException

Return the number of pages in the converted document.

Returns:

pageCount number of pages in the converted document

Throws:

PDFException

print

public void print(PrintOptions options)
           throws PrinterException,
                  OfficeException

Prints this Excel document. This method will prompt the user with the printer dialog and then print the document.

Parameters:

options - Print job settings. Use this object to define how to print the document. If null, it will print using default settings.

Throws:

PrinterException

OfficeException

print

public void print(String printerName,
                  PrintOptions options)
           throws PrinterException,
                  OfficeException

Prints this Excel document to the specified printer, by name. This method will print the Excel document silently (without showing the printer dialog) to the named printer. If the printerName parameter is null, this method will print to the default printer.

This method can only be called if using Java 1.4.2 or higher as it needs PrintServices, which were only implemented starting on 1.4.

Parameters:

options - Print job settings. Use this object to define how to print the document. If null, it will print using default settings.

printerName - The name of the printer to print to. If this parameter is set to null, the method will print to the default printer.

Throws:

PrinterException - This exception is thrown if the printer is not found or if there is an error while printing.

OfficeException

print

public void print(String printerName,
                  PrintOptions options,
                  PrintRequestAttributeSet printAttrSet)
           throws PrinterException,
                  OfficeException

Prints this Excel document to the specified printer, by name and passes the attribute set to the printer job. This method will print the Excel document silently (without showing the printer dialog) to the named printer. If the printerName parameter is null, this method will print to the default printer. If the printAttrSet parameter is null, the printer job will use its default settings.

This method can only be called if using Java 1.4.2 or higher as it needs PrintServices, which were only implemented starting on 1.4.

Parameters:

options - Print job settings. Use this object to define how to print the document. If null, it will print using default settings.

printerName - The name of the printer to print to. If this parameter is set to null, the method will print to the default printer.

printAttrSet - The attribute set to pass to the printer. This parameter simply gets passed through to the printer job to set options such as the media tray, chromaticity and others. If null is passed, the print job will use default attributes.

Throws:

PrinterException - This exception is thrown if the printer is not found or if there is an error while printing.

OfficeException

printToDefaultPrinter

public void printToDefaultPrinter(PrintOptions options)
                           throws PrinterException,
                                  OfficeException

Prints the Excel document to the default printer. This method will print the Excel document silently (without showing the printer dialog) to the default printer.

Parameters:

options - Print job settings. Use this object to define how to print the document. If null, it will print using default settings.

Throws:

PrinterException - This exception is thrown if the printer is not found or if there is an error while printing.

OfficeException

savePageAsPNG

public void savePageAsPNG(int pageIndex,
                          OutputStream outStream,
                          int dpi)
                   throws IOException,
                          OfficeException

Save the rendered image of the page to the given OutputStream in PNG format.

Parameters:

pageIndex - The 0 based page index.

outStream - The stream to save the image to.

dpi - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.

Throws:

IOException

OfficeException

savePageAsPNG

public void savePageAsPNG(int pageIndex,
                          String fileName,
                          int dpi)
                   throws IOException,
                          OfficeException

Save the rendered image of the page to the given String Filename in PNG format.

Parameters:

pageIndex - The 0 based page index.

fileName - The name of the PNG file.

dpi - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.

Throws:

IOException

OfficeException

savePageAsGIF

public void savePageAsGIF(int pageIndex,
                          OutputStream outStream,
                          int dpi)
                   throws IOException,
                          OfficeException

Save the rendered image of the page to the given OutputStream in GIF format.

Parameters:

pageIndex - The 0 based page index.

outStream - The stream to save the image to.

dpi - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.

Throws:

IOException

OfficeException

savePageAsGIF

public void savePageAsGIF(int pageIndex,
                          String fileName,
                          int dpi)
                   throws IOException,
                          OfficeException

Save the rendered image of the page to the given String Filename in GIF format.

Parameters:

pageIndex - The 0 based page index.

fileName - The name of the GIF file.

dpi - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.

Throws:

IOException

OfficeException

savePageAsJPEG

public void savePageAsJPEG(int pageIndex,
                           OutputStream outStream,
                           int resDPI,
                           float quality)
                    throws IOException,
                           OfficeException

Save the rendered image of the page to the given OutputStream in JPEG format.

Parameters:

pageIndex - The 0 based page index.

outStream - The stream to save the image to.

resDPI - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.

quality - The quality setting to use for JPEG compression. The range for this value is 0.0 to 1.0. Lower values mean higher compression and lower quality. As a guideline, 0.25 is low quality, 0.5 is medium quality and 0.75 is high quality.

Throws:

IOException

OfficeException

savePageAsJPEG

public void savePageAsJPEG(int pageIndex,
                           String fileName,
                           int resDPI,
                           float quality)
                    throws IOException,
                           OfficeException

Save the rendered image of the page to the given String Filename in JPEG format.

Parameters:

pageIndex - The 0 based page index.

fileName - The name of the file to save to.

resDPI - Dots per inch at which to render the image. 72 is the native PDF resolution and is equivalent to 100% scale.

quality - The quality setting to use for JPEG compression. The range for this value is 0.0 to 1.0. Lower values mean higher compression and lower quality. As a guideline, 0.25 is low quality, 0.5 is medium quality and 0.75 is high quality.

Throws:

IOException

OfficeException

savePageAsTIFF

public void savePageAsTIFF(int pageIndex,
                           String fileName,
                           TIFFOptions options)
                    throws IOException,
                           OfficeException

Render a page to an image and save it in TIFF format. If the TIFF compression is one of the fax compressions, the image will be converted to black and white automatically.

Parameters:

pageIndex - The 0 based page index.

fileName - The name of the file to save the image to.

options - Options to use when saving the image, such as the TIFF compression type.

Throws:

IOException

OfficeException

savePageAsTIFF

public void savePageAsTIFF(int pageIndex,
                           OutputStream outStream,
                           TIFFOptions options)
                    throws IOException,
                           OfficeException

Render a page to an image and save it in TIFF format. If the TIFF compression is one of the fax compressions, the image will be converted to black and white automatically.

Parameters:

pageIndex - The 0 based page index.

outStream - The output stream to write the image to.

options - Options to use when saving the image, such as the TIFF compression type.

Throws:

IOException

OfficeException

saveDocumentAsTIFF

public void saveDocumentAsTIFF(String fileName,
                               TIFFOptions options)
                        throws IOException,
                               OfficeException

Save the entire document as a multi-page TIFF image to the given String Filename. This method takes a TIFFOptions object as an argument to describe various TIFF options when saving the file.

Parameters:

fileName - The name of the file to write the TIFF image to.

options - Options to use when saving the TIFF file.

Throws:

IOException

OfficeException

saveDocumentAsTIFF

public void saveDocumentAsTIFF(OutputStream outStream,
                               TIFFOptions options)
                        throws IOException,
                               OfficeException

Save the entire document as a multi-page TIFF image the given OutputStream. This method takes a TIFFOptions object as an argument to describe various TIFF options when saving the file.

Parameters:

outStream - The stream to save the image to.

options - Options to use when saving the TIFF file.

Throws:

IOException

OfficeException

print

public int print(Graphics graphics,
                 PageFormat pageFormat,
                 int pageIndex)
          throws PrinterException

Implementation of the print method to make ExcelDocument fulfill the Printable interface.

Specified by:

print in interface Printable

Parameters:

graphics - The printer graphics to draw the page onto

pageFormat - The page format of the target page

pageIndex - The page to print

Returns:

Printable.PAGE_EXISTS if the page exists and was printed, Printable.NO_SUCH_PAGE if the page does not exist

Throws:

PrinterException

setUserFontDirectories

public static void setUserFontDirectories(List<String> userFontDirs)

Set user font directories. Fonts found in these directories will take precedence over fonts found in system font directories Each directory will be searched recursively for font files. Note that this method only needs to be called once before instantiating the first ExcelDocument object as the setting is static and will be used by all subsequent ExcelDocument instances. This setting is used only when the font embedding option is on.

Parameters:

userFontDirs - - List of font directory path strings

getWorkSheetNames

public List<String> getWorkSheetNames()

Returns:

a list of the names of the WorkSheets in the ExcelDocument given in the same order they appear in the ExcelDocument

setWorksheetsToConvert

public void setWorksheetsToConvert(List<String> worksheetNamesToConvert)

Set a list of WorkSheet names to restrict PDF conversion to. That is, if this list is set to be non-null, for each name in the list the worksheet will be appended to the PDF document on the subsequent saveDocument* operation. The order given in the list will be reflected in the output. If a worksheet is named more than once, it will be appended to the output the same number of times it occurs in the list. If a name in the list does not match a Worksheet's name it will be ignored without warning. If the list is empty, no worksheets will be appended to the ouput. If the input is null, all worksheets will be appended to the ouput. Default value is null.

Parameters:

worksheetNamesToConvert - - list of worksheet names to be appended in subsequent saveDocument* call(s), in order given. If null, all worksheets will be appended in original order. Null by default.