com.sun.media.jai.codec
Class BMPEncodeParam

java.lang.Object
  com.sun.media.jai.codec.BMPEncodeParam

All Implemented Interfaces:

Cloneable, ImageDecodeParam, ImageEncodeParam, Serializable

public class BMPEncodeParam

extends Object

implements ImageEncodeParam

An instance of ImageEncodeParam for encoding images in the BMP format.

This class allows for the specification of various parameters while encoding (writing) a BMP format image file. By default, the version used is VERSION_3, no compression is used, and the data layout is bottom_up, such that the pixels are stored in bottom-up order, the first scanline being stored last.

This class is not a committed part of the JAI API. It may be removed or changed in future releases of JAI.

See Also:

Serialized Form

Field Summary

static int	VERSION_2 Constant for BMP version 2.
static int	VERSION_3 Constant for BMP version 3.
static int	VERSION_4 Constant for BMP version 4.

Constructor Summary

BMPEncodeParam()
Constructs an BMPEncodeParam object with default values for parameters.

Method Summary

int	getVersion() Returns the BMP version to be used.
boolean	isCompressed() Returns the value of the parameter compressed.
boolean	isTopDown() Returns the value of the topDown parameter.
void	setCompressed(boolean compressed) If set, the data will be written out compressed, if possible.
void	setTopDown(boolean topDown) If set, the data will be written out in a top-down manner, the first scanline being written first.
void	setVersion(int versionNumber) Sets the BMP version to be used.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION_2

public static final int VERSION_2

Constant for BMP version 2.

See Also:

Constant Field Values

VERSION_3

public static final int VERSION_3

Constant for BMP version 3.

See Also:

Constant Field Values

VERSION_4

public static final int VERSION_4

Constant for BMP version 4.

See Also:

Constant Field Values

Constructor Detail

BMPEncodeParam

public BMPEncodeParam()

Constructs an BMPEncodeParam object with default values for parameters.

Method Detail

setVersion

public void setVersion(int versionNumber)

Sets the BMP version to be used.

getVersion

public int getVersion()

Returns the BMP version to be used.

setCompressed

public void setCompressed(boolean compressed)

If set, the data will be written out compressed, if possible.

isCompressed

public boolean isCompressed()

Returns the value of the parameter compressed.

setTopDown

public void setTopDown(boolean topDown)

If set, the data will be written out in a top-down manner, the first scanline being written first.

isTopDown

public boolean isTopDown()

Returns the value of the topDown parameter.