ImageSaveOptions

Inheritance: java.lang.Object, com.aspose.page.SaveOptions

public class ImageSaveOptions extends SaveOptions

This class contains options necessary for managing conversion process.

Constructors

ConstructorDescription
ImageSaveOptions()Initialize new instance of ImageSaveOptions class with default values for flags suppressErrors (true) and debug (false).
ImageSaveOptions(ImageFormat imageFormat)Initializes new instance of ImageSaveOptions with specified image format.
ImageSaveOptions(Dimension size)Initializes new instance of ImageSaveOptions with specified size of the image.
ImageSaveOptions(Dimension size, ImageFormat imageFormat)Initializes new instance of ImageSaveOptions with specified size of the image and image format.
ImageSaveOptions(ImageFormat imageFormat, boolean supressErrors)Initializes new instance of ImageSaveOptions with specified image format and suppressErrors flag.
ImageSaveOptions(Dimension size, boolean supressErrors)Initializes new instance of ImageSaveOptions with specified size of the image and suppressErrors flag.
ImageSaveOptions(Dimension size, ImageFormat imageFormat, boolean supressErrors)Initializes new instance of ImageSaveOptions with specified size of the image, image format and suppressErrors flag.
ImageSaveOptions(boolean supressErrors)Initialize new instance of ImageSaveOptions class with default values for flag debug (false).

Methods

MethodDescription
equals(Object arg0)
getAdditionalFontsFolders()Returns additional fonts folders where converter should find fonts for input document.
getClass()
getExceptions()Returns a list of non-critical errors.
getImageFormat()Gets an image format for resulting image.
getJpegQualityLevel()Returns the value specifying the level of compression for an image.
getResolution()Returns the resolution of the resulting image.
getSize()Gets a size of the page or image.
getSmoothingMode()Gets smoothing mode.
getTryJoinImageFragments()Indicates whether the library will try to join image fragments.
hashCode()
isDebug()Gets the flag that allows output of warnings and messages during conversion.
isSupressErrors()Returns a value indicating whether errors will be suppressed during conversion.
notify()
notifyAll()
setAdditionalFontsFolders(String[] fontsFolders)Specifies additional fonts folders where converter should find fonts for input document.
setDebug(boolean debug)Specifies the flag that allows output of warnings and messages during conversion.
setImageFormat(ImageFormat imageFormat)Specifies an image format for resulting image.
setJpegQualityLevel(int value)Sets the value specifying the level of compression for an image.
setResolution(float resolution)Specifies resolution of resulting image.
setSize(Dimension size)Specifies a size of the page or image.
setSmoothingMode(SmoothingMode smoothingMode)Sets smoothing mode.
setSupressErrors(boolean supressErrors)Specifies the flag that indicates whether errors will be suppressed during conversion.
setTryJoinImageFragments(boolean tryJoinImageFragments)Specifies if the library should try to join image fragments.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

ImageSaveOptions()

public ImageSaveOptions()

Initialize new instance of ImageSaveOptions class with default values for flags suppressErrors (true) and debug (false).

ImageSaveOptions(ImageFormat imageFormat)

public ImageSaveOptions(ImageFormat imageFormat)

Initializes new instance of ImageSaveOptions with specified image format.

Parameters:

ParameterTypeDescription
imageFormatImageFormatThe format of the image.

ImageSaveOptions(Dimension size)

public ImageSaveOptions(Dimension size)

Initializes new instance of ImageSaveOptions with specified size of the image.

Parameters:

ParameterTypeDescription
sizejava.awt.DimensionImage size.

ImageSaveOptions(Dimension size, ImageFormat imageFormat)

public ImageSaveOptions(Dimension size, ImageFormat imageFormat)

Initializes new instance of ImageSaveOptions with specified size of the image and image format.

Parameters:

ParameterTypeDescription
sizejava.awt.DimensionImage size.
imageFormatImageFormatFormat of the image.

ImageSaveOptions(ImageFormat imageFormat, boolean supressErrors)

public ImageSaveOptions(ImageFormat imageFormat, boolean supressErrors)

Initializes new instance of ImageSaveOptions with specified image format and suppressErrors flag.

Parameters:

ParameterTypeDescription
imageFormatImageFormatFormat of the image.
supressErrorsbooleanIf true conversion will be continued despite of non-critical errors.

ImageSaveOptions(Dimension size, boolean supressErrors)

public ImageSaveOptions(Dimension size, boolean supressErrors)

Initializes new instance of ImageSaveOptions with specified size of the image and suppressErrors flag.

Parameters:

ParameterTypeDescription
sizejava.awt.DimensionImage size.
supressErrorsbooleanIf true conversion will be continued despite of non-critical errors.

ImageSaveOptions(Dimension size, ImageFormat imageFormat, boolean supressErrors)

public ImageSaveOptions(Dimension size, ImageFormat imageFormat, boolean supressErrors)

Initializes new instance of ImageSaveOptions with specified size of the image, image format and suppressErrors flag.

Parameters:

ParameterTypeDescription
sizejava.awt.DimensionImage size.
imageFormatImageFormatFormat of the image.
supressErrorsbooleanIf true conversion will be continued despite of non-critical errors.

ImageSaveOptions(boolean supressErrors)

public ImageSaveOptions(boolean supressErrors)

Initialize new instance of ImageSaveOptions class with default values for flag debug (false).

Parameters:

ParameterTypeDescription
supressErrorsbooleanIf true conversion will be continued despite of non-critical errors.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getAdditionalFontsFolders()

public String[] getAdditionalFontsFolders()

Returns additional fonts folders where converter should find fonts for input document. Default folder is standard fonts folder where OS finds fonts for internal needs.

Returns: java.lang.String[] - An array of fonts folders.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getExceptions()

public List<Exception> getExceptions()

Returns a list of non-critical errors.

Returns: java.util.List<java.lang.Exception> - Exceptions list

getImageFormat()

public ImageFormat getImageFormat()

Gets an image format for resulting image.

Returns: ImageFormat - An output image format.

getJpegQualityLevel()

public int getJpegQualityLevel()

Returns the value specifying the level of compression for an image. Available values are 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. 0 value results in lowest quality image, while 100 results in highest.

Returns: int - The value specifying the level of compression for an image.

getResolution()

public float getResolution()

Returns the resolution of the resulting image.

Returns: float - The resolution of the image.

getSize()

public Dimension getSize()

Gets a size of the page or image.

Returns: java.awt.Dimension - A size of the page or image.

getSmoothingMode()

public SmoothingMode getSmoothingMode()

Gets smoothing mode.

Returns: SmoothingMode - the smoothingMode.

getTryJoinImageFragments()

public boolean getTryJoinImageFragments()

Indicates whether the library will try to join image fragments. It is used when the image in a source PS/EPS file is cut into fragments. In this case without this flag thin gaps are left between the fragments.

Returns: boolean - the value of flag.

hashCode()

public native int hashCode()

Returns: int

isDebug()

public boolean isDebug()

Gets the flag that allows output of warnings and messages during conversion.

Returns: boolean - debug value.

isSupressErrors()

public boolean isSupressErrors()

Returns a value indicating whether errors will be suppressed during conversion.

Returns: boolean - boolean value

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAdditionalFontsFolders(String[] fontsFolders)

public void setAdditionalFontsFolders(String[] fontsFolders)

Specifies additional fonts folders where converter should find fonts for input document. Default folder is standard fonts folder where OS finds fonts for internal needs.

Parameters:

ParameterTypeDescription
fontsFoldersjava.lang.String[]An array of fonts folders.

setDebug(boolean debug)

public void setDebug(boolean debug)

Specifies the flag that allows output of warnings and messages during conversion.

Parameters:

ParameterTypeDescription
debugbooleanBoolean value.

setImageFormat(ImageFormat imageFormat)

public void setImageFormat(ImageFormat imageFormat)

Specifies an image format for resulting image.

Parameters:

ParameterTypeDescription
imageFormatImageFormatAn output image format.

setJpegQualityLevel(int value)

public void setJpegQualityLevel(int value)

Sets the value specifying the level of compression for an image. Available values are 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. 0 value results in lowest quality image, while 100 results in highest.

Parameters:

ParameterTypeDescription
valueintThe value specifying the level of compression for an image.

setResolution(float resolution)

public void setResolution(float resolution)

Specifies resolution of resulting image.

Parameters:

ParameterTypeDescription
resolutionfloatThe resolution of the image.

setSize(Dimension size)

public void setSize(Dimension size)

Specifies a size of the page or image.

Parameters:

ParameterTypeDescription
sizejava.awt.DimensionSize of the page or image.

setSmoothingMode(SmoothingMode smoothingMode)

public void setSmoothingMode(SmoothingMode smoothingMode)

Sets smoothing mode.

Parameters:

ParameterTypeDescription
smoothingModeSmoothingModethe smoothingMode to set

setSupressErrors(boolean supressErrors)

public void setSupressErrors(boolean supressErrors)

Specifies the flag that indicates whether errors will be suppressed during conversion.

Parameters:

ParameterTypeDescription
supressErrorsbooleanBoolean value.

setTryJoinImageFragments(boolean tryJoinImageFragments)

public void setTryJoinImageFragments(boolean tryJoinImageFragments)

Specifies if the library should try to join image fragments. It is used when the image in a source PS/EPS file is cut into fragments. In this case without this flag thin gaps are left between the fragments.

Parameters:

ParameterTypeDescription
tryJoinImageFragmentsbooleanthe value of flag.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int