PngOptions
Inheritance: java.lang.Object, com.aspose.psd.DisposableObject, com.aspose.psd.ImageOptionsBase
public class PngOptions extends ImageOptionsBase
The png file format create options.
Constructors
| Constructor | Description |
|---|---|
| PngOptions() | Initializes a new instance of the PngOptions class. |
| PngOptions(PngOptions pngOptions) | Initializes a new instance of the JpegOptions class. |
Fields
| Field | Description |
|---|---|
| DEFAULT_COMPRESSION_LEVEL | The default compression level. |
Methods
| Method | Description |
|---|---|
| clone() | |
| close() | Implements the Closable interface and can be used in the try-with-resources statement since JDK 1.7. |
| deepClone() | Clones this instance. |
| deepClone_internalized() | Clones this instance. |
| dispose() | Disposes the current instance. |
| equals(Object arg0) | |
| getBitDepth() | Gets the bit depth. |
| getBufferSizeHint() | Gets or sets the buffer size hint which is defined max allowed size for all internal buffers. |
| getClass() | |
| getColorType() | Gets or sets the type of the color. |
| getCompressionLevel() | The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode. |
| getDefaultReplacementFont() | Gets or sets the default replacement font (font that will be used to draw text when exporting to raster, if existing layer font in PSD file is not presented in system). |
| getDisposed() | Gets a value indicating whether this instance is disposed. |
| getFilterType() | Gets or sets the filter type used during png file save process. |
| getFullFrame() | Gets a value indicating whether [full frame]. |
| getMultiPageOptions() | The multipage options |
| getPalette() | Gets or sets the color palette. |
| getProgressEventHandler() | Gets or sets the progress event handler. |
| getProgressive() | Gets or sets a value indicating whether this PngOptions is progressive. |
| getResolutionSettings() | Gets or sets the resolution settings. |
| getSource() | Gets or sets the source to create image in. |
| getVectorRasterizationOptions() | Gets or sets the vector rasterization options. |
| getXmpData() | Gets or sets the XMP metadata container. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setBitDepth(byte value) | Sets the bit depth. |
| setBufferSizeHint(int value) | Gets or sets the buffer size hint which is defined max allowed size for all internal buffers. |
| setColorType(int value) | Gets or sets the type of the color. |
| setCompressionLevel(int value) | The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode. |
| setDefaultReplacementFont(String value) | Gets or sets the default replacement font (font that will be used to draw text when exporting to raster, if existing layer font in PSD file is not presented in system). |
| setFilterType(int value) | Gets or sets the filter type used during png file save process. |
| setFullFrame(boolean value) | Sets a value indicating whether [full frame]. |
| setIgnoreAfterCreate_internalized(boolean value) | Gets or sets a value indicating whether ignore after create event. |
| setMultiPageOptions(MultiPageOptions value) | The multipage options |
| setPalette(IColorPalette value) | Gets or sets the color palette. |
| setProgressEventHandler(ProgressEventHandler value) | Gets or sets the progress event handler. |
| setProgressive(boolean value) | Gets or sets a value indicating whether this PngOptions is progressive. |
| setResolutionSettings(ResolutionSetting value) | Gets or sets the resolution settings. |
| setSource(Source value) | Gets or sets the source to create image in. |
| setVectorRasterizationOptions(VectorRasterizationOptions value) | Gets or sets the vector rasterization options. |
| setXmpData(XmpPacketWrapper value) | Gets or sets the XMP metadata container. |
| toString() | |
| validate_internalized() | The options validation routine. |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
PngOptions()
public PngOptions()
Initializes a new instance of the PngOptions class.
PngOptions(PngOptions pngOptions)
public PngOptions(PngOptions pngOptions)
Initializes a new instance of the JpegOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pngOptions | PngOptions | The PNG options. |
DEFAULT_COMPRESSION_LEVEL
public static final int DEFAULT_COMPRESSION_LEVEL
The default compression level.
clone()
public ImageOptionsBase clone()
Returns: ImageOptionsBase
close()
public void close()
Implements the Closable interface and can be used in the try-with-resources statement since JDK 1.7. This method simply call dispose method.
deepClone()
public ImageOptionsBase deepClone()
Clones this instance.
Returns: ImageOptionsBase - Returns shallow copy of this instance
deepClone_internalized()
public ImageOptionsBase deepClone_internalized()
Clones this instance.
Returns: ImageOptionsBase - Returns shallow copy of this instance
dispose()
public final void dispose()
Disposes the current instance.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getBitDepth()
public byte getBitDepth()
Gets the bit depth.
Returns: byte - The bit depth.
getBufferSizeHint()
public final int getBufferSizeHint()
Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
Value: The buffer size hint, in megabytes. Non-positive value means no memory limitation for internal buffers
Returns: int
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getColorType()
public int getColorType()
Gets or sets the type of the color.
Returns: int - The type of the color.
getCompressionLevel()
public int getCompressionLevel()
The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode.
Returns: int - the compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode.
getDefaultReplacementFont()
public String getDefaultReplacementFont()
Gets or sets the default replacement font (font that will be used to draw text when exporting to raster, if existing layer font in PSD file is not presented in system). To take proper name of default font can be used next code snippet: System.Drawing.Text.InstalledFontCollection col = new System.Drawing.Text.InstalledFontCollection(); System.Drawing.FontFamily[] families = col.Families; string defaultFontName = families[0].Name; PsdLoadOptions psdLoadOptions = new PsdLoadOptions() { DefaultReplacementFont = defaultFontName });
Value: The default replacement font.
Returns: java.lang.String
getDisposed()
public final boolean getDisposed()
Gets a value indicating whether this instance is disposed.
Returns: boolean - true if disposed; otherwise, false .
getFilterType()
public int getFilterType()
Gets or sets the filter type used during png file save process.
Returns: int - the filter type used during png file save process.
getFullFrame()
public final boolean getFullFrame()
Gets a value indicating whether [full frame].
Value: true if [full frame]; otherwise, false .
Returns: boolean - a value indicating whether [full frame].
getMultiPageOptions()
public final MultiPageOptions getMultiPageOptions()
The multipage options
Returns: MultiPageOptions
getPalette()
public IColorPalette getPalette()
Gets or sets the color palette.
Value: The color palette.
Returns: IColorPalette
getProgressEventHandler()
public final ProgressEventHandler getProgressEventHandler()
Gets or sets the progress event handler.
Value: The progress event handler.
Returns: ProgressEventHandler
getProgressive()
public boolean getProgressive()
Gets or sets a value indicating whether this PngOptions is progressive.
Returns: boolean - true if progressive; otherwise, false .
getResolutionSettings()
public ResolutionSetting getResolutionSettings()
Gets or sets the resolution settings.
Returns: ResolutionSetting
getSource()
public final Source getSource()
Gets or sets the source to create image in.
Value: The source to create image in.
Returns: Source
getVectorRasterizationOptions()
public final VectorRasterizationOptions getVectorRasterizationOptions()
Gets or sets the vector rasterization options.
Value: The vector rasterization options.
Returns: VectorRasterizationOptions
getXmpData()
public XmpPacketWrapper getXmpData()
Gets or sets the XMP metadata container.
Value: The XMP data container.
Returns: XmpPacketWrapper
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setBitDepth(byte value)
public void setBitDepth(byte value)
Sets the bit depth.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | byte | The bit depth. |
setBufferSizeHint(int value)
public final void setBufferSizeHint(int value)
Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
Value: The buffer size hint, in megabytes. Non-positive value means no memory limitation for internal buffers
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setColorType(int value)
public void setColorType(int value)
Gets or sets the type of the color.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The type of the color. |
setCompressionLevel(int value)
public void setCompressionLevel(int value)
The png image compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | the compression level in the 0-9 range, where 9 is maximum compression and 0 is store mode. |
setDefaultReplacementFont(String value)
public void setDefaultReplacementFont(String value)
Gets or sets the default replacement font (font that will be used to draw text when exporting to raster, if existing layer font in PSD file is not presented in system). To take proper name of default font can be used next code snippet: System.Drawing.Text.InstalledFontCollection col = new System.Drawing.Text.InstalledFontCollection(); System.Drawing.FontFamily[] families = col.Families; string defaultFontName = families[0].Name; PsdLoadOptions psdLoadOptions = new PsdLoadOptions() { DefaultReplacementFont = defaultFontName });
Value: The default replacement font.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setFilterType(int value)
public void setFilterType(int value)
Gets or sets the filter type used during png file save process.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | the filter type used during png file save process. |
setFullFrame(boolean value)
public final void setFullFrame(boolean value)
Sets a value indicating whether [full frame].
Value: true if [full frame]; otherwise, false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | a value indicating whether [full frame]. |
setIgnoreAfterCreate_internalized(boolean value)
public final void setIgnoreAfterCreate_internalized(boolean value)
Gets or sets a value indicating whether ignore after create event.
Value: true if ignore after create event; otherwise, false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setMultiPageOptions(MultiPageOptions value)
public final void setMultiPageOptions(MultiPageOptions value)
The multipage options
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | MultiPageOptions |
setPalette(IColorPalette value)
public void setPalette(IColorPalette value)
Gets or sets the color palette.
Value: The color palette.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IColorPalette |
setProgressEventHandler(ProgressEventHandler value)
public final void setProgressEventHandler(ProgressEventHandler value)
Gets or sets the progress event handler.
Value: The progress event handler.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ProgressEventHandler |
setProgressive(boolean value)
public void setProgressive(boolean value)
Gets or sets a value indicating whether this PngOptions is progressive.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | true if progressive; otherwise, false . |
setResolutionSettings(ResolutionSetting value)
public void setResolutionSettings(ResolutionSetting value)
Gets or sets the resolution settings.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ResolutionSetting |
setSource(Source value)
public final void setSource(Source value)
Gets or sets the source to create image in.
Value: The source to create image in.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Source |
setVectorRasterizationOptions(VectorRasterizationOptions value)
public final void setVectorRasterizationOptions(VectorRasterizationOptions value)
Gets or sets the vector rasterization options.
Value: The vector rasterization options.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | VectorRasterizationOptions |
setXmpData(XmpPacketWrapper value)
public void setXmpData(XmpPacketWrapper value)
Gets or sets the XMP metadata container.
Value: The XMP data container.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | XmpPacketWrapper |
toString()
public String toString()
Returns: java.lang.String
validate_internalized()
public void validate_internalized()
The options validation routine.
wait()
public final void wait()
wait(long arg0)
public final 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 |