Package com.groupdocs.cloud.viewer.model

Class HtmlOptions

java.lang.Object

com.groupdocs.cloud.viewer.model.RenderOptions

com.groupdocs.cloud.viewer.model.HtmlOptions

public class HtmlOptions
extends RenderOptions

Options for rendering document into HTML

Constructor Summary

Constructors

Constructor	Description
HtmlOptions()

Method Summary

Modifier and Type	Method	Description
HtmlOptions	addFontsToExcludeItem(String fontsToExcludeItem)
boolean	equals(Object o)
HtmlOptions	excludeFonts(Boolean excludeFonts)
HtmlOptions	externalResources(Boolean externalResources)
HtmlOptions	fontsToExclude(List<String> fontsToExclude)
HtmlOptions	forPrinting(Boolean forPrinting)
Boolean	getExcludeFonts()	When enabled prevents adding any fonts into HTML document
Boolean	getExternalResources()	Controls output HTML document resources (styles, images and fonts) linking.
List<String>	getFontsToExclude()	This option is supported for presentations only.
Boolean	getForPrinting()	Indicates whether to optimize output HTML for printing.
Integer	getImageHeight()	The height of an output image in pixels.
Integer	getImageMaxHeight()	Max height of an output image in pixels.
Integer	getImageMaxWidth()	Max width of an output image in pixels.
Integer	getImageWidth()	The width of the output image in pixels.
Boolean	getIsResponsive()	Indicates whether rendering will provide responsive web pages, that look well on different device types.
Boolean	getMinify()	Enables HTML content and HTML resources minification
Boolean	getRemoveJavaScript()	Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts.
Boolean	getRenderToSinglePage()	Enables HTML content will be rendered to single page
String	getResourcePath()	Path for the HTML resources (styles, images and fonts).
int	hashCode()
HtmlOptions	imageHeight(Integer imageHeight)
HtmlOptions	imageMaxHeight(Integer imageMaxHeight)
HtmlOptions	imageMaxWidth(Integer imageMaxWidth)
HtmlOptions	imageWidth(Integer imageWidth)
HtmlOptions	isResponsive(Boolean isResponsive)
HtmlOptions	minify(Boolean minify)
HtmlOptions	removeJavaScript(Boolean removeJavaScript)
HtmlOptions	renderToSinglePage(Boolean renderToSinglePage)
HtmlOptions	resourcePath(String resourcePath)
void	setExcludeFonts(Boolean excludeFonts)
void	setExternalResources(Boolean externalResources)
void	setFontsToExclude(List<String> fontsToExclude)
void	setForPrinting(Boolean forPrinting)
void	setImageHeight(Integer imageHeight)
void	setImageMaxHeight(Integer imageMaxHeight)
void	setImageMaxWidth(Integer imageMaxWidth)
void	setImageWidth(Integer imageWidth)
void	setIsResponsive(Boolean isResponsive)
void	setMinify(Boolean minify)
void	setRemoveJavaScript(Boolean removeJavaScript)
void	setRenderToSinglePage(Boolean renderToSinglePage)
void	setResourcePath(String resourcePath)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from class com.groupdocs.cloud.viewer.model.RenderOptions

addPageRotationsItem, addPagesToRenderItem, archiveOptions, cadOptions, countPagesToRender, defaultEncoding, defaultFontName, detectEncoding, emailOptions, getArchiveOptions, getCadOptions, getCountPagesToRender, getDefaultEncoding, getDefaultFontName, getDetectEncoding, getEmailOptions, getMailStorageOptions, getOutlookOptions, getPageRotations, getPagesToRender, getPdfDocumentOptions, getProjectManagementOptions, getRenderComments, getRenderHiddenPages, getRenderNotes, getSpreadsheetOptions, getStartPageNumber, getTextOptions, getVisioRenderingOptions, getWebDocumentOptions, getWordProcessingOptions, mailStorageOptions, outlookOptions, pageRotations, pagesToRender, pdfDocumentOptions, projectManagementOptions, renderComments, renderHiddenPages, renderNotes, setArchiveOptions, setCadOptions, setCountPagesToRender, setDefaultEncoding, setDefaultFontName, setDetectEncoding, setEmailOptions, setMailStorageOptions, setOutlookOptions, setPageRotations, setPagesToRender, setPdfDocumentOptions, setProjectManagementOptions, setRenderComments, setRenderHiddenPages, setRenderNotes, setSpreadsheetOptions, setStartPageNumber, setTextOptions, setVisioRenderingOptions, setWebDocumentOptions, setWordProcessingOptions, spreadsheetOptions, startPageNumber, textOptions, visioRenderingOptions, webDocumentOptions, wordProcessingOptions

Constructor Detail

HtmlOptions

public HtmlOptions()

Method Detail

externalResources

public HtmlOptions externalResources(Boolean externalResources)

getExternalResources

public Boolean getExternalResources()

Controls output HTML document resources (styles, images and fonts) linking. By default this option is disabled and all the resources are embedded into HTML document.

Returns:

externalResources

setExternalResources

public void setExternalResources(Boolean externalResources)

resourcePath

public HtmlOptions resourcePath(String resourcePath)

getResourcePath

public String getResourcePath()

Path for the HTML resources (styles, images and fonts). For example when resource path is http://example.com/api/pages/{page-number}/resources/{resource-name} the {page-number} and {resource-name} templates will be replaced with page number and resource name accordingly. This option is ignored when ExternalResources option is disabled.

Returns:

resourcePath

setResourcePath

public void setResourcePath(String resourcePath)

isResponsive

public HtmlOptions isResponsive(Boolean isResponsive)

getIsResponsive

public Boolean getIsResponsive()

Indicates whether rendering will provide responsive web pages, that look well on different device types. Default value is false.

Returns:

isResponsive

setIsResponsive

public void setIsResponsive(Boolean isResponsive)

minify

public HtmlOptions minify(Boolean minify)

getMinify

public Boolean getMinify()

Enables HTML content and HTML resources minification

Returns:

minify

setMinify

public void setMinify(Boolean minify)

excludeFonts

public HtmlOptions excludeFonts(Boolean excludeFonts)

getExcludeFonts

public Boolean getExcludeFonts()

When enabled prevents adding any fonts into HTML document

Returns:

excludeFonts

setExcludeFonts

public void setExcludeFonts(Boolean excludeFonts)

fontsToExclude

public HtmlOptions fontsToExclude(List<String> fontsToExclude)

addFontsToExcludeItem

public HtmlOptions addFontsToExcludeItem(String fontsToExcludeItem)

getFontsToExclude

public List<String> getFontsToExclude()

This option is supported for presentations only. The list of font names, to exclude from HTML document

Returns:

fontsToExclude

setFontsToExclude

public void setFontsToExclude(List<String> fontsToExclude)

forPrinting

public HtmlOptions forPrinting(Boolean forPrinting)

getForPrinting

public Boolean getForPrinting()

Indicates whether to optimize output HTML for printing.

Returns:

forPrinting

setForPrinting

public void setForPrinting(Boolean forPrinting)

imageHeight

public HtmlOptions imageHeight(Integer imageHeight)

getImageHeight

public Integer getImageHeight()

The height of an output image in pixels. (When converting single image to HTML only)

Returns:

imageHeight

setImageHeight

public void setImageHeight(Integer imageHeight)

imageWidth

public HtmlOptions imageWidth(Integer imageWidth)

getImageWidth

public Integer getImageWidth()

The width of the output image in pixels. (When converting single image to HTML only)

Returns:

imageWidth

setImageWidth

public void setImageWidth(Integer imageWidth)

imageMaxHeight

public HtmlOptions imageMaxHeight(Integer imageMaxHeight)

getImageMaxHeight

public Integer getImageMaxHeight()

Max height of an output image in pixels. (When converting single image to HTML only)

Returns:

imageMaxHeight

setImageMaxHeight

public void setImageMaxHeight(Integer imageMaxHeight)

imageMaxWidth

public HtmlOptions imageMaxWidth(Integer imageMaxWidth)

getImageMaxWidth

public Integer getImageMaxWidth()

Max width of an output image in pixels. (When converting single image to HTML only)

Returns:

imageMaxWidth

setImageMaxWidth

public void setImageMaxWidth(Integer imageMaxWidth)

renderToSinglePage

public HtmlOptions renderToSinglePage(Boolean renderToSinglePage)

getRenderToSinglePage

public Boolean getRenderToSinglePage()

Enables HTML content will be rendered to single page

Returns:

renderToSinglePage

setRenderToSinglePage

public void setRenderToSinglePage(Boolean renderToSinglePage)

removeJavaScript

public HtmlOptions removeJavaScript(Boolean removeJavaScript)

getRemoveJavaScript

public Boolean getRemoveJavaScript()

Allows to remove the JavaScript source code from the links in resultant HTML documents, when rendering input documents, which have the scripts. By default is enabled (true).

Returns:

removeJavaScript

setRemoveJavaScript

public void setRemoveJavaScript(Boolean removeJavaScript)

equals

public boolean equals(Object o)

Overrides:

equals in class RenderOptions

hashCode

public int hashCode()

Overrides:

hashCode in class RenderOptions

toString

public String toString()

Overrides:

toString in class RenderOptions