ImageCompressionOptions

Inheritance: java.lang.Object

public class ImageCompressionOptions

Class contains set options for image compression.

Constructors

ConstructorDescription
ImageCompressionOptions()

Methods

MethodDescription
isCompressImages()If this flag is set to true images will be compressed in the document.
setCompressImages(boolean value)If this flag is set to true images will be compressed in the document.
getResizeImages()If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter.
setResizeImages(boolean value)If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter.
getImageQuality()Specifies level of image compression when CompressIamges flag is used.
setImageQuality(int value)Specifies level of image compression when CompressIamges flag is used.
getMaxResolution()Specifies maximum resolution of images.
setMaxResolution(int value)Specifies maximum resolution of images.
getVersion()Version of compression algorithm.
setVersion(int value)Version of compression algorithm.
getEncoding()Gets or sets encoding used to store images.
setEncoding(int value)Gets or sets encoding used to store images.

ImageCompressionOptions()

public ImageCompressionOptions()

isCompressImages()

public final boolean isCompressImages()

If this flag is set to true images will be compressed in the document. compression level is specfied with ImageQuality property.

Returns: boolean - boolean value

setCompressImages(boolean value)

public final void setCompressImages(boolean value)

If this flag is set to true images will be compressed in the document. compression level is specfied with ImageQuality property.

Parameters:

ParameterTypeDescription
valuebooleanboolean value

getResizeImages()

public final boolean getResizeImages()

If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter.

Returns: boolean - boolean value

setResizeImages(boolean value)

public final void setResizeImages(boolean value)

If this flag set to true and CompressImages is true images will be resized if image resoultion is greater then specified MaxResolution parameter.

Parameters:

ParameterTypeDescription
valuebooleanboolean value

getImageQuality()

public final int getImageQuality()

Specifies level of image compression when CompressIamges flag is used.

Returns: int - int value

setImageQuality(int value)

public final void setImageQuality(int value)

Specifies level of image compression when CompressIamges flag is used.

Parameters:

ParameterTypeDescription
valueintint value

getMaxResolution()

public final int getMaxResolution()

Specifies maximum resolution of images. If image has higher resolition it will be scaled

Returns: int - int value

setMaxResolution(int value)

public final void setMaxResolution(int value)

Specifies maximum resolution of images. If image has higher resolition it will be scaled

Parameters:

ParameterTypeDescription
valueintint value

getVersion()

public final int getVersion()

Version of compression algorithm. Possible values are: 1. standard compression, 2. fast (improved compression which is faster then standard but may be applicable not for all images), 3. mixed (standard compression is applied to images which can not be compressed by faster algorithm, this may give best compression but more slow then “fast” algorithm. Version “Fast” is not applicable for resizing images (standard method will be used). Default is “Standard”.

Returns: int - int value

setVersion(int value)

public final void setVersion(int value)

Version of compression algorithm. Possible values are: 1. standard compression, 2. fast (improved compression which is faster then standard but may be applicable not for all images), 3. mixed (standard compression is applied to images which can not be compressed by faster algorithm, this may give best compression but more slow then “fast” algorithm. Version “Fast” is not applicable for resizing images (standard method will be used). Default is “Standard”.

Parameters:

ParameterTypeDescription
valueintint value

getEncoding()

public final int getEncoding()

Gets or sets encoding used to store images.

Returns: int - ImageEncoding element

setEncoding(int value)

public final void setEncoding(int value)

Gets or sets encoding used to store images.

Parameters:

ParameterTypeDescription
valueintImageEncoding element