FileDocCategorySizeDatePackage
ImageConsumer.javaAPI DocAndroid 1.5 API5858Wed May 06 22:41:54 BST 2009java.awt.image

ImageConsumer

public interface ImageConsumer
The ImageConsumer interface provides the data about the image and about how its data is delivered. A ImageProducer provides all of the information about the image using the methods defined in this interface.
since
Android 1.0

Fields Summary
public static final int
RANDOMPIXELORDER
The Constant RANDOMPIXELORDER indicates that the pixels are delivered in a random order.
public static final int
TOPDOWNLEFTRIGHT
The Constant TOPDOWNLEFTRIGHT indicates that the pixels are delivered in top-down, left-to-right order.
public static final int
COMPLETESCANLINES
The Constant COMPLETESCANLINES indicates that the pixels are delivered in complete scanline.
public static final int
SINGLEPASS
The Constant SINGLEPASS indicates that pixels are delivered in a single pass.
public static final int
SINGLEFRAME
The Constant SINGLEFRAME indicates that image consists of single frame.
public static final int
IMAGEERROR
The Constant IMAGEERROR indicates an image error during image producing.
public static final int
SINGLEFRAMEDONE
The Constant SINGLEFRAMEDONE indicates that only one of the image's frames is completed.
public static final int
STATICIMAGEDONE
The Constant STATICIMAGEDONE indicates that the image is completed.
public static final int
IMAGEABORTED
The Constant IMAGEABORTED indicates that the image producing process is aborted.
Constructors Summary
Methods Summary
public voidimageComplete(int status)
THis method is called in the one of the following cases:
  • The ImageProducer (for which this ImageConsumer is added) has been delivered all pixels of the source image.
  • A one frame of an animation has been completed.
  • An error while loading or producing of the image has occurred.

param
status the status of image producing.

public voidsetColorModel(java.awt.image.ColorModel model)
Sets the ColorModel object.

param
model the new ColorModel.

public voidsetDimensions(int width, int height)
Sets the dimensions of a source image.

param
width the width of the image.
param
height the height of the image.

public voidsetHints(int hintflags)
Sets the hint flags of pixels order, which is used by the ImageConsumer for obtaining pixels from the ImageProducer for which this ImageConsumer is added.

param
hintflags the mask of hint flags.

public voidsetPixels(int x, int y, int w, int h, java.awt.image.ColorModel model, int[] pixels, int off, int scansize)
Sets the pixels for the specified rectangular area of the image.

param
x the X coordinate of rectangular area.
param
y the Y coordinate of rectangular area.
param
w the width of rectangular area.
param
h the height of rectangular area.
param
model the specified ColorModel to be used for pixels converting.
param
pixels the array of pixels.
param
off the offset of pixels array.
param
scansize the distance from the one row of pixels to the next row in the specified array.

public voidsetPixels(int x, int y, int w, int h, java.awt.image.ColorModel model, byte[] pixels, int off, int scansize)
Sets the pixels for the specified rectangular area of the image.

param
x the X coordinate of rectangular area.
param
y the Y coordinate of rectangular area.
param
w the width of rectangular area.
param
h the height of rectangular area.
param
model the specified ColorModel to be used for pixels converting.
param
pixels the array of pixels.
param
off the offset of pixels array.
param
scansize the distance from the one row of pixels to the next row in the specified array.

public voidsetProperties(java.util.Hashtable props)
Sets the properties for the image associated with this ImageConsumer.

param
props the properties for the image associated with this ImageConsumer.