public class

OffScreenImage

extends BufferedImage

java.lang.Object
↳	java.awt.Image
	↳	java.awt.image.BufferedImage
		↳	sun.awt.image.OffScreenImage

Class Overview

This is a special variant of BufferedImage that keeps a reference to a Component. The Component's foreground and background colors and default font are used as the defaults for this image.

Summary

[Expand]

Inherited Constants

From class java.awt.image.BufferedImage

int	TYPE_3BYTE_BGR	Represents an image with 8-bit RGB color components, corresponding to a Windows-style BGR color model) with the colors Blue, Green, and Red stored in 3 bytes.
int	TYPE_4BYTE_ABGR	Represents an image with 8-bit RGBA color components with the colors Blue, Green, and Red stored in 3 bytes and 1 byte of alpha.
int	TYPE_4BYTE_ABGR_PRE	Represents an image with 8-bit RGBA color components with the colors Blue, Green, and Red stored in 3 bytes and 1 byte of alpha.
int	TYPE_BYTE_BINARY	Represents an opaque byte-packed 1, 2, or 4 bit image.
int	TYPE_BYTE_GRAY	Represents a unsigned byte grayscale image, non-indexed.
int	TYPE_BYTE_INDEXED	Represents an indexed byte image.
int	TYPE_CUSTOM	Image type is not recognized so it must be a customized image.
int	TYPE_INT_ARGB	Represents an image with 8-bit RGBA color components packed into integer pixels.
int	TYPE_INT_ARGB_PRE	Represents an image with 8-bit RGBA color components packed into integer pixels.
int	TYPE_INT_BGR	Represents an image with 8-bit RGB color components, corresponding to a Windows- or Solaris- style BGR color model, with the colors Blue, Green, and Red packed into integer pixels.
int	TYPE_INT_RGB	Represents an image with 8-bit RGB color components packed into integer pixels.
int	TYPE_USHORT_555_RGB	Represents an image with 5-5-5 RGB color components (5-bits red, 5-bits green, 5-bits blue) with no alpha.
int	TYPE_USHORT_565_RGB	Represents an image with 5-6-5 RGB color components (5-bits red, 6-bits green, 5-bits blue) with no alpha.
int	TYPE_USHORT_GRAY	Represents an unsigned short grayscale image, non-indexed).

From class java.awt.Image

From interface java.awt.Transparency

Fields
protected Component	c

[Expand]

Inherited Fields

From class java.awt.Image

Public Constructors
	OffScreenImage(Component c, ColorModel cm, WritableRaster raster, boolean isRasterPremultiplied) Constructs an OffScreenImage given a color model and tile, for offscreen rendering to be used with a given component.

Public Methods
Graphics2D	createGraphics() Creates a `Graphics2D`, which can be used to draw into this `BufferedImage`.
Graphics	getGraphics() This method returns a `Graphics2D`, but is here for backwards compatibility.
ImageProducer	getSource() Returns the object that produces the pixels for the image.

[Expand]

Inherited Methods

From class java.awt.image.BufferedImage

void	addTileObserver(TileObserver to) Adds a tile observer.
void	coerceData(boolean isAlphaPremultiplied) Forces the data to match the state specified in the `isAlphaPremultiplied` variable.
WritableRaster	copyData(WritableRaster outRaster) Computes an arbitrary rectangular region of the `BufferedImage` and copies it into a specified `WritableRaster`.
Graphics2D	createGraphics() Creates a `Graphics2D`, which can be used to draw into this `BufferedImage`.
WritableRaster	getAlphaRaster() Returns a `WritableRaster` representing the alpha channel for `BufferedImage` objects with `ColorModel` objects that support a separate spatial alpha channel, such as `ComponentColorModel` and `DirectColorModel`.
ColorModel	getColorModel() Returns the `ColorModel`.
Raster	getData(Rectangle rect) Computes and returns an arbitrary region of the `BufferedImage`.
Raster	getData() Returns the image as one large tile.
Graphics	getGraphics() This method returns a `Graphics2D`, but is here for backwards compatibility.
int	getHeight() Returns the height of the `BufferedImage`.
int	getHeight(ImageObserver observer) Returns the height of the `BufferedImage`.
int	getMinTileX() Returns the minimum tile index in the x direction.
int	getMinTileY() Returns the minimum tile index in the y direction.
int	getMinX() Returns the minimum x coordinate of this `BufferedImage`.
int	getMinY() Returns the minimum y coordinate of this `BufferedImage`.
int	getNumXTiles() Returns the number of tiles in the x direction.
int	getNumYTiles() Returns the number of tiles in the y direction.
Object	getProperty(String name) Returns a property of the image by name.
Object	getProperty(String name, ImageObserver observer) Returns a property of the image by name.
String[]	getPropertyNames() Returns an array of names recognized by `getProperty(String)` or `null`, if no property names are recognized.
int[]	getRGB(int startX, int startY, int w, int h, int[] rgbArray, int offset, int scansize) Returns an array of integer pixels in the default RGB color model (TYPE_INT_ARGB) and default sRGB color space, from a portion of the image data.
int	getRGB(int x, int y) Returns an integer pixel in the default RGB color model (TYPE_INT_ARGB) and default sRGB colorspace.
WritableRaster	getRaster() Returns the `WritableRaster`.
SampleModel	getSampleModel() Returns the `SampleModel` associated with this `BufferedImage`.
ImageProducer	getSource() Returns the object that produces the pixels for the image.
Vector<RenderedImage>	getSources() Returns a `Vector` of `RenderedImage` objects that are the immediate sources, not the sources of these immediate sources, of image data for this `BufferedImage`.
BufferedImage	getSubimage(int x, int y, int w, int h) Returns a subimage defined by a specified rectangular region.
Raster	getTile(int tileX, int tileY) Returns tile (`tileX`, `tileY`).
int	getTileGridXOffset() Returns the x offset of the tile grid relative to the origin, For example, the x coordinate of the location of tile (0, 0).
int	getTileGridYOffset() Returns the y offset of the tile grid relative to the origin, For example, the y coordinate of the location of tile (0, 0).
int	getTileHeight() Returns the tile height in pixels.
int	getTileWidth() Returns the tile width in pixels.
int	getTransparency() Returns the transparency.
int	getType() Returns the image type.
int	getWidth() Returns the width of the `BufferedImage`.
int	getWidth(ImageObserver observer) Returns the width of the `BufferedImage`.
WritableRaster	getWritableTile(int tileX, int tileY) Checks out a tile for writing.
Point[]	getWritableTileIndices() Returns an array of `Point` objects indicating which tiles are checked out for writing.
boolean	hasTileWriters() Returns whether or not any tile is checked out for writing.
boolean	isAlphaPremultiplied() Returns whether or not the alpha has been premultiplied.
boolean	isTileWritable(int tileX, int tileY) Returns whether or not a tile is currently checked out for writing.
void	releaseWritableTile(int tileX, int tileY) Relinquishes permission to write to a tile.
void	removeTileObserver(TileObserver to) Removes a tile observer.
void	setData(Raster r) Sets a rectangular region of the image to the contents of the specified `Raster` `r`, which is assumed to be in the same coordinate space as the `BufferedImage`.
synchronized void	setRGB(int x, int y, int rgb) Sets a pixel in this `BufferedImage` to the specified RGB value.
void	setRGB(int startX, int startY, int w, int h, int[] rgbArray, int offset, int scansize) Sets an array of integer pixels in the default RGB color model (TYPE_INT_ARGB) and default sRGB color space, into a portion of the image data.
String	toString() Returns a `String` representation of this `BufferedImage` object and its values.

From class java.awt.Image

void	flush() Flushes all reconstructable resources being used by this Image object.
float	getAccelerationPriority() Returns the current value of the acceleration priority hint.
ImageCapabilities	getCapabilities(GraphicsConfiguration gc) Returns an ImageCapabilities object which can be inquired as to the capabilities of this Image on the specified GraphicsConfiguration.
abstract Graphics	getGraphics() Creates a graphics context for drawing to an off-screen image.
abstract int	getHeight(ImageObserver observer) Determines the height of the image.
abstract Object	getProperty(String name, ImageObserver observer) Gets a property of this image by name.
Image	getScaledInstance(int width, int height, int hints) Creates a scaled version of this image.
abstract ImageProducer	getSource() Gets the object that produces the pixels for the image.
abstract int	getWidth(ImageObserver observer) Determines the width of the image.
void	setAccelerationPriority(float priority) Sets a hint for this image about how important acceleration is.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.Transparency

From interface java.awt.image.RenderedImage

abstract WritableRaster	copyData(WritableRaster raster) Computes an arbitrary rectangular region of the RenderedImage and copies it into a caller-supplied WritableRaster.
abstract ColorModel	getColorModel() Returns the ColorModel associated with this image.
abstract Raster	getData(Rectangle rect) Computes and returns an arbitrary region of the RenderedImage.
abstract Raster	getData() Returns the image as one large tile (for tile based images this will require fetching the whole image and copying the image data over).
abstract int	getHeight() Returns the height of the RenderedImage.
abstract int	getMinTileX() Returns the minimum tile index in the X direction.
abstract int	getMinTileY() Returns the minimum tile index in the Y direction.
abstract int	getMinX() Returns the minimum X coordinate (inclusive) of the RenderedImage.
abstract int	getMinY() Returns the minimum Y coordinate (inclusive) of the RenderedImage.
abstract int	getNumXTiles() Returns the number of tiles in the X direction.
abstract int	getNumYTiles() Returns the number of tiles in the Y direction.
abstract Object	getProperty(String name) Gets a property from the property set of this image.
abstract String[]	getPropertyNames() Returns an array of names recognized by `getProperty(String)` or `null`, if no property names are recognized.
abstract SampleModel	getSampleModel() Returns the SampleModel associated with this image.
abstract Vector<RenderedImage>	getSources() Returns a vector of RenderedImages that are the immediate sources of image data for this RenderedImage.
abstract Raster	getTile(int tileX, int tileY) Returns tile (tileX, tileY).
abstract int	getTileGridXOffset() Returns the X offset of the tile grid relative to the origin, i.e., the X coordinate of the upper-left pixel of tile (0, 0).
abstract int	getTileGridYOffset() Returns the Y offset of the tile grid relative to the origin, i.e., the Y coordinate of the upper-left pixel of tile (0, 0).
abstract int	getTileHeight() Returns the tile height in pixels.
abstract int	getTileWidth() Returns the tile width in pixels.
abstract int	getWidth() Returns the width of the RenderedImage.

From interface java.awt.image.WritableRenderedImage

abstract void	addTileObserver(TileObserver to) Adds an observer.
abstract WritableRaster	getWritableTile(int tileX, int tileY) Checks out a tile for writing.
abstract Point[]	getWritableTileIndices() Returns an array of Point objects indicating which tiles are checked out for writing.
abstract boolean	hasTileWriters() Returns whether any tile is checked out for writing.
abstract boolean	isTileWritable(int tileX, int tileY) Returns whether a tile is currently checked out for writing.
abstract void	releaseWritableTile(int tileX, int tileY) Relinquishes the right to write to a tile.
abstract void	removeTileObserver(TileObserver to) Removes an observer.
abstract void	setData(Raster r) Sets a rect of the image to the contents of the Raster r, which is assumed to be in the same coordinate space as the WritableRenderedImage.

Fields

protected Component c

Public Constructors

public OffScreenImage (Component c, ColorModel cm, WritableRaster raster, boolean isRasterPremultiplied)

Constructs an OffScreenImage given a color model and tile, for offscreen rendering to be used with a given component. The component is used to obtain the foreground color, background color and font.

Public Methods

public Graphics2D createGraphics ()

Creates a Graphics2D, which can be used to draw into this BufferedImage.

Returns

a Graphics2D, used for drawing into this image.

public Graphics getGraphics ()

This method returns a Graphics2D, but is here for backwards compatibility. createGraphics is more convenient, since it is declared to return a Graphics2D.

Returns

a Graphics2D, which can be used to draw into this image.

public ImageProducer getSource ()

Returns the object that produces the pixels for the image.

Returns

the ImageProducer that is used to produce the pixels for this image.

Interfaces

Classes

Exceptions

OffScreenImage

Class Overview

Summary

Fields

protected Component c

Public Constructors

public OffScreenImage (Component c, ColorModel cm, WritableRaster raster, boolean isRasterPremultiplied)

Public Methods

public Graphics2D createGraphics ()

Returns

public Graphics getGraphics ()

Returns

public ImageProducer getSource ()

Returns