ImageSaveOptions
Inheritance: java.lang.Object, com.aspose.page.SaveOptions
public class ImageSaveOptions extends SaveOptions
This class contains options necessary for managing conversion process.
Constructors
| Constructor | Description |
|---|---|
| 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(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
| Method | Description |
|---|---|
| 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. |
| getSmoothingMode() | Gets smoothing mode. |
| 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. |
| setSmoothingMode(SmoothingMode smoothingMode) | Sets smoothing mode. |
| setSupressErrors(boolean supressErrors) | Specifies the flag that indicates whether errors will be suppressed during conversion. |
| 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:
| Parameter | Type | Description |
|---|---|---|
| imageFormat | ImageFormat | The format of the image. |
ImageSaveOptions(Dimension size)
public ImageSaveOptions(Dimension size)
Initializes new instance of ImageSaveOptions with specified size of the image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| size | java.awt.Dimension | image 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:
| Parameter | Type | Description |
|---|---|---|
| size | java.awt.Dimension | Image size. |
| imageFormat | ImageFormat | Format of the image. |
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:
| Parameter | Type | Description |
|---|---|---|
| size | java.awt.Dimension | Image size. |
| imageFormat | ImageFormat | Format of the image. |
| supressErrors | boolean | If 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:
| Parameter | Type | Description |
|---|---|---|
| supressErrors | boolean | If true conversion will be continued despite of non-critical errors. |
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.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.
Returns: java.awt.Dimension - A size of the image.
getSmoothingMode()
public SmoothingMode getSmoothingMode()
Gets smoothing mode.
Returns: SmoothingMode - the smoothingMode.
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:
| Parameter | Type | Description |
|---|---|---|
| fontsFolders | java.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:
| Parameter | Type | Description |
|---|---|---|
| debug | boolean | Boolean value. |
setImageFormat(ImageFormat imageFormat)
public void setImageFormat(ImageFormat imageFormat)
Specifies an image format for resulting image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageFormat | ImageFormat | An 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:
| Parameter | Type | Description |
|---|---|---|
| value | int | The value specifying the level of compression for an image. |
setResolution(float resolution)
public void setResolution(float resolution)
Specifies resolution of resulting image.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resolution | float | The resolution of the image. |
setSize(Dimension size)
public void setSize(Dimension size)
Specifies a size of the page.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| size | java.awt.Dimension | Size of the image. |
setSmoothingMode(SmoothingMode smoothingMode)
public void setSmoothingMode(SmoothingMode smoothingMode)
Sets smoothing mode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| smoothingMode | SmoothingMode | the smoothingMode to set |
setSupressErrors(boolean supressErrors)
public void setSupressErrors(boolean supressErrors)
Specifies the flag that indicates whether errors will be suppressed during conversion.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| supressErrors | boolean | Boolean value. |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |