org.apache.poi.hwmf.record

Enum HwmfBitmapDib.Compression

java.lang.Object

java.lang.Enum<HwmfBitmapDib.Compression>

org.apache.poi.hwmf.record.HwmfBitmapDib.Compression

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HwmfBitmapDib.Compression>

Enclosing class:

HwmfBitmapDib

public static enum HwmfBitmapDib.Compression
extends java.lang.Enum<HwmfBitmapDib.Compression>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BI_BITFIELDS The bitmap is not compressed and the color table consists of three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel.
BI_CMYK The image is an uncompressed CMYK format.
BI_CMYKRLE4 A CMYK format that uses RLE compression for bitmaps with 4 bits per pixel.
BI_CMYKRLE8 A CMYK format that uses RLE compression for bitmaps with 8 bits per pixel.
BI_JPEG The image is a JPEG image, as specified in [JFIF].
BI_PNG The image is a PNG image, as specified in [RFC2083].
BI_RGB The bitmap is in uncompressed red green blue (RGB) format that is not compressed and does not use color masks.
BI_RLE4 An RGB format that uses RLE compression for bitmaps with 4 bits per pixel.
BI_RLE8 An RGB format that uses run-length encoding (RLE) compression for bitmaps with 8 bits per pixel.

Method Summary

Modifier and Type	Method and Description
static HwmfBitmapDib.Compression	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HwmfBitmapDib.Compression[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BI_RGB

public static final HwmfBitmapDib.Compression BI_RGB

The bitmap is in uncompressed red green blue (RGB) format that is not compressed and does not use color masks.

BI_RLE8

public static final HwmfBitmapDib.Compression BI_RLE8

An RGB format that uses run-length encoding (RLE) compression for bitmaps with 8 bits per pixel. The compression uses a 2-byte format consisting of a count byte followed by a byte containing a color index.

BI_RLE4

public static final HwmfBitmapDib.Compression BI_RLE4

An RGB format that uses RLE compression for bitmaps with 4 bits per pixel. The compression uses a 2-byte format consisting of a count byte followed by two word-length color indexes.

BI_BITFIELDS

public static final HwmfBitmapDib.Compression BI_BITFIELDS

The bitmap is not compressed and the color table consists of three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16 and 32-bits per pixel bitmaps.

BI_JPEG

public static final HwmfBitmapDib.Compression BI_JPEG

The image is a JPEG image, as specified in [JFIF]. This value SHOULD only be used in certain bitmap operations, such as JPEG pass-through. The application MUST query for the pass-through support, since not all devices support JPEG pass-through. Using non-RGB bitmaps MAY limit the portability of the metafile to other devices. For instance, display device contexts generally do not support this pass-through.

BI_PNG

public static final HwmfBitmapDib.Compression BI_PNG

The image is a PNG image, as specified in [RFC2083]. This value SHOULD only be used certain bitmap operations, such as JPEG/PNG pass-through. The application MUST query for the pass-through support, because not all devices support JPEG/PNG pass-through. Using non-RGB bitmaps MAY limit the portability of the metafile to other devices. For instance, display device contexts generally do not support this pass-through.

BI_CMYK

public static final HwmfBitmapDib.Compression BI_CMYK

The image is an uncompressed CMYK format.

BI_CMYKRLE8

public static final HwmfBitmapDib.Compression BI_CMYKRLE8

A CMYK format that uses RLE compression for bitmaps with 8 bits per pixel. The compression uses a 2-byte format consisting of a count byte followed by a byte containing a color index.

BI_CMYKRLE4

public static final HwmfBitmapDib.Compression BI_CMYKRLE4

A CMYK format that uses RLE compression for bitmaps with 4 bits per pixel. The compression uses a 2-byte format consisting of a count byte followed by two word-length color indexes.

Method Detail

values

public static HwmfBitmapDib.Compression[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HwmfBitmapDib.Compression c : HwmfBitmapDib.Compression.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HwmfBitmapDib.Compression valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null