Package com.groupdocs.cloud.viewer.model

Class ImageOptions

java.lang.Object

com.groupdocs.cloud.viewer.model.RenderOptions

com.groupdocs.cloud.viewer.model.ImageOptions

public class ImageOptions
extends RenderOptions

Options for rendering document into image

Constructor Summary

Constructors

Constructor	Description
ImageOptions()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ImageOptions	extractText(Boolean extractText)
Boolean	getExtractText()	When enabled Viewer will extract text when it's possible (e.g.
Integer	getHeight()	Allows to specify output image height.
Integer	getJpegQuality()	Allows to specify quality when rendering as JPG.
Integer	getMaxHeight()	Max height of an output image in pixels
Integer	getMaxWidth()	Max width of an output image in pixels
Integer	getWidth()	Allows to specify output image width.
int	hashCode()
ImageOptions	height(Integer height)
ImageOptions	jpegQuality(Integer jpegQuality)
ImageOptions	maxHeight(Integer maxHeight)
ImageOptions	maxWidth(Integer maxWidth)
void	setExtractText(Boolean extractText)
void	setHeight(Integer height)
void	setJpegQuality(Integer jpegQuality)
void	setMaxHeight(Integer maxHeight)
void	setMaxWidth(Integer maxWidth)
void	setWidth(Integer width)
String	toString()
ImageOptions	width(Integer width)

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

ImageOptions

public ImageOptions()

Method Detail

width

public ImageOptions width(Integer width)

getWidth

public Integer getWidth()

Allows to specify output image width. Specify image width in case when you want to change output image dimensions. When Width has value and Height value is 0 then Height value will be calculated to save image proportions.

Returns:

width

setWidth

public void setWidth(Integer width)

height

public ImageOptions height(Integer height)

getHeight

public Integer getHeight()

Allows to specify output image height. Specify image height in case when you want to change output image dimensions. When Height has value and Width value is 0 then Width value will be calculated to save image proportions.

Returns:

height

setHeight

public void setHeight(Integer height)

extractText

public ImageOptions extractText(Boolean extractText)

getExtractText

public Boolean getExtractText()

When enabled Viewer will extract text when it's possible (e.g. raster formats don't have text layer) and return it in the viewing result. This option might be useful when you want to add selectable text layer over the image.

Returns:

extractText

setExtractText

public void setExtractText(Boolean extractText)

jpegQuality

public ImageOptions jpegQuality(Integer jpegQuality)

getJpegQuality

public Integer getJpegQuality()

Allows to specify quality when rendering as JPG. Valid values are between 1 and 100. Default value is 90.

Returns:

jpegQuality

setJpegQuality

public void setJpegQuality(Integer jpegQuality)

maxWidth

public ImageOptions maxWidth(Integer maxWidth)

getMaxWidth

public Integer getMaxWidth()

Max width of an output image in pixels

Returns:

maxWidth

setMaxWidth

public void setMaxWidth(Integer maxWidth)

maxHeight

public ImageOptions maxHeight(Integer maxHeight)

getMaxHeight

public Integer getMaxHeight()

Max height of an output image in pixels

Returns:

maxHeight

setMaxHeight

public void setMaxHeight(Integer maxHeight)

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