com.qoppa.office

Class ExcelConvertOptions

java.lang.Object

com.qoppa.office.OfficeConvertOptions

com.qoppa.office.ExcelConvertOptions

public class ExcelConvertOptions
extends OfficeConvertOptions

This class is used to set options when converting MS Excel documents to PDF.

Author:

Qoppa Software

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExcelConvertOptions.MaxPageCountReached Exception thrown when the maximum number of pages has been reached (as set by the option) during a conversion.
static class	ExcelConvertOptions.PageOrientation Enum type used to set the Page Orientation Override.
static class	ExcelConvertOptions.PageSize This enum defines some of the common standard paper sizes with their widths and heights stored in points where 72 points equals 1 inch.
static class	ExcelConvertOptions.Paging Enum type used to set the Paging option.

Nested classes/interfaces inherited from class com.qoppa.office.OfficeConvertOptions

OfficeConvertOptions.SubstituteFontRecord

Constructor Summary

Constructors

Constructor and Description
ExcelConvertOptions()

Method Summary

Modifier and Type	Method and Description
boolean	createBookmarks() Returns the value of the option to create bookmarks.
int	getMaxPageCount() Gets the option that controls the maximum page count.
ExcelConvertOptions.PageOrientation	getPageOrientationOverride() Returns the value of the page orientation override option.
Dimension	getPageSizeOverride() Returns the value of the page size override option.
ExcelConvertOptions.Paging	getPaging() Returns the value of the Paging option.
void	setCreateBookmarks(boolean bookmarks) Sets the value of the option to create bookmarks.
void	setMaxPageCount(int maxPageCount) Sets the maximum number of pages when running a conversion.
void	setPageOrientationOverride(ExcelConvertOptions.PageOrientation orientation) Sets a page orientation override that will be applied to all Worksheets.
void	setPageSizeOverride(Dimension pageSize) Sets a page size override that will be applied to all Worksheets.
void	setPaging(ExcelConvertOptions.Paging paging) Sets the paging option.

Methods inherited from class com.qoppa.office.OfficeConvertOptions

getEmbedFonts, getFallbackFontPath, getMaxUndefinedGlyphCountAllowed, getSubstituteFontsMap, setEmbedFonts, setFallbackFontPath, setFontSubstitute, setMaxUndefinedGlyphCountAllowed, setSubstituteFontsMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelConvertOptions

public ExcelConvertOptions()

Method Detail

getPaging

public ExcelConvertOptions.Paging getPaging()

Returns the value of the Paging option. The return value can be Paging.FitToPage, Paging.FitToWidth and Paging.ActualSize.

Returns:

The value of the paging option.

setPaging

public void setPaging(ExcelConvertOptions.Paging paging)

Sets the paging option. The possible values are:

• Paging.FitToPage - Fit the contents into the PDF page by scaling both vertically and horizontally so that both dimensions fit.
• Paging.FitToWidth - Fit the contents into the PDF page by scaling horizontally only.
• Paging.ActualSize - Do not set page scaling, create pages as needed.

Parameters:

paging - The new value of the Paging option.

createBookmarks

public boolean createBookmarks()

Returns the value of the option to create bookmarks.

Returns:

The value of the option to create bookmarks.

setCreateBookmarks

public void setCreateBookmarks(boolean bookmarks)

Sets the value of the option to create bookmarks.

Parameters:

bookmarks - The new value of the option.

getMaxPageCount

public int getMaxPageCount()

Gets the option that controls the maximum page count. When converting an Excel document, the converter will stop after reaching this maximum number of pages.

Returns:

The maximum number of pages.

setMaxPageCount

public void setMaxPageCount(int maxPageCount)

Sets the maximum number of pages when running a conversion. The converter will stop after reaching this number of pages.

Parameters:

maxPageCount - The new value of the maximum number of pages.

getPageSizeOverride

public Dimension getPageSizeOverride()

Returns the value of the page size override option. The width and height of the Dimension returned are specified in points, i.e. 1/72nd inches. If null is returned (the default) then page sizes will be read from the Worksheets. If a Worksheet doesn't have a page size setting then standard Letter is used (612pts X 792pts).

Returns:

The value of the page size override.

setPageSizeOverride

public void setPageSizeOverride(Dimension pageSize)

Sets a page size override that will be applied to all Worksheets. The width and height units are in points, i.e. 1/72nd inches. Set to null to remove a previously set override. Defaults to null which means the page size settings will be read from the Worksheets. If a Worksheet doesn't have a page size setting then standard Letter is used (612pts X 792pts).

Parameters:

pageSize - The page size override.

getPageOrientationOverride

public ExcelConvertOptions.PageOrientation getPageOrientationOverride()

Returns the value of the page orientation override option. Either Landscape or Portrait. Default values is null which indicates to use Worksheet settings.

Returns:

The value of the page orientation override.

setPageOrientationOverride

public void setPageOrientationOverride(ExcelConvertOptions.PageOrientation orientation)

Sets a page orientation override that will be applied to all Worksheets. Set to null to remove a previously set override. Defaults to null which means the page orientation will be read from the Worksheets.

Parameters:

orientation - The page orientation override.