javax.media.jai.iterator
Class RectIterFactory

java.lang.Object
  javax.media.jai.iterator.RectIterFactory

public class RectIterFactory

extends Object

A factory class to instantiate instances of the RectIter and WritableRectIter interfaces on sources of type Raster, RenderedImage, and WritableRenderedImage.

See Also:

RectIter, WritableRectIter

Method Summary

static RectIter	create(Raster ras, Rectangle bounds) Constructs and returns an instance of RectIter suitable for iterating over the given bounding rectangle within the given Raster source.
static RectIter	create(RenderedImage im, Rectangle bounds) Constructs and returns an instance of RectIter suitable for iterating over the given bounding rectangle within the given RenderedImage source.
static WritableRectIter	createWritable(WritableRaster ras, Rectangle bounds) Constructs and returns an instance of WritableRectIter suitable for iterating over the given bounding rectangle within the given WritableRaster source.
static WritableRectIter	createWritable(WritableRenderedImage im, Rectangle bounds) Constructs and returns an instance of WritableRectIter suitable for iterating over the given bounding rectangle within the given WritableRenderedImage source.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RectIter create(RenderedImage im,
                              Rectangle bounds)

Constructs and returns an instance of RectIter suitable for iterating over the given bounding rectangle within the given RenderedImage source. If the bounds parameter is null, the entire image will be used.

Parameters:

im - a read-only RenderedImage source.

bounds - the bounding Rectangle for the iterator, or null.

Returns:

a RectIter allowing read-only access to the source.

create

public static RectIter create(Raster ras,
                              Rectangle bounds)

Constructs and returns an instance of RectIter suitable for iterating over the given bounding rectangle within the given Raster source. If the bounds parameter is null, the entire Raster will be used.

Parameters:

ras - a read-only Raster source.

bounds - the bounding Rectangle for the iterator, or null.

Returns:

a RectIter allowing read-only access to the source.

createWritable

public static WritableRectIter createWritable(WritableRenderedImage im,
                                              Rectangle bounds)

Constructs and returns an instance of WritableRectIter suitable for iterating over the given bounding rectangle within the given WritableRenderedImage source. If the bounds parameter is null, the entire image will be used.

Parameters:

im - a WritableRenderedImage source.

bounds - the bounding Rectangle for the iterator, or null.

Returns:

a WritableRectIter allowing read/write access to the source.

createWritable

public static WritableRectIter createWritable(WritableRaster ras,
                                              Rectangle bounds)

Constructs and returns an instance of WritableRectIter suitable for iterating over the given bounding rectangle within the given WritableRaster source. If the bounds parameter is null, the entire Raster will be used.

Parameters:

ras - a WritableRaster source.

bounds - the bounding Rectangle for the iterator, or null.

Returns:

a WritableRectIter allowing read/write access to the source.