001 /*
002 * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.imageio.plugins.bmp;
027
028 import java.util.Locale;
029 import javax.imageio.ImageWriteParam;
030
031 import com.sun.imageio.plugins.bmp.BMPConstants;
032
033 /**
034 * A subclass of <code>ImageWriteParam</code> for encoding images in
035 * the BMP format.
036 *
037 * <p> This class allows for the specification of various parameters
038 * while writing a BMP format image file. By default, the data layout
039 * is bottom-up, such that the pixels are stored in bottom-up order,
040 * the first scanline being stored last.
041 *
042 * <p>The particular compression scheme to be used can be specified by using
043 * the <code>setCompressionType()</code> method with the appropriate type
044 * string. The compression scheme specified will be honored if and only if it
045 * is compatible with the type of image being written. If the specified
046 * compression scheme is not compatible with the type of image being written
047 * then the <code>IOException</code> will be thrown by the BMP image writer.
048 * If the compression type is not set explicitly then <code>getCompressionType()</code>
049 * will return <code>null</code>. In this case the BMP image writer will select
050 * a compression type that supports encoding of the given image without loss
051 * of the color resolution.
052 * <p>The compression type strings and the image type(s) each supports are
053 * listed in the following
054 * table:
055 *
056 * <p><table border=1>
057 * <caption><b>Compression Types</b></caption>
058 * <tr><th>Type String</th> <th>Description</th> <th>Image Types</th></tr>
059 * <tr><td>BI_RGB</td> <td>Uncompressed RLE</td> <td><= 8-bits/sample</td></tr>
060 * <tr><td>BI_RLE8</td> <td>8-bit Run Length Encoding</td> <td><= 8-bits/sample</td></tr>
061 * <tr><td>BI_RLE4</td> <td>4-bit Run Length Encoding</td> <td><= 4-bits/sample</td></tr>
062 * <tr><td>BI_BITFIELDS</td> <td>Packed data</td> <td> 16 or 32 bits/sample</td></tr>
063 * </table>
064 */
065 public class BMPImageWriteParam extends ImageWriteParam {
066
067 private boolean topDown = false;
068
069 /**
070 * Constructs a <code>BMPImageWriteParam</code> set to use a given
071 * <code>Locale</code> and with default values for all parameters.
072 *
073 * @param locale a <code>Locale</code> to be used to localize
074 * compression type names and quality descriptions, or
075 * <code>null</code>.
076 */
077 public BMPImageWriteParam(Locale locale) {
078 super (locale);
079
080 // Set compression types ("BI_RGB" denotes uncompressed).
081 compressionTypes = BMPConstants.compressionTypeNames;
082
083 // Set compression flag.
084 canWriteCompressed = true;
085 compressionMode = MODE_COPY_FROM_METADATA;
086 compressionType = compressionTypes[BMPConstants.BI_RGB];
087 }
088
089 /**
090 * Constructs an <code>BMPImageWriteParam</code> object with default
091 * values for all parameters and a <code>null</code> <code>Locale</code>.
092 */
093 public BMPImageWriteParam() {
094 this (null);
095 }
096
097 /**
098 * If set, the data will be written out in a top-down manner, the first
099 * scanline being written first.
100 *
101 * @param topDown whether the data are written in top-down order.
102 */
103 public void setTopDown(boolean topDown) {
104 this .topDown = topDown;
105 }
106
107 /**
108 * Returns the value of the <code>topDown</code> parameter.
109 * The default is <code>false</code>.
110 *
111 * @return whether the data are written in top-down order.
112 */
113 public boolean isTopDown() {
114 return topDown;
115 }
116 }
| 