< prev index next >
src/java.desktop/share/classes/javax/imageio/plugins/bmp/BMPImageWriteParam.java
Print this page
*** 30,55 ****
import com.sun.imageio.plugins.bmp.BMPConstants;
import com.sun.imageio.plugins.bmp.BMPCompressionTypes;
/**
! * A subclass of <code>ImageWriteParam</code> for encoding images in
* the BMP format.
*
* <p> This class allows for the specification of various parameters
* while writing a BMP format image file. By default, the data layout
* is bottom-up, such that the pixels are stored in bottom-up order,
* the first scanline being stored last.
*
* <p>The particular compression scheme to be used can be specified by using
! * the <code>setCompressionType()</code> method with the appropriate type
* string. The compression scheme specified will be honored if and only if it
* is compatible with the type of image being written. If the specified
* compression scheme is not compatible with the type of image being written
! * then the <code>IOException</code> will be thrown by the BMP image writer.
! * If the compression type is not set explicitly then <code>getCompressionType()</code>
! * will return <code>null</code>. 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.
* <p>The compression type strings and the image type(s) each supports are
* listed in the following
* table:
--- 30,55 ----
import com.sun.imageio.plugins.bmp.BMPConstants;
import com.sun.imageio.plugins.bmp.BMPCompressionTypes;
/**
! * A subclass of {@code ImageWriteParam} for encoding images in
* the BMP format.
*
* <p> This class allows for the specification of various parameters
* while writing a BMP format image file. By default, the data layout
* is bottom-up, such that the pixels are stored in bottom-up order,
* the first scanline being stored last.
*
* <p>The particular compression scheme to be used can be specified by using
! * the {@code setCompressionType()} method with the appropriate type
* string. The compression scheme specified will be honored if and only if it
* is compatible with the type of image being written. If the specified
* compression scheme is not compatible with the type of image being written
! * then the {@code IOException} will be thrown by the BMP image writer.
! * If the compression type is not set explicitly then {@code getCompressionType()}
! * will return {@code 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.
* <p>The compression type strings and the image type(s) each supports are
* listed in the following
* table:
*** 66,81 ****
public class BMPImageWriteParam extends ImageWriteParam {
private boolean topDown = false;
/**
! * Constructs a <code>BMPImageWriteParam</code> set to use a given
! * <code>Locale</code> and with default values for all parameters.
*
! * @param locale a <code>Locale</code> to be used to localize
* compression type names and quality descriptions, or
! * <code>null</code>.
*/
public BMPImageWriteParam(Locale locale) {
super(locale);
// Set compression types ("BI_RGB" denotes uncompressed).
--- 66,81 ----
public class BMPImageWriteParam extends ImageWriteParam {
private boolean topDown = false;
/**
! * Constructs a {@code BMPImageWriteParam} set to use a given
! * {@code Locale} and with default values for all parameters.
*
! * @param locale a {@code Locale} to be used to localize
* compression type names and quality descriptions, or
! * {@code null}.
*/
public BMPImageWriteParam(Locale locale) {
super(locale);
// Set compression types ("BI_RGB" denotes uncompressed).
*** 86,97 ****
compressionMode = MODE_COPY_FROM_METADATA;
compressionType = compressionTypes[BMPConstants.BI_RGB];
}
/**
! * Constructs an <code>BMPImageWriteParam</code> object with default
! * values for all parameters and a <code>null</code> <code>Locale</code>.
*/
public BMPImageWriteParam() {
this(null);
}
--- 86,97 ----
compressionMode = MODE_COPY_FROM_METADATA;
compressionType = compressionTypes[BMPConstants.BI_RGB];
}
/**
! * Constructs an {@code BMPImageWriteParam} object with default
! * values for all parameters and a {@code null Locale}.
*/
public BMPImageWriteParam() {
this(null);
}
*** 104,115 ****
public void setTopDown(boolean topDown) {
this.topDown = topDown;
}
/**
! * Returns the value of the <code>topDown</code> parameter.
! * The default is <code>false</code>.
*
* @return whether the data are written in top-down order.
*/
public boolean isTopDown() {
return topDown;
--- 104,115 ----
public void setTopDown(boolean topDown) {
this.topDown = topDown;
}
/**
! * Returns the value of the {@code topDown} parameter.
! * The default is {@code false}.
*
* @return whether the data are written in top-down order.
*/
public boolean isTopDown() {
return topDown;
< prev index next >