File	Doc	Category	Size	Date	Package
MemoryImageSource.java	API Doc	Java SE 5 API	18885	Fri Aug 26 14:56:54 BST 2005	java.awt.image

MemoryImageSource

• java.lang.Object

int w = 100;
int h = 100;
int pix[] = new int[w * h];
int index = 0;
for (int y = 0; y < h; y++) {
int red = (y * 255) / (h - 1);
for (int x = 0; x < w; x++) {
int blue = (x * 255) / (w - 1);
pix[index++] = (255 << 24) | (red << 16) | blue;
}
}
Image img = createImage(new MemoryImageSource(w, h, pix, 0, w));

int pixels[];
MemoryImageSource source;

public void init() {
int width = 50;
int height = 50;
int size = width * height;
pixels = new int[size];

int value = getBackground().getRGB();
for (int i = 0; i < size; i++) {
pixels[i] = value;
}

source = new MemoryImageSource(width, height, pixels, 0, width);
source.setAnimated(true);
image = createImage(source);
}

public void run() {
Thread me = Thread.currentThread( );
me.setPriority(Thread.MIN_PRIORITY);

while (true) {
try {
thread.sleep(10);
} catch( InterruptedException e ) {
return;
}

// Modify the values in the pixels array at (x, y, w, h)

// Send the new data to the interested ImageConsumers
source.newPixels(x, y, w, h);
}
}

Fields Summary
int	width
int	height
ColorModel	model
Object	pixels
int	pixeloffset
int	pixelscan
Hashtable	properties
Vector	theConsumers
boolean	animating
boolean	fullbuffers

Constructors Summary
public MemoryImageSource(int w, int h, ColorModel cm, byte[] pix, int off, int scan) Constructs an ImageProducer object which uses an array of bytes to produce data for an Image object. param w the width of the rectangle of pixels param h the height of the rectangle of pixels param cm the specified ColorModel param pix an array of pixels param off the offset into the array of where to store the first pixel param scan the distance from one row of pixels to the next in the array see java.awt.Component#createImage initialize(w, h, cm, (Object) pix, off, scan, null);
public MemoryImageSource(int w, int h, ColorModel cm, byte[] pix, int off, int scan, Hashtable props) Constructs an ImageProducer object which uses an array of bytes to produce data for an Image object. param w the width of the rectangle of pixels param h the height of the rectangle of pixels param cm the specified ColorModel param pix an array of pixels param off the offset into the array of where to store the first pixel param scan the distance from one row of pixels to the next in the array param props a list of properties that the ImageProducer uses to process an image see java.awt.Component#createImage initialize(w, h, cm, (Object) pix, off, scan, props);
public MemoryImageSource(int w, int h, ColorModel cm, int[] pix, int off, int scan) Constructs an ImageProducer object which uses an array of integers to produce data for an Image object. param w the width of the rectangle of pixels param h the height of the rectangle of pixels param cm the specified ColorModel param pix an array of pixels param off the offset into the array of where to store the first pixel param scan the distance from one row of pixels to the next in the array see java.awt.Component#createImage initialize(w, h, cm, (Object) pix, off, scan, null);
public MemoryImageSource(int w, int h, ColorModel cm, int[] pix, int off, int scan, Hashtable props) Constructs an ImageProducer object which uses an array of integers to produce data for an Image object. param w the width of the rectangle of pixels param h the height of the rectangle of pixels param cm the specified ColorModel param pix an array of pixels param off the offset into the array of where to store the first pixel param scan the distance from one row of pixels to the next in the array param props a list of properties that the ImageProducer uses to process an image see java.awt.Component#createImage initialize(w, h, cm, (Object) pix, off, scan, props);
public MemoryImageSource(int w, int h, int[] pix, int off, int scan) Constructs an ImageProducer object which uses an array of integers in the default RGB ColorModel to produce data for an Image object. param w the width of the rectangle of pixels param h the height of the rectangle of pixels param pix an array of pixels param off the offset into the array of where to store the first pixel param scan the distance from one row of pixels to the next in the array see java.awt.Component#createImage see ColorModel#getRGBdefault initialize(w, h, ColorModel.getRGBdefault(), (Object) pix, off, scan, null);
public MemoryImageSource(int w, int h, int[] pix, int off, int scan, Hashtable props) Constructs an ImageProducer object which uses an array of integers in the default RGB ColorModel to produce data for an Image object. param w the width of the rectangle of pixels param h the height of the rectangle of pixels param pix an array of pixels param off the offset into the array of where to store the first pixel param scan the distance from one row of pixels to the next in the array param props a list of properties that the ImageProducer uses to process an image see java.awt.Component#createImage see ColorModel#getRGBdefault initialize(w, h, ColorModel.getRGBdefault(), (Object) pix, off, scan, props);

Methods Summary
public synchronized void	addConsumer(java.awt.image.ImageConsumer ic) Adds an ImageConsumer to the list of consumers interested in data for this image. param ic the specified ImageConsumer throws NullPointerException if the specified ImageConsumer is null see ImageConsumer if (theConsumers.contains(ic)) { return; } theConsumers.addElement(ic); try { initConsumer(ic); sendPixels(ic, 0, 0, width, height); if (isConsumer(ic)) { ic.imageComplete(animating ? ImageConsumer.SINGLEFRAMEDONE : ImageConsumer.STATICIMAGEDONE); if (!animating && isConsumer(ic)) { ic.imageComplete(ImageConsumer.IMAGEERROR); removeConsumer(ic); } } } catch (Exception e) { if (isConsumer(ic)) { ic.imageComplete(ImageConsumer.IMAGEERROR); } }
private void	initConsumer(java.awt.image.ImageConsumer ic) if (isConsumer(ic)) { ic.setDimensions(width, height); } if (isConsumer(ic)) { ic.setProperties(properties); } if (isConsumer(ic)) { ic.setColorModel(model); } if (isConsumer(ic)) { ic.setHints(animating ? (fullbuffers ? (ImageConsumer.TOPDOWNLEFTRIGHT | ImageConsumer.COMPLETESCANLINES) : ImageConsumer.RANDOMPIXELORDER) : (ImageConsumer.TOPDOWNLEFTRIGHT | ImageConsumer.COMPLETESCANLINES | ImageConsumer.SINGLEPASS | ImageConsumer.SINGLEFRAME)); }
private void	initialize(int w, int h, java.awt.image.ColorModel cm, java.lang.Object pix, int off, int scan, java.util.Hashtable props) width = w; height = h; model = cm; pixels = pix; pixeloffset = off; pixelscan = scan; if (props == null) { props = new Hashtable(); } properties = props;
public synchronized boolean	isConsumer(java.awt.image.ImageConsumer ic) Determines if an ImageConsumer is on the list of consumers currently interested in data for this image. param ic the specified ImageConsumer return true if the ImageConsumer is on the list; false otherwise. see ImageConsumer return theConsumers.contains(ic);
public void	newPixels() Sends a whole new buffer of pixels to any ImageConsumers that are currently interested in the data for this image and notify them that an animation frame is complete. This method only has effect if the animation flag has been turned on through the setAnimated() method. see #newPixels(int, int, int, int, boolean) see ImageConsumer see #setAnimated newPixels(0, 0, width, height, true);
public synchronized void	newPixels(int x, int y, int w, int h) Sends a rectangular region of the buffer of pixels to any ImageConsumers that are currently interested in the data for this image and notify them that an animation frame is complete. This method only has effect if the animation flag has been turned on through the setAnimated() method. If the full buffer update flag was turned on with the setFullBufferUpdates() method then the rectangle parameters will be ignored and the entire buffer will always be sent. param x the x coordinate of the upper left corner of the rectangle of pixels to be sent param y the y coordinate of the upper left corner of the rectangle of pixels to be sent param w the width of the rectangle of pixels to be sent param h the height of the rectangle of pixels to be sent see #newPixels(int, int, int, int, boolean) see ImageConsumer see #setAnimated see #setFullBufferUpdates newPixels(x, y, w, h, true);
public synchronized void	newPixels(int x, int y, int w, int h, boolean framenotify) Sends a rectangular region of the buffer of pixels to any ImageConsumers that are currently interested in the data for this image. If the framenotify parameter is true then the consumers are also notified that an animation frame is complete. This method only has effect if the animation flag has been turned on through the setAnimated() method. If the full buffer update flag was turned on with the setFullBufferUpdates() method then the rectangle parameters will be ignored and the entire buffer will always be sent. param x the x coordinate of the upper left corner of the rectangle of pixels to be sent param y the y coordinate of the upper left corner of the rectangle of pixels to be sent param w the width of the rectangle of pixels to be sent param h the height of the rectangle of pixels to be sent param framenotify true if the consumers should be sent a {@link ImageConsumer#SINGLEFRAMEDONE SINGLEFRAMEDONE} notification see ImageConsumer see #setAnimated see #setFullBufferUpdates if (animating) { if (fullbuffers) { x = y = 0; w = width; h = height; } else { if (x < 0) { w += x; x = 0; } if (x + w > width) { w = width - x; } if (y < 0) { h += y; y = 0; } if (y + h > height) { h = height - y; } } if ((w <= 0 || h <= 0) && !framenotify) { return; } Enumeration enum_ = theConsumers.elements(); while (enum_.hasMoreElements()) { ImageConsumer ic = (ImageConsumer) enum_.nextElement(); if (w > 0 && h > 0) { sendPixels(ic, x, y, w, h); } if (framenotify && isConsumer(ic)) { ic.imageComplete(ImageConsumer.SINGLEFRAMEDONE); } } }
public synchronized void	newPixels(byte[] newpix, java.awt.image.ColorModel newmodel, int offset, int scansize) Changes to a new byte array to hold the pixels for this image. If the animation flag has been turned on through the setAnimated() method, then the new pixels will be immediately delivered to any ImageConsumers that are currently interested in the data for this image. param newpix the new pixel array param newmodel the specified ColorModel param offset the offset into the array param scansize the distance from one row of pixels to the next in the array see #newPixels(int, int, int, int, boolean) see #setAnimated this.pixels = newpix; this.model = newmodel; this.pixeloffset = offset; this.pixelscan = scansize; newPixels();
public synchronized void	newPixels(int[] newpix, java.awt.image.ColorModel newmodel, int offset, int scansize) Changes to a new int array to hold the pixels for this image. If the animation flag has been turned on through the setAnimated() method, then the new pixels will be immediately delivered to any ImageConsumers that are currently interested in the data for this image. param newpix the new pixel array param newmodel the specified ColorModel param offset the offset into the array param scansize the distance from one row of pixels to the next in the array see #newPixels(int, int, int, int, boolean) see #setAnimated this.pixels = newpix; this.model = newmodel; this.pixeloffset = offset; this.pixelscan = scansize; newPixels();
public synchronized void	removeConsumer(java.awt.image.ImageConsumer ic) Removes an ImageConsumer from the list of consumers interested in data for this image. param ic the specified ImageConsumer see ImageConsumer theConsumers.removeElement(ic);
public void	requestTopDownLeftRightResend(java.awt.image.ImageConsumer ic) Requests that a given ImageConsumer have the image data delivered one more time in top-down, left-right order. param ic the specified ImageConsumer see ImageConsumer // Ignored. The data is either single frame and already in TDLR // format or it is multi-frame and TDLR resends aren't critical.
private void	sendPixels(java.awt.image.ImageConsumer ic, int x, int y, int w, int h) int off = pixeloffset + pixelscan * y + x; if (isConsumer(ic)) { if (pixels instanceof byte[]) { ic.setPixels(x, y, w, h, model, ((byte[]) pixels), off, pixelscan); } else { ic.setPixels(x, y, w, h, model, ((int[]) pixels), off, pixelscan); } }
public synchronized void	setAnimated(boolean animated) Changes this memory image into a multi-frame animation or a single-frame static image depending on the animated parameter. This method should be called immediately after the MemoryImageSource is constructed and before an image is created with it to ensure that all ImageConsumers will receive the correct multi-frame data. If an ImageConsumer is added to this ImageProducer before this flag is set then that ImageConsumer will see only a snapshot of the pixel data that was available when it connected. param animated true if the image is a multi-frame animation this.animating = animated; if (!animating) { Enumeration enum_ = theConsumers.elements(); while (enum_.hasMoreElements()) { ImageConsumer ic = (ImageConsumer) enum_.nextElement(); ic.imageComplete(ImageConsumer.STATICIMAGEDONE); if (isConsumer(ic)) { ic.imageComplete(ImageConsumer.IMAGEERROR); } } theConsumers.removeAllElements(); }
public synchronized void	setFullBufferUpdates(boolean fullbuffers) Specifies whether this animated memory image should always be updated by sending the complete buffer of pixels whenever there is a change. This flag is ignored if the animation flag is not turned on through the setAnimated() method. This method should be called immediately after the MemoryImageSource is constructed and before an image is created with it to ensure that all ImageConsumers will receive the correct pixel delivery hints. param fullbuffers true if the complete pixel buffer should always be sent see #setAnimated if (this.fullbuffers == fullbuffers) { return; } this.fullbuffers = fullbuffers; if (animating) { Enumeration enum_ = theConsumers.elements(); while (enum_.hasMoreElements()) { ImageConsumer ic = (ImageConsumer) enum_.nextElement(); ic.setHints(fullbuffers ? (ImageConsumer.TOPDOWNLEFTRIGHT | ImageConsumer.COMPLETESCANLINES) : ImageConsumer.RANDOMPIXELORDER); } }
public void	startProduction(java.awt.image.ImageConsumer ic) Adds an ImageConsumer to the list of consumers interested in data for this image and immediately starts delivery of the image data through the ImageConsumer interface. param ic the specified ImageConsumer image data through the ImageConsumer interface. see ImageConsumer addConsumer(ic);