net.rim.device.api.system
Class BMPEncodedImage

java.lang.Object
  net.rim.device.api.system.EncodedImage
      net.rim.device.api.system.BMPEncodedImage

public final class BMPEncodedImage
extends EncodedImage

Represents an image encoded in the Windows Bitmap (BMP) format.

To create a BMPEncodedImage instance, use the EncodedImage.createEncodedImage(byte[],int,int) method. The createEncodedImage method accepts a java byte array containing the encoding of an image.

An image encoding can be obtained by either of the following methods:

First, when an image is added to a project in the IDE, the image resource becomes available to the developer.

Second, the image encoding can be obtained manually by converting the binary image file to a java byte array. This is accomplished using the following procedure:

1. Using a binary file converter, such as xxd, convert the image to a C-style byte array.
2. Open the target file and search for the string "0x".
3. Replace the string with the following "(byte)0x".
4. Adjust the array declaration at the top of the file to conform to Java standards.
5. Remove the following string from the bottom of the file "unsigned int input_file_name_len = XXXX".

If done correctly, the file will contain a valid java byte array containing the image encoding.

Since:

BlackBerry API 4.0.2

Field Summary

Fields inherited from class net.rim.device.api.system.EncodedImage

DECODE_ALPHA, DECODE_NATIVE, DECODE_NO_DITHER, DECODE_READONLY, IMAGE_TYPE_BMP, IMAGE_TYPE_GIF, IMAGE_TYPE_ICO, IMAGE_TYPE_JPEG, IMAGE_TYPE_PNG, IMAGE_TYPE_TIFF, IMAGE_TYPE_WBMP

Method Summary
int	getBitDepth() Returns the bit depth.
int	getBitmapType(int frameIndex) Gets the bitmap type for the given frame.
String	getMIMEType() Return the commonly known MIME type associate for this encoded image object.

Methods inherited from class net.rim.device.api.system.EncodedImage

createEncodedImage, createEncodedImage, getAlphaType, getBitmap, getBitmap, getData, getDecodeMode, getEncodedImageResource, getEncodedImageResource, getFrameCount, getFrameHeight, getFrameMonochrome, getFrameTransparency, getFrameWidth, getHeight, getImageHeight, getImageType, getImageWidth, getLength, getMetaData, getOffset, getScale, getScaleX32, getScaleY32, getScaledFrameHeight, getScaledFrameWidth, getScaledHeight, getScaledHeight, getScaledWidth, getScaledWidth, getSupportedMIMETypes, getWidth, hasTransparency, isAnimated, isMIMETypeSupported, isMonochrome, scaleImage32, scaleImageToFill, setDecodeMode, setScale

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBitDepth

public int getBitDepth()

Returns the bit depth.

Returns:

The BMP bit depth.

Since:

BlackBerry API 4.0.2

getBitmapType

public int getBitmapType(int frameIndex)

Description copied from class: EncodedImage

Gets the bitmap type for the given frame.

Specified by:

getBitmapType in class EncodedImage

Parameters:

frameIndex - The index of the frame for which to return the bitmap type.

Returns:

The type of bitmap that will be decoded with a call to getBitmap.

Since:

BlackBerry API 4.0.2

getMIMEType

public String getMIMEType()

Return the commonly known MIME type associate for this encoded image object.

Specified by:

getMIMEType in class EncodedImage

Returns:

A String representing the MIME type generally associated with this object.

Since:

BlackBerry API 4.2.0