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

Field Summary

Fields inherited from class javax.imageio.ImageWriteParam

MODE_COPY_FROM_METADATA, MODE_DEFAULT, MODE_DISABLED, MODE_EXPLICIT, canOffsetTiles, canWriteCompressed, canWriteProgressive, canWriteTiles, compressionMode, compressionQuality, compressionType, compressionTypes, locale, preferredTileSizes, progressiveMode, tileGridXOffset, tileGridYOffset, tileHeight, tileWidth, tilingMode, tilingSet

Fields inherited from class javax.imageio.IIOParam

controller, defaultController, destinationOffset, destinationType, sourceBands, sourceRegion, sourceXSubsampling, sourceYSubsampling, subsamplingXOffset, subsamplingYOffset

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

boolean
isTopDown()
Returns the value of the topDown parameter.
void
setTopDown(boolean topDown)
If set, the data will be written out in a top-down manner, the first scanline being written first.

Methods inherited from class javax.imageio.ImageWriteParam

canOffsetTiles, canWriteCompressed, canWriteProgressive, canWriteTiles, getBitRate, getCompressionMode, getCompressionQuality, getCompressionQualityDescriptions, getCompressionQualityValues, getCompressionType, getCompressionTypes, getLocale, getLocalizedCompressionTypeName, getPreferredTileSizes, getProgressiveMode, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileWidth, getTilingMode, isCompressionLossless, setCompressionMode, setCompressionQuality, setCompressionType, setProgressiveMode, setTiling, setTilingMode, unsetCompression, unsetTiling

Methods inherited from class javax.imageio.IIOParam

activateController, getController, getDefaultController, getDestinationOffset, getDestinationType, getSourceBands, getSourceRegion, getSourceXSubsampling, getSourceYSubsampling, getSubsamplingXOffset, getSubsamplingYOffset, hasController, setController, setDestinationOffset, setDestinationType, setSourceBands, setSourceRegion, setSourceSubsampling

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

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.

BMPImageWriteParam.java -- Copyright (C) 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.