org.apache.batik.ext.awt.image.codec.util
public abstract class SimpleRenderedImage extends Object implements RenderedImage
RenderedImage
interface. Only the getTile()
method needs to be
implemented by subclasses. The instance variables must also be
filled in properly.
Normally in JAI PlanarImage
is used for this
purpose, but in the interest of modularity the
use of PlanarImage
has been avoided.
Field Summary | |
---|---|
protected ColorModel | colorModel The image's ColorModel. |
protected int | height The image's height in pixels. |
protected int | minX The X coordinate of the image's upper-left pixel. |
protected int | minY The Y coordinate of the image's upper-left pixel. |
protected Map | properties A Hashtable containing the image properties. |
protected SampleModel | sampleModel The image's SampleModel. |
protected List | sources The image's sources, stored in a Vector. |
protected int | tileGridXOffset The X coordinate of the upper-left pixel of tile (0, 0). |
protected int | tileGridYOffset The Y coordinate of the upper-left pixel of tile (0, 0). |
protected int | tileHeight The height of a tile. |
protected int | tileWidth The width of a tile. |
protected int | width The image's width in pixels. |
Constructor Summary | |
---|---|
SimpleRenderedImage() |
Method Summary | |
---|---|
WritableRaster | copyData(WritableRaster dest)
Copies an arbitrary rectangular region of the RenderedImage
into a caller-supplied WritableRaster. |
Rectangle | getBounds() Returns a Rectangle indicating the image bounds. |
ColorModel | getColorModel() Returns the ColorModel of the image. |
Raster | getData()
Returns the entire image in a single Raster. |
Raster | getData(Rectangle bounds)
Returns an arbitrary rectangular region of the RenderedImage
in a Raster. |
int | getHeight() Returns the height of the image. |
int | getMaxTileX()
Returns the horizontal index of the rightmost column of tiles.
getMaxTileX() is implemented in terms of getMaxX()
and so does not need to be implemented by subclasses. |
int | getMaxTileY()
Returns the vertical index of the bottom row of tiles. getMaxTileY()
is implemented in terms of getMaxY() and so does not need to
be implemented by subclasses. |
int | getMaxX()
Returns the X coordinate of the column immediatetely to the
right of the rightmost column of the image. getMaxX() is
implemented in terms of getMinX() and getWidth() and so does
not need to be implemented by subclasses. |
int | getMaxY()
Returns the Y coordinate of the row immediately below the
bottom row of the image. getMaxY() is implemented in terms of
getMinY() and getHeight() and so does not need to be
implemented by subclasses. |
int | getMinTileX()
Returns the horizontal index of the leftmost column of tiles.
getMinTileX() is implemented in terms of getMinX()
and so does not need to be implemented by subclasses. |
int | getMinTileY()
Returns the vertical index of the uppermost row of tiles. getMinTileY()
is implemented in terms of getMinY() and so does not need to be
implemented by subclasses. |
int | getMinX() Returns the X coordinate of the leftmost column of the image. |
int | getMinY() Returns the X coordinate of the uppermost row of the image. |
int | getNumXTiles()
Returns the number of tiles along the tile grid in the
horizontal direction. getNumXTiles() is implemented in terms
of getMinTileX() and getMaxTileX() and so does not need to be
implemented by subclasses. |
int | getNumYTiles()
Returns the number of tiles along the tile grid in the vertical
direction. getNumYTiles() is implemented in terms
of getMinTileY() and getMaxTileY() and so does not need to be
implemented by subclasses. |
Object | getProperty(String name)
Gets a property from the property set of this image. |
String[] | getPropertyNames()
Returns a list of the properties recognized by this image. |
String[] | getPropertyNames(String prefix)
Returns an array of String s recognized as names by
this property source that begin with the supplied prefix. |
SampleModel | getSampleModel() Returns the SampleModel of the image. |
Vector | getSources() |
int | getTileGridXOffset()
Returns the X coordinate of the upper-left pixel of tile (0, 0). |
int | getTileGridYOffset()
Returns the Y coordinate of the upper-left pixel of tile (0, 0). |
int | getTileHeight() Returns the height of a tile. |
int | getTileWidth() Returns the width of a tile. |
int | getWidth() Returns the width of the image. |
static int | tileXToX(int tx, int tileGridXOffset, int tileWidth)
Converts a horizontal tile index into the X coordinate of its
upper left pixel relative to a given tile grid layout specified
by its X offset and tile width. |
int | tileXToX(int tx)
Converts a horizontal tile index into the X coordinate of its
upper left pixel. |
static int | tileYToY(int ty, int tileGridYOffset, int tileHeight)
Converts a vertical tile index into the Y coordinate of
its upper left pixel relative to a given tile grid layout
specified by its Y offset and tile height. |
int | tileYToY(int ty)
Converts a vertical tile index into the Y coordinate of its
upper left pixel. |
static int | XToTileX(int x, int tileGridXOffset, int tileWidth)
Converts a pixel's X coordinate into a horizontal tile index
relative to a given tile grid layout specified by its X offset
and tile width. |
int | XToTileX(int x)
Converts a pixel's X coordinate into a horizontal tile index.
|
static int | YToTileY(int y, int tileGridYOffset, int tileHeight)
Converts a pixel's Y coordinate into a vertical tile index
relative to a given tile grid layout specified by its Y offset
and tile height. |
int | YToTileY(int y)
Converts a pixel's Y coordinate into a vertical tile index.
|
If the raster argument is null, the entire image will be copied into a newly-created WritableRaster with a SampleModel that is compatible with that of the image.
Parameters: dest a WritableRaster to hold the returned portion of the image.
Returns: a reference to the supplied WritableRaster, or to a new WritableRaster if the supplied one was null.
The returned Raster is semantically a copy. This means that updates to the source image will not be reflected in the returned Raster. For non-writable (immutable) source images, the returned value may be a reference to the image's internal data. The returned Raster should be considered non-writable; any attempt to alter its pixel data (such as by casting it to WritableRaster or obtaining and modifying its DataBuffer) may result in undefined behavior. The copyData method should be used if the returned Raster is to be modified.
Returns: a Raster containing a copy of this image's data.
The returned Raster is semantically a copy. This means that updates to the source image will not be reflected in the returned Raster. For non-writable (immutable) source images, the returned value may be a reference to the image's internal data. The returned Raster should be considered non-writable; any attempt to alter its pixel data (such as by casting it to WritableRaster or obtaining and modifying its DataBuffer) may result in undefined behavior. The copyData method should be used if the returned Raster is to be modified.
Parameters: bounds the region of the RenderedImage to be returned.
null
will be returned.
Parameters: name the name of the property to get, as a
String
.
Returns: a reference to the property
Object
, or the value null
Returns: an array of String
s representing valid
property names.
String
s recognized as names by
this property source that begin with the supplied prefix. If
no property names match, null
will be returned.
The comparison is done in a case-independent manner.
The default implementation calls
getPropertyNames()
and searches the list of names
for matches.
Returns: an array of String
s giving the valid
property names (can be null).
Parameters: tx the horizontal index of a tile.
Returns: the X coordinate of the tile's upper left pixel.
Parameters: ty the vertical index of a tile.
Returns: the Y coordinate of the tile's upper left pixel.
Parameters: x the X coordinate of a pixel.
Returns: the X index of the tile containing the pixel.
Parameters: y the Y coordinate of a pixel.
Returns: the Y index of the tile containing the pixel.