ImageConvertOptions

Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

All Implemented Interfaces: java.io.Serializable

public final class ImageConvertOptions extends CommonConvertOptions<ImageFileType> implements Serializable

Options for conversion to Image file type.

Constructors

Constructor Description
ImageConvertOptions() Initializes new instance of ImageConvertOptions class.

Fields

Field Description
DEFAULT_DPI

Methods

Method Description
getWidth() Desired image width after conversion.
setWidth(int value) Desired image width after conversion.
getHeight() Desired image height after conversion.
setHeight(int value) Desired image height after conversion.
getUsePdf() If true , the input firstly is converted to PDF and after that to desired format.
setUsePdf(boolean value) If true , the input firstly is converted to PDF and after that to desired format.
getHorizontalResolution() Desired image horizontal resolution after conversion.
setHorizontalResolution(int value) Desired image horizontal resolution after conversion.
getVerticalResolution() Desired image vertical resolution after conversion.
setVerticalResolution(int value) Desired image vertical resolution after conversion.
getTiffOptions() Tiff specific convert options.
setTiffOptions(TiffOptions value) Tiff specific convert options.
getPsdOptions() Psd specific convert options.
setPsdOptions(PsdOptions value) Psd specific convert options.
getWebpOptions() Webp specific convert options.
setWebpOptions(WebpOptions value) Webp specific convert options.
getGrayscale() Indicates whether to convert into grayscale image.
setGrayscale(boolean value) Indicates whether to convert into grayscale image.
getRotateAngle() Image rotation angle.
setRotateAngle(int value) Image rotation angle.
getJpegOptions() Jpeg specific convert options.
setJpegOptions(JpegOptions value) Jpeg specific convert options.
getFlipMode() Image flip mode.
setFlipMode(ImageFlipModes value) Image flip mode.
getBrightness() Adjusts image brightness.
setBrightness(int value) Adjusts image brightness.
getContrast() Adjusts image contrast.
setContrast(int value) Adjusts image contrast.
getGamma() Adjusts image gamma.
setGamma(float value) Adjusts image gamma.
getBackgroundColor() Gets background color
setBackgroundColor(System.Drawing.Color backgroundColor) Sets background color where supported by the source format

ImageConvertOptions()

public ImageConvertOptions()

Initializes new instance of ImageConvertOptions class.

DEFAULT_DPI

public static final int DEFAULT_DPI

getWidth()

public final int getWidth()

Desired image width after conversion.

Returns: int

setWidth(int value)

public final void setWidth(int value)

Desired image width after conversion.

Parameters:

Parameter Type Description
value int

getHeight()

public final int getHeight()

Desired image height after conversion.

Returns: int

setHeight(int value)

public final void setHeight(int value)

Desired image height after conversion.

Parameters:

Parameter Type Description
value int

getUsePdf()

public final boolean getUsePdf()

If true , the input firstly is converted to PDF and after that to desired format.

Returns: boolean

setUsePdf(boolean value)

public final void setUsePdf(boolean value)

If true , the input firstly is converted to PDF and after that to desired format.

Parameters:

Parameter Type Description
value boolean

getHorizontalResolution()

public final int getHorizontalResolution()

Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

Returns: int

setHorizontalResolution(int value)

public final void setHorizontalResolution(int value)

Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

Parameters:

Parameter Type Description
value int

getVerticalResolution()

public final int getVerticalResolution()

Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

Returns: int

setVerticalResolution(int value)

public final void setVerticalResolution(int value)

Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.

Parameters:

Parameter Type Description
value int

getTiffOptions()

public final TiffOptions getTiffOptions()

Tiff specific convert options.

Returns: TiffOptions

setTiffOptions(TiffOptions value)

public final void setTiffOptions(TiffOptions value)

Tiff specific convert options.

Parameters:

Parameter Type Description
value TiffOptions

getPsdOptions()

public final PsdOptions getPsdOptions()

Psd specific convert options.

Returns: PsdOptions

setPsdOptions(PsdOptions value)

public final void setPsdOptions(PsdOptions value)

Psd specific convert options.

Parameters:

Parameter Type Description
value PsdOptions

getWebpOptions()

public final WebpOptions getWebpOptions()

Webp specific convert options.

Returns: WebpOptions

setWebpOptions(WebpOptions value)

public final void setWebpOptions(WebpOptions value)

Webp specific convert options.

Parameters:

Parameter Type Description
value WebpOptions

getGrayscale()

public final boolean getGrayscale()

Indicates whether to convert into grayscale image.

Returns: boolean

setGrayscale(boolean value)

public final void setGrayscale(boolean value)

Indicates whether to convert into grayscale image.

Parameters:

Parameter Type Description
value boolean

getRotateAngle()

public final int getRotateAngle()

Image rotation angle.

Returns: int

setRotateAngle(int value)

public final void setRotateAngle(int value)

Image rotation angle.

Parameters:

Parameter Type Description
value int

getJpegOptions()

public final JpegOptions getJpegOptions()

Jpeg specific convert options.

Returns: JpegOptions

setJpegOptions(JpegOptions value)

public final void setJpegOptions(JpegOptions value)

Jpeg specific convert options.

Parameters:

Parameter Type Description
value JpegOptions

getFlipMode()

public final ImageFlipModes getFlipMode()

Image flip mode.

Returns: ImageFlipModes

setFlipMode(ImageFlipModes value)

public final void setFlipMode(ImageFlipModes value)

Image flip mode.

Parameters:

Parameter Type Description
value ImageFlipModes

getBrightness()

public final int getBrightness()

Adjusts image brightness.

Returns: int

setBrightness(int value)

public final void setBrightness(int value)

Adjusts image brightness.

Parameters:

Parameter Type Description
value int

getContrast()

public final int getContrast()

Adjusts image contrast.

Returns: int

setContrast(int value)

public final void setContrast(int value)

Adjusts image contrast.

Parameters:

Parameter Type Description
value int

getGamma()

public final float getGamma()

Adjusts image gamma.

Returns: float

setGamma(float value)

public final void setGamma(float value)

Adjusts image gamma.

Parameters:

Parameter Type Description
value float

getBackgroundColor()

public System.Drawing.Color getBackgroundColor()

Gets background color

Returns: com.aspose.ms.System.Drawing.Color - background color

setBackgroundColor(System.Drawing.Color backgroundColor)

public void setBackgroundColor(System.Drawing.Color backgroundColor)

Sets background color where supported by the source format

Parameters:

Parameter Type Description
backgroundColor com.aspose.ms.System.Drawing.Color background color