javax.imageio.plugins.bmp

Class BMPImageWriteParam

public class BMPImageWriteParam extends ImageWriteParam

A class to encode images in the BMP format. By default, the data layout is bottom-up, such that the pixels are stored in bottom-up order. The compression scheme can be specified by using setCompressionType() appropriate type string. The compression scheme specified will be honored if it is compatible with the type of image being written. If the compression scheme is not compatible with the type of image being written, then an IOException will be thrown by the BMP image writer. If the compression type is not set, then getCompressionType() will return null. In this case the BMP image writer will select a compression type that supports encoding of the given image without loss of the color resolution. The compression type strings and the image type each supports are: Uncompressed RLE: BI_RGB, image type: <= 8-bits/sample. 8-bit Run Length Encoding: BI_RLE8, image type: <= 8-bits/sample 4-bit Run Length Encoding: BI_RLE4, image type: <= 4-bits/sample Packed data: BI_BITFIELDS, image type: 16 or 32 bits/sample
Constructor Summary
BMPImageWriteParam()
Constructs an BMPImageWriteParam object with default values and a null Locale.
BMPImageWriteParam(Locale locale)
Constructs a BMPImageWriteParam set to use a given Locale and with default values for all parameters.
Method Summary
booleanisTopDown()
Returns the value of the topDown parameter.
voidsetTopDown(boolean topDown)
If set, the data will be written out in a top-down manner, the first scanline being written first.

Constructor Detail

BMPImageWriteParam

public BMPImageWriteParam()
Constructs an BMPImageWriteParam object with default values and a null Locale.

BMPImageWriteParam

public BMPImageWriteParam(Locale locale)
Constructs a BMPImageWriteParam set to use a given Locale and with default values for all parameters.

Parameters: locale - a Locale to be used to localize compression type names and quality descriptions, or null.

Method Detail

isTopDown

public boolean isTopDown()
Returns the value of the topDown parameter. The default is false.

Returns: whether the data are written in top-down order.

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.

Parameters: topDown - whether the data are written in top-down order.