Package com.groupdocs.cloud.viewer.model

Class RenderOptions

java.lang.Object

com.groupdocs.cloud.viewer.model.RenderOptions

Direct Known Subclasses:

HtmlOptions, ImageOptions, PdfOptions

public class RenderOptions
extends Object

Rendering options

Constructor Summary

Constructors

Constructor	Description
RenderOptions()

Method Summary

Modifier and Type	Method	Description
RenderOptions	addPageRotationsItem(PageRotation pageRotationsItem)
RenderOptions	addPagesToRenderItem(Integer pagesToRenderItem)
RenderOptions	archiveOptions(ArchiveOptions archiveOptions)
RenderOptions	cadOptions(CadOptions cadOptions)
RenderOptions	countPagesToRender(Integer countPagesToRender)
RenderOptions	defaultEncoding(String defaultEncoding)
RenderOptions	defaultFontName(String defaultFontName)
RenderOptions	detectEncoding(Boolean detectEncoding)
RenderOptions	emailOptions(EmailOptions emailOptions)
boolean	equals(Object o)
ArchiveOptions	getArchiveOptions()	Rendering options for Archive source file formats
CadOptions	getCadOptions()	Rendering options for CAD source file formats CAD file formats include files with extensions: .dwg, .dxf, .dgn, .ifc, .stl
Integer	getCountPagesToRender()	Count pages which should be rendered
String	getDefaultEncoding()	Default encoding for the plain text files such as .csv, .txt and .eml files when encoding is not specified in header
String	getDefaultFontName()	Default font name may be specified in following cases: - You want to generally specify the default font to fall back on, if particular font in the document cannot be found during rendering.
Boolean	getDetectEncoding()	This option enables TXT, TSV, and CSV files encoding detection.
EmailOptions	getEmailOptions()	Rendering options for Email source file formats Email file formats include files with extensions: .msg, .eml, .emlx, .ifc, .stl
MailStorageOptions	getMailStorageOptions()	Rendering options for Mail storage (Lotus Notes, MBox) data files.
OutlookOptions	getOutlookOptions()	Rendering options for Outlook source file formats
List<PageRotation>	getPageRotations()	Page rotations
List<Integer>	getPagesToRender()	Pages list to render.
PdfDocumentOptions	getPdfDocumentOptions()	Rendering options for PDF source file formats
ProjectManagementOptions	getProjectManagementOptions()	Rendering options for MS Project source file formats Project file formats include files with extensions: .mpt, .mpp
Boolean	getRenderComments()	When enabled comments will be rendered to the output
Boolean	getRenderHiddenPages()	When enabled hidden pages, sheets or slides will be rendered to the output
Boolean	getRenderNotes()	When enabled notes will be rendered to the output
SpreadsheetOptions	getSpreadsheetOptions()	Rendering options for Spreadsheet source file formats Spreadsheet file formats include files with extensions: .xls, .xlsx, .xlsm, .xlsb, .csv, .ods, .ots, .xltx, .xltm, .tsv
Integer	getStartPageNumber()	Page number from which rendering should be started
TextOptions	getTextOptions()	Rendering options for Text source file formats
VisioRenderingOptions	getVisioRenderingOptions()	Rendering options for Visio source file formats
WebDocumentOptions	getWebDocumentOptions()	This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.
WordProcessingOptions	getWordProcessingOptions()	Rendering options for WordProcessing source file formats
int	hashCode()
RenderOptions	mailStorageOptions(MailStorageOptions mailStorageOptions)
RenderOptions	outlookOptions(OutlookOptions outlookOptions)
RenderOptions	pageRotations(List<PageRotation> pageRotations)
RenderOptions	pagesToRender(List<Integer> pagesToRender)
RenderOptions	pdfDocumentOptions(PdfDocumentOptions pdfDocumentOptions)
RenderOptions	projectManagementOptions(ProjectManagementOptions projectManagementOptions)
RenderOptions	renderComments(Boolean renderComments)
RenderOptions	renderHiddenPages(Boolean renderHiddenPages)
RenderOptions	renderNotes(Boolean renderNotes)
void	setArchiveOptions(ArchiveOptions archiveOptions)
void	setCadOptions(CadOptions cadOptions)
void	setCountPagesToRender(Integer countPagesToRender)
void	setDefaultEncoding(String defaultEncoding)
void	setDefaultFontName(String defaultFontName)
void	setDetectEncoding(Boolean detectEncoding)
void	setEmailOptions(EmailOptions emailOptions)
void	setMailStorageOptions(MailStorageOptions mailStorageOptions)
void	setOutlookOptions(OutlookOptions outlookOptions)
void	setPageRotations(List<PageRotation> pageRotations)
void	setPagesToRender(List<Integer> pagesToRender)
void	setPdfDocumentOptions(PdfDocumentOptions pdfDocumentOptions)
void	setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)
void	setRenderComments(Boolean renderComments)
void	setRenderHiddenPages(Boolean renderHiddenPages)
void	setRenderNotes(Boolean renderNotes)
void	setSpreadsheetOptions(SpreadsheetOptions spreadsheetOptions)
void	setStartPageNumber(Integer startPageNumber)
void	setTextOptions(TextOptions textOptions)
void	setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)
void	setWebDocumentOptions(WebDocumentOptions webDocumentOptions)
void	setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)
RenderOptions	spreadsheetOptions(SpreadsheetOptions spreadsheetOptions)
RenderOptions	startPageNumber(Integer startPageNumber)
RenderOptions	textOptions(TextOptions textOptions)
String	toString()
RenderOptions	visioRenderingOptions(VisioRenderingOptions visioRenderingOptions)
RenderOptions	webDocumentOptions(WebDocumentOptions webDocumentOptions)
RenderOptions	wordProcessingOptions(WordProcessingOptions wordProcessingOptions)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RenderOptions

public RenderOptions()

Method Detail

startPageNumber

public RenderOptions startPageNumber(Integer startPageNumber)

getStartPageNumber

public Integer getStartPageNumber()

Page number from which rendering should be started

Returns:

startPageNumber

setStartPageNumber

public void setStartPageNumber(Integer startPageNumber)

countPagesToRender

public RenderOptions countPagesToRender(Integer countPagesToRender)

getCountPagesToRender

public Integer getCountPagesToRender()

Count pages which should be rendered

Returns:

countPagesToRender

setCountPagesToRender

public void setCountPagesToRender(Integer countPagesToRender)

pagesToRender

public RenderOptions pagesToRender(List<Integer> pagesToRender)

addPagesToRenderItem

public RenderOptions addPagesToRenderItem(Integer pagesToRenderItem)

getPagesToRender

public List<Integer> getPagesToRender()

Pages list to render. Ignored, if StartPageNumber and CountPagesToRender are provided

Returns:

pagesToRender

setPagesToRender

public void setPagesToRender(List<Integer> pagesToRender)

pageRotations

public RenderOptions pageRotations(List<PageRotation> pageRotations)

addPageRotationsItem

public RenderOptions addPageRotationsItem(PageRotation pageRotationsItem)

getPageRotations

public List<PageRotation> getPageRotations()

Page rotations

Returns:

pageRotations

setPageRotations

public void setPageRotations(List<PageRotation> pageRotations)

defaultFontName

public RenderOptions defaultFontName(String defaultFontName)

getDefaultFontName

public String getDefaultFontName()

Default font name may be specified in following cases: - You want to generally specify the default font to fall back on, if particular font in the document cannot be found during rendering. - Your document uses fonts, that contain non-English characters and you want to make sure any missing font is replaced with one that has the same character set available.

Returns:

defaultFontName

setDefaultFontName

public void setDefaultFontName(String defaultFontName)

defaultEncoding

public RenderOptions defaultEncoding(String defaultEncoding)

getDefaultEncoding

public String getDefaultEncoding()

Default encoding for the plain text files such as .csv, .txt and .eml files when encoding is not specified in header

Returns:

defaultEncoding

setDefaultEncoding

public void setDefaultEncoding(String defaultEncoding)

detectEncoding

public RenderOptions detectEncoding(Boolean detectEncoding)

getDetectEncoding

public Boolean getDetectEncoding()

This option enables TXT, TSV, and CSV files encoding detection. In case the encoding can't be detected the DefaultEncoding is used.

Returns:

detectEncoding

setDetectEncoding

public void setDetectEncoding(Boolean detectEncoding)

renderComments

public RenderOptions renderComments(Boolean renderComments)

getRenderComments

public Boolean getRenderComments()

When enabled comments will be rendered to the output

Returns:

renderComments

setRenderComments

public void setRenderComments(Boolean renderComments)

renderNotes

public RenderOptions renderNotes(Boolean renderNotes)

getRenderNotes

public Boolean getRenderNotes()

When enabled notes will be rendered to the output

Returns:

renderNotes

setRenderNotes

public void setRenderNotes(Boolean renderNotes)

renderHiddenPages

public RenderOptions renderHiddenPages(Boolean renderHiddenPages)

getRenderHiddenPages

public Boolean getRenderHiddenPages()

When enabled hidden pages, sheets or slides will be rendered to the output

Returns:

renderHiddenPages

setRenderHiddenPages

public void setRenderHiddenPages(Boolean renderHiddenPages)

spreadsheetOptions

public RenderOptions spreadsheetOptions(SpreadsheetOptions spreadsheetOptions)

getSpreadsheetOptions

public SpreadsheetOptions getSpreadsheetOptions()

Rendering options for Spreadsheet source file formats Spreadsheet file formats include files with extensions: .xls, .xlsx, .xlsm, .xlsb, .csv, .ods, .ots, .xltx, .xltm, .tsv

Returns:

spreadsheetOptions

setSpreadsheetOptions

public void setSpreadsheetOptions(SpreadsheetOptions spreadsheetOptions)

cadOptions

public RenderOptions cadOptions(CadOptions cadOptions)

getCadOptions

public CadOptions getCadOptions()

Rendering options for CAD source file formats CAD file formats include files with extensions: .dwg, .dxf, .dgn, .ifc, .stl

Returns:

cadOptions

setCadOptions

public void setCadOptions(CadOptions cadOptions)

emailOptions

public RenderOptions emailOptions(EmailOptions emailOptions)

getEmailOptions

public EmailOptions getEmailOptions()

Rendering options for Email source file formats Email file formats include files with extensions: .msg, .eml, .emlx, .ifc, .stl

Returns:

emailOptions

setEmailOptions

public void setEmailOptions(EmailOptions emailOptions)

projectManagementOptions

public RenderOptions projectManagementOptions(ProjectManagementOptions projectManagementOptions)

getProjectManagementOptions

public ProjectManagementOptions getProjectManagementOptions()

Rendering options for MS Project source file formats Project file formats include files with extensions: .mpt, .mpp

Returns:

projectManagementOptions

setProjectManagementOptions

public void setProjectManagementOptions(ProjectManagementOptions projectManagementOptions)

pdfDocumentOptions

public RenderOptions pdfDocumentOptions(PdfDocumentOptions pdfDocumentOptions)

getPdfDocumentOptions

public PdfDocumentOptions getPdfDocumentOptions()

Rendering options for PDF source file formats

Returns:

pdfDocumentOptions

setPdfDocumentOptions

public void setPdfDocumentOptions(PdfDocumentOptions pdfDocumentOptions)

wordProcessingOptions

public RenderOptions wordProcessingOptions(WordProcessingOptions wordProcessingOptions)

getWordProcessingOptions

public WordProcessingOptions getWordProcessingOptions()

Rendering options for WordProcessing source file formats

Returns:

wordProcessingOptions

setWordProcessingOptions

public void setWordProcessingOptions(WordProcessingOptions wordProcessingOptions)

outlookOptions

public RenderOptions outlookOptions(OutlookOptions outlookOptions)

getOutlookOptions

public OutlookOptions getOutlookOptions()

Rendering options for Outlook source file formats

Returns:

outlookOptions

setOutlookOptions

public void setOutlookOptions(OutlookOptions outlookOptions)

archiveOptions

public RenderOptions archiveOptions(ArchiveOptions archiveOptions)

getArchiveOptions

public ArchiveOptions getArchiveOptions()

Rendering options for Archive source file formats

Returns:

archiveOptions

setArchiveOptions

public void setArchiveOptions(ArchiveOptions archiveOptions)

textOptions

public RenderOptions textOptions(TextOptions textOptions)

getTextOptions

public TextOptions getTextOptions()

Rendering options for Text source file formats

Returns:

textOptions

setTextOptions

public void setTextOptions(TextOptions textOptions)

mailStorageOptions

public RenderOptions mailStorageOptions(MailStorageOptions mailStorageOptions)

getMailStorageOptions

public MailStorageOptions getMailStorageOptions()

Rendering options for Mail storage (Lotus Notes, MBox) data files.

Returns:

mailStorageOptions

setMailStorageOptions

public void setMailStorageOptions(MailStorageOptions mailStorageOptions)

visioRenderingOptions

public RenderOptions visioRenderingOptions(VisioRenderingOptions visioRenderingOptions)

getVisioRenderingOptions

public VisioRenderingOptions getVisioRenderingOptions()

Rendering options for Visio source file formats

Returns:

visioRenderingOptions

setVisioRenderingOptions

public void setVisioRenderingOptions(VisioRenderingOptions visioRenderingOptions)

webDocumentOptions

public RenderOptions webDocumentOptions(WebDocumentOptions webDocumentOptions)

getWebDocumentOptions

public WebDocumentOptions getWebDocumentOptions()

This rendering options enables you to customize the appearance of the output HTML/PDF/PNG/JPEG when rendering Web documents.

Returns:

webDocumentOptions

setWebDocumentOptions

public void setWebDocumentOptions(WebDocumentOptions webDocumentOptions)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object