JpegOptions

Inheritance: java.lang.Object, com.aspose.psd.DisposableObject, com.aspose.psd.ImageOptionsBase

public class JpegOptions extends ImageOptionsBase

The jpeg file format create options.

Constructors

Constructor	Description
JpegOptions()	Initializes a new instance of the JpegOptions class.
JpegOptions(JpegOptions jpegOptions)	Initializes a new instance of the JpegOptions class.

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)
getBitsPerChannel()	Gets bits per channel for lossless jpeg image.
getBufferSizeHint()	Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
getClass()
getCmykColorProfile()	The destination CMYK color profile for CMYK jpeg images.
getColorType()	Gets the color type for jpeg image.
getComment()	Gets the jpeg file comment.
getCompressionType()	Gets the compression type.
getDefaultMemoryAllocationLimit()	Gets the default memory allocation limit.
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.
getExifData()	Get or set exif data container
getFullFrame()	Gets a value indicating whether [full frame].
getHorizontalSampling()	Gets the horizontal subsamplings for each component.
getJfif()	Gets the jfif.
getJpegLsAllowedLossyError()	Gets the JPEG-LS difference bound for near-lossless coding (NEAR parameter from the JPEG-LS specification).
getJpegLsInterleaveMode()	Gets the JPEG-LS interleave mode.
getJpegLsPreset()	Gets the JPEG-LS preset parameters.
getMultiPageOptions()	The multipage options
getPalette()	Gets or sets the color palette.
getPreblendAlphaIfPresent()	Gets a value indicating whether red, green and blue components should be mixed with a background color, if alpha channel is present.
getProgressEventHandler()	Gets or sets the progress event handler.
getQuality()	Gets image quality.
getRdOptSettings()	Gets the RD optimizer settings.
getResolutionSettings()	Gets or sets the resolution settings.
getResolutionUnit()	Gets the resolution unit.
getRgbColorProfile()	The destination RGB color profile for CMYK jpeg images.
getSampleRoundingMode()	Gets the sample rounding mode to fit an 8-bit value to an n-bit value.
getScaledQuality()	The scaled quality.
getSource()	Gets or sets the source to create image in.
getVectorRasterizationOptions()	Gets or sets the vector rasterization options.
getVerticalSampling()	Gets the vertical subsamplings for each component.
getXmpData()	Gets the XMP metadata container.
hashCode()
notify()
notifyAll()
setBitsPerChannel(byte value)	Sets bits per channel for lossless jpeg image.
setBufferSizeHint(int value)	Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
setCmykColorProfile(StreamSource value)	The destination CMYK color profile for CMYK jpeg images.
setColorType(int value)	Sets the color type for jpeg image.
setComment(String value)	Sets the jpeg file comment.
setCompressionType(int value)	Sets the compression type.
setDefaultMemoryAllocationLimit(int value)	Sets the default memory allocation limit.
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).
setExifData(JpegExifData value)	Get or set exif data container
setFullFrame(boolean value)	Sets a value indicating whether [full frame].
setHorizontalSampling(byte[] value)	Sets the horizontal subsamplings for each component.
setIgnoreAfterCreate_internalized(boolean value)	Gets or sets a value indicating whether ignore after create event.
setJfif(JFIFData value)	Sets the jfif.
setJpegLsAllowedLossyError(int value)	Sets the JPEG-LS difference bound for near-lossless coding (NEAR parameter from the JPEG-LS specification).
setJpegLsInterleaveMode(int value)	Sets the JPEG-LS interleave mode.
setJpegLsPreset(JpegLsPresetCodingParameters value)	Sets the JPEG-LS preset parameters.
setMultiPageOptions(MultiPageOptions value)	The multipage options
setPalette(IColorPalette value)	Gets or sets the color palette.
setPreblendAlphaIfPresent(boolean value)	Sets a value indicating whether red, green and blue components should be mixed with a background color, if alpha channel is present.
setProgressEventHandler(ProgressEventHandler value)	Gets or sets the progress event handler.
setQuality(int value)	Sets image quality.
setRdOptSettings(RdOptimizerSettings value)	Sets the RD optimizer settings.
setResolutionSettings(ResolutionSetting value)	Gets or sets the resolution settings.
setResolutionUnit(byte value)	Sets the resolution unit.
setRgbColorProfile(StreamSource value)	The destination RGB color profile for CMYK jpeg images.
setSampleRoundingMode(int value)	Sets the sample rounding mode to fit an 8-bit value to an n-bit value.
setSource(Source value)	Gets or sets the source to create image in.
setVectorRasterizationOptions(VectorRasterizationOptions value)	Gets or sets the vector rasterization options.
setVerticalSampling(byte[] value)	Sets the vertical subsamplings for each component.
setXmpData(XmpPacketWrapper value)	Sets the XMP metadata container.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

JpegOptions()

public JpegOptions()

Initializes a new instance of the JpegOptions class.

JpegOptions(JpegOptions jpegOptions)

public JpegOptions(JpegOptions jpegOptions)

Initializes a new instance of the JpegOptions class.

Parameters:

Parameter	Type	Description
jpegOptions	JpegOptions	The JPEG options.

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

getBitsPerChannel()

public byte getBitsPerChannel()

Gets bits per channel for lossless jpeg image. Now we support from 2 to 8 bits per channel.

Returns: byte

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

getCmykColorProfile()

public StreamSource getCmykColorProfile()

The destination CMYK color profile for CMYK jpeg images. Use for saving images. Must be in pair with RGBColorProfile for correct color conversion.

Returns: StreamSource

getColorType()

public int getColorType()

Gets the color type for jpeg image.

Returns: int

getComment()

public String getComment()

Gets the jpeg file comment.

Returns: java.lang.String

getCompressionType()

public int getCompressionType()

Gets the compression type.

Returns: int

getDefaultMemoryAllocationLimit()

public int getDefaultMemoryAllocationLimit()

Gets the default memory allocation limit.

Returns: int - The default memory allocation limit.

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 .

getExifData()

public JpegExifData getExifData()

Get or set exif data container

Returns: JpegExifData

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].

getHorizontalSampling()

public byte[] getHorizontalSampling()

Gets the horizontal subsamplings for each component.

Returns: byte[]

getJfif()

public JFIFData getJfif()

Gets the jfif.

Returns: JFIFData

getJpegLsAllowedLossyError()

public int getJpegLsAllowedLossyError()

Gets the JPEG-LS difference bound for near-lossless coding (NEAR parameter from the JPEG-LS specification).

Returns: int

getJpegLsInterleaveMode()

public int getJpegLsInterleaveMode()

Gets the JPEG-LS interleave mode.

Returns: int

getJpegLsPreset()

public JpegLsPresetCodingParameters getJpegLsPreset()

Gets the JPEG-LS preset parameters.

Returns: JpegLsPresetCodingParameters

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

getPreblendAlphaIfPresent()

public boolean getPreblendAlphaIfPresent()

Gets a value indicating whether red, green and blue components should be mixed with a background color, if alpha channel is present.

Returns: boolean

getProgressEventHandler()

public final ProgressEventHandler getProgressEventHandler()

Gets or sets the progress event handler.

Value: The progress event handler.

Returns: ProgressEventHandler

getQuality()

public int getQuality()

Gets image quality.

Returns: int

getRdOptSettings()

public RdOptimizerSettings getRdOptSettings()

Gets the RD optimizer settings.

Returns: RdOptimizerSettings - The RD optimizer settings.

getResolutionSettings()

public ResolutionSetting getResolutionSettings()

Gets or sets the resolution settings.

Returns: ResolutionSetting

getResolutionUnit()

public final byte getResolutionUnit()

Gets the resolution unit.

Returns: byte - the resolution unit.

getRgbColorProfile()

public StreamSource getRgbColorProfile()

The destination RGB color profile for CMYK jpeg images. Use for saving images. Must be in pair with CMYKColorProfile for correct color conversion.

Returns: StreamSource

getSampleRoundingMode()

public int getSampleRoundingMode()

Gets the sample rounding mode to fit an 8-bit value to an n-bit value. P:JpegOptions.BitsPerChannel

Returns: int

getScaledQuality()

public int getScaledQuality()

The scaled quality.

Returns: int

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

getVerticalSampling()

public byte[] getVerticalSampling()

Gets the vertical subsamplings for each component.

Returns: byte[]

getXmpData()

public XmpPacketWrapper getXmpData()

Gets the XMP metadata container.

Returns: XmpPacketWrapper - The XMP data container.

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setBitsPerChannel(byte value)

public void setBitsPerChannel(byte value)

Sets bits per channel for lossless jpeg image. Now we support from 2 to 8 bits per channel.

Parameters:

Parameter	Type	Description
value	byte

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

setCmykColorProfile(StreamSource value)

public void setCmykColorProfile(StreamSource value)

The destination CMYK color profile for CMYK jpeg images. Use for saving images. Must be in pair with RGBColorProfile for correct color conversion.

Parameters:

Parameter	Type	Description
value	StreamSource

setColorType(int value)

public void setColorType(int value)

Sets the color type for jpeg image.

Parameters:

Parameter	Type	Description
value	int

setComment(String value)

public void setComment(String value)

Sets the jpeg file comment.

Parameters:

Parameter	Type	Description
value	java.lang.String

setCompressionType(int value)

public void setCompressionType(int value)

Sets the compression type.

Parameters:

Parameter	Type	Description
value	int

setDefaultMemoryAllocationLimit(int value)

public void setDefaultMemoryAllocationLimit(int value)

Sets the default memory allocation limit.

Parameters:

Parameter	Type	Description
value	int	The default memory allocation limit.

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

setExifData(JpegExifData value)

public void setExifData(JpegExifData value)

Get or set exif data container

Parameters:

Parameter	Type	Description
value	JpegExifData

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].

setHorizontalSampling(byte[] value)

public void setHorizontalSampling(byte[] value)

Sets the horizontal subsamplings for each component.

Parameters:

Parameter	Type	Description
value	byte[]

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

setJfif(JFIFData value)

public void setJfif(JFIFData value)

Sets the jfif.

Parameters:

Parameter	Type	Description
value	JFIFData

setJpegLsAllowedLossyError(int value)

public void setJpegLsAllowedLossyError(int value)

Sets the JPEG-LS difference bound for near-lossless coding (NEAR parameter from the JPEG-LS specification).

Parameters:

Parameter	Type	Description
value	int

setJpegLsInterleaveMode(int value)

public void setJpegLsInterleaveMode(int value)

Sets the JPEG-LS interleave mode.

Parameters:

Parameter	Type	Description
value	int

setJpegLsPreset(JpegLsPresetCodingParameters value)

public void setJpegLsPreset(JpegLsPresetCodingParameters value)

Sets the JPEG-LS preset parameters.

Parameters:

Parameter	Type	Description
value	JpegLsPresetCodingParameters

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

setPreblendAlphaIfPresent(boolean value)

public void setPreblendAlphaIfPresent(boolean value)

Sets a value indicating whether red, green and blue components should be mixed with a background color, if alpha channel is present.

Parameters:

Parameter	Type	Description
value	boolean

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

setQuality(int value)

public void setQuality(int value)

Sets image quality.

Parameters:

Parameter	Type	Description
value	int

setRdOptSettings(RdOptimizerSettings value)

public void setRdOptSettings(RdOptimizerSettings value)

Sets the RD optimizer settings.

Parameters:

Parameter	Type	Description
value	RdOptimizerSettings	The RD optimizer settings.

setResolutionSettings(ResolutionSetting value)

public void setResolutionSettings(ResolutionSetting value)

Gets or sets the resolution settings.

Parameters:

Parameter	Type	Description
value	ResolutionSetting

setResolutionUnit(byte value)

public final void setResolutionUnit(byte value)

Sets the resolution unit.

Parameters:

Parameter	Type	Description
value	byte	the resolution unit.

setRgbColorProfile(StreamSource value)

public void setRgbColorProfile(StreamSource value)

The destination RGB color profile for CMYK jpeg images. Use for saving images. Must be in pair with CMYKColorProfile for correct color conversion.

Parameters:

Parameter	Type	Description
value	StreamSource

setSampleRoundingMode(int value)

public void setSampleRoundingMode(int value)

Sets the sample rounding mode to fit an 8-bit value to an n-bit value. P:JpegOptions.BitsPerChannel

Parameters:

Parameter	Type	Description
value	int

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

setVerticalSampling(byte[] value)

public void setVerticalSampling(byte[] value)

Sets the vertical subsamplings for each component.

Parameters:

Parameter	Type	Description
value	byte[]

setXmpData(XmpPacketWrapper value)

public void setXmpData(XmpPacketWrapper value)

Sets the XMP metadata container.

Parameters:

Parameter	Type	Description
value	XmpPacketWrapper	The XMP data container.

toString()

public String toString()

Returns: java.lang.String

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