gnu.java.awt.peer.gtk

Class GtkImageConsumer

Implemented Interfaces:
ImageConsumer

public class GtkImageConsumer
extends Object
implements ImageConsumer

Helper class to GtkImage. Sits and gathers pixels for a GtkImage and then calls GtkImage.setImage().

Fields inherited from interface java.awt.image.ImageConsumer

COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT

Constructor Summary

GtkImageConsumer(GtkImage target, ImageProducer source)

Method Summary

void
imageComplete(int status)
The ImageProducer calls this method to indicate a single frame or the entire image is complete.
void
setColorModel(ColorModel model)
This ColorModel should indicate the model used by the majority of calls to setPixels.
void
setDimensions(int width, int height)
An ImageProducer indicates the size of the image being produced using this method.
void
setHints(int flags)
The ImageProducer should call this method with a bit mask of hints from any of RANDOMPIXELORDER, TOPDOWNLEFTRIGHT, COMPLETESCANLINES, SINGLEPASS, SINGLEFRAME.
void
setPixels(int x, int y, int width, int height, ColorModel cm, byte[] pixels, int offset, int scansize)
Deliver a subset of an ImageProducer's pixels to this ImageConsumer.
void
setPixels(int x, int y, int width, int height, ColorModel cm, int[] pixels, int offset, int scansize)
Deliver a subset of an ImageProducer's pixels to this ImageConsumer.
void
setProperties(Hashtable props)
An ImageProducer can set a list of properties associated with this image by using this method.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GtkImageConsumer

public GtkImageConsumer(GtkImage target,
                        ImageProducer source)

Method Details

imageComplete

public void imageComplete(int status)
The ImageProducer calls this method to indicate a single frame or the entire image is complete. The method is also used to indicate an error in loading or producing the image.
Specified by:
imageComplete in interface ImageConsumer
Parameters:
status - the status of image production, represented by a bitwise OR of ImageConsumer flags

setColorModel

public void setColorModel(ColorModel model)
This ColorModel should indicate the model used by the majority of calls to setPixels. Each call to setPixels could however indicate a different ColorModel.
Specified by:
setColorModel in interface ImageConsumer
Parameters:
model - the color model to be used most often by setPixels
See Also:
ColorModel

setDimensions

public void setDimensions(int width,
                          int height)
An ImageProducer indicates the size of the image being produced using this method.
Specified by:
setDimensions in interface ImageConsumer
Parameters:
width - the width of the image
height - the height of the image

setHints

public void setHints(int flags)
The ImageProducer should call this method with a bit mask of hints from any of RANDOMPIXELORDER, TOPDOWNLEFTRIGHT, COMPLETESCANLINES, SINGLEPASS, SINGLEFRAME.
Specified by:
setHints in interface ImageConsumer
Parameters:
flags - a bit mask of hints

setPixels

public void setPixels(int x,
                      int y,
                      int width,
                      int height,
                      ColorModel cm,
                      byte[] pixels,
                      int offset,
                      int scansize)
Deliver a subset of an ImageProducer's pixels to this ImageConsumer. Each element of the pixels array represents one pixel. The pixel data is formatted according to the color model model. The x and y parameters are the coordinates of the block of pixels being delivered to this ImageConsumer. They are specified relative to the top left corner of the image being produced. Likewise, w and h are the pixel block's dimensions.
Specified by:
setPixels in interface ImageConsumer
Parameters:
x - x coordinate of pixel block
y - y coordinate of pixel block
pixels - pixel block data
offset - offset into pixels array
scansize - width of one row in the pixel block

setPixels

public void setPixels(int x,
                      int y,
                      int width,
                      int height,
                      ColorModel cm,
                      int[] pixels,
                      int offset,
                      int scansize)
Deliver a subset of an ImageProducer's pixels to this ImageConsumer. Each element of the pixels array represents one pixel. The pixel data is formatted according to the color model model. The x and y parameters are the coordinates of the rectangular region of pixels being delivered to this ImageConsumer, specified relative to the top left corner of the image being produced. Likewise, w and h are the pixel region's dimensions.
Specified by:
setPixels in interface ImageConsumer
Parameters:
x - x coordinate of pixel block
y - y coordinate of pixel block
pixels - pixel block data
offset - offset into pixels array
scansize - width of one row in the pixel block

setProperties

public void setProperties(Hashtable props)
An ImageProducer can set a list of properties associated with this image by using this method.
Specified by:
setProperties in interface ImageConsumer
Parameters:
props - the list of properties associated with this image

GtkImageConsumer.java Copyright (C) 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.