BmpOptions

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

public class BmpOptions extends ImageOptionsBase

The bmp file format creation options.

Constructors

Constructor	Description
BmpOptions()	Initializes a new instance of the BmpOptions class.
BmpOptions(BmpOptions bmpOptions)	Initializes a new instance of the BmpOptions 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)
getBitsPerPixel()	Gets or sets the image bits per pixel count.
getBufferSizeHint()	Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
getClass()
getCompression()	Gets or sets the compression.
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.
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.
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()
setBitsPerPixel(int value)	Gets or sets the image bits per pixel count.
setBufferSizeHint(int value)	Gets or sets the buffer size hint which is defined max allowed size for all internal buffers.
setCompression(long value)	Gets or sets the compression.
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).
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.
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()
wait()
wait(long arg0)
wait(long arg0, int arg1)

BmpOptions()

public BmpOptions()

Initializes a new instance of the BmpOptions class.

BmpOptions(BmpOptions bmpOptions)

public BmpOptions(BmpOptions bmpOptions)

Initializes a new instance of the BmpOptions class.

Parameters:

Parameter	Type	Description
bmpOptions	BmpOptions	The BMP 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

getBitsPerPixel()

public int getBitsPerPixel()

Gets or sets the image bits per pixel count.

Returns: int - The image bits per pixel count.

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

getCompression()

public long getCompression()

Gets or sets the compression.

Returns: long - The compression.

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 .

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

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()

setBitsPerPixel(int value)

public void setBitsPerPixel(int value)

Gets or sets the image bits per pixel count.

Parameters:

Parameter	Type	Description
value	int	The image bits per pixel count.

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

setCompression(long value)

public void setCompression(long value)

Gets or sets the compression.

Parameters:

Parameter	Type	Description
value	long	The compression.

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

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

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

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