Package com.aspose.tasks

Class PdfSaveOptions

java.lang.Object

com.aspose.tasks.SimpleSaveOptions

com.aspose.tasks.SaveOptions

com.aspose.tasks.PdfSaveOptions

public class PdfSaveOptions
extends SaveOptions

Allows to specify additional options when rendering project pages to PDF.

Constructor Summary

Constructors

Constructor	Description
PdfSaveOptions()	Initializes a new instance of the PdfSaveOptions class that can be used to save a document in the SaveFileFormat format.

Method Summary

Modifier and Type	Method	Description
void	copyOutputPropertiesFrom(SaveOptions source)
SaveOptions	deepClone()
int	getCompliance()	Gets a desired compliance level for generated PDF document.
PdfEncryptionDetails	getEncryptionDetails()	Gets an encryption details.
FontSettings	getFontSettings()	Specifies font settings used when rendering project's view.
List<Integer>	getPages()	Gets the list of pages numbers to save when saving project layout to separate files.
IPageSavingCallback	getPageSavingCallback()	Gets a user-defined callback which is used to get an output stream for each rendered page.
boolean	getReduceFooterGap()	Gets a value indicating whether a gap between last task and the footer must be reduced.
boolean	getSaveToSeparateFiles()	Gets a value indicating whether to save project pages to separate files.
int	getTextCompression()	Gets a compression type to be used for all content streams except images.
void	setCompliance(int value)	Sets a desired compliance level for generated PDF document.
void	setEncryptionDetails(PdfEncryptionDetails value)	Sets a encryption details.
void	setPages(List<Integer> value)	Sets the list of pages numbers to save when saving project layout to separate files.
void	setPageSavingCallback(IPageSavingCallback value)	Sets a user-defined callback which is used to get an output stream for each rendered page.
void	setReduceFooterGap(boolean value)	Sets a value indicating whether a gap between last task and the footer must be reduced.
void	setSaveToSeparateFiles(boolean value)	Sets a value indicating whether to save project pages to separate files.
void	setTextCompression(int value)	Sets a compression type to be used for all content streams except images.

Methods inherited from class com.aspose.tasks.SaveOptions

getBarStyles, getCustomPageSize, getDrawNonWorkingTime, getEndDate, getFitContent, getFitTimescaleToEndOfPage, getGridlines, getLegendDrawingOptions, getLegendItems, getMarkCriticalTasks, getNonWorkingTimeColor, getPageCount, getPageSize, getPresentationFormat, getRenderToSinglePage, getRollUpGanttBars, getStartDate, getTextStyles, getTimescale, getTimescaleFitBehavior, getUseGradientBrush, getView, getViewSettings, isPortrait, setBarStyles, setCustomPageSize, setDrawNonWorkingTime, setEndDate, setFitContent, setFitTimescaleToEndOfPage, setGridlines, setLegendDrawingOptions, setLegendItems, setMarkCriticalTasks, setNonWorkingTimeColor, setPageSize, setPortrait, setPresentationFormat, setRenderToSinglePage, setRollUpGanttBars, setStartDate, setTextStyles, setTimescale, setTimescaleFitBehavior, setUseGradientBrush, setView, setViewSettings

Methods inherited from class com.aspose.tasks.SimpleSaveOptions

getSaveFormat, getTasksComparer, getTasksFilter, setTasksComparer, setTasksFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

PdfSaveOptions

public PdfSaveOptions()

Initializes a new instance of the PdfSaveOptions class that can be used to save a document in the SaveFileFormat format.

Method Detail

copyOutputPropertiesFrom

public void copyOutputPropertiesFrom(SaveOptions source)

Parameters:

source -

deepClone

public SaveOptions deepClone()

Returns:

getCompliance

public final int getCompliance()

Gets a desired compliance level for generated PDF document. Default is PdfCompliance.Pdf15.

Returns:

a desired compliance level for generated PDF document.

setCompliance

public final void setCompliance(int value)

Sets a desired compliance level for generated PDF document. Default is PdfCompliance.Pdf15.

Parameters:

value - a desired compliance level for generated PDF document.

getEncryptionDetails

public final PdfEncryptionDetails getEncryptionDetails()

Gets an encryption details. If not set, then no encryption will be performed.

Returns:

an encryption details.

setEncryptionDetails

public final void setEncryptionDetails(PdfEncryptionDetails value)

Sets a encryption details. If not set, then no encryption will be performed.

Parameters:

value - a encryption details.

getFontSettings

public final FontSettings getFontSettings()

Specifies font settings used when rendering project's view.

Returns:

font settings.

getPageSavingCallback

public final IPageSavingCallback getPageSavingCallback()

Gets a user-defined callback which is used to get an output stream for each rendered page. Is applicable when SaveToSeparateFiles(getSaveToSeparateFiles()/setSaveToSeparateFiles(boolean)) option is used.

Returns:

a user-defined callback which is used to get an output stream for each rendered page.

setPageSavingCallback

public final void setPageSavingCallback(IPageSavingCallback value)

Sets a user-defined callback which is used to get an output stream for each rendered page. Is applicable when SaveToSeparateFiles(getSaveToSeparateFiles()/setSaveToSeparateFiles(boolean)) option is used.

Parameters:

value - a user-defined callback which is used to get an output stream for each rendered page.

getPages

public final List<Integer> getPages()

Gets the list of pages numbers to save when saving project layout to separate files.

All pages will be saved if this list is empty.

Returns:

the list of pages numbers to save when saving project layout to separate files.

setPages

public final void setPages(List<Integer> value)

Sets the list of pages numbers to save when saving project layout to separate files.

All pages will be saved if this list is empty.

Parameters:

value - the list of pages numbers to save when saving project layout to separate files.

getReduceFooterGap

public final boolean getReduceFooterGap()

Gets a value indicating whether a gap between last task and the footer must be reduced.

Returns:

a value indicating whether a gap between last task and the footer must be reduced.

setReduceFooterGap

public final void setReduceFooterGap(boolean value)

Sets a value indicating whether a gap between last task and the footer must be reduced.

Parameters:

value - a value indicating whether a gap between last task and the footer must be reduced.

getSaveToSeparateFiles

public final boolean getSaveToSeparateFiles()

Gets a value indicating whether to save project pages to separate files.

Returns:

a value indicating whether to save project pages to separate files.

setSaveToSeparateFiles

public final void setSaveToSeparateFiles(boolean value)

Sets a value indicating whether to save project pages to separate files.

Parameters:

value - a value indicating whether to save project pages to separate files.

getTextCompression

public final int getTextCompression()

Gets a compression type to be used for all content streams except images. Default is PdfTextCompression.Flate.

Returns:

a compression type to be used for all content streams except images.

setTextCompression

public final void setTextCompression(int value)

Sets a compression type to be used for all content streams except images. Default is PdfTextCompression.Flate.

Parameters:

value - a compression type to be used for all content streams except images.