public class

ToolkitImage

extends Image
java.lang.Object
   ↳ java.awt.Image
     ↳ sun.awt.image.ToolkitImage

Summary

[Expand]
Inherited Constants
From class java.awt.Image
[Expand]
Inherited Fields
From class java.awt.Image
Public Constructors
ToolkitImage(ImageProducer is)
Construct an image from an ImageProducer object.
Protected Constructors
ToolkitImage()
Public Methods
int check(ImageObserver iw)
void flush()
Flushes all reconstructable resources being used by this Image object.
BufferedImage getBufferedImage()
ColorModel getColorModel()
Graphics getGraphics()
Creates a graphics context for drawing to an off-screen image.
int getHeight()
Return the height of the original image source.
synchronized int getHeight(ImageObserver iw)
Return the height of the original image source.
synchronized ImageRepresentation getImageRep()
Object getProperty(String name, ImageObserver observer)
Return a property of the image by name.
ImageProducer getSource()
Gets the object that produces the pixels for the image.
int getWidth()
Return the width of the original image source.
synchronized int getWidth(ImageObserver iw)
Return the width of the original image source.
boolean hasError()
void preload(ImageObserver iw)
void setAccelerationPriority(float priority)
Sets a hint for this image about how important acceleration is.
Protected Methods
ImageRepresentation makeImageRep()
[Expand]
Inherited Methods
From class java.awt.Image
From class java.lang.Object

Public Constructors

public ToolkitImage (ImageProducer is)

Construct an image from an ImageProducer object.

Protected Constructors

protected ToolkitImage ()

Public Methods

public int check (ImageObserver iw)

public void flush ()

Flushes all reconstructable resources being used by this Image object. This includes any pixel data that is being cached for rendering to the screen as well as any system resources that are being used to store data or pixels for the image if they can be recreated. The image is reset to a state similar to when it was first created so that if it is again rendered, the image data will have to be recreated or fetched again from its source.

Examples of how this method affects specific types of Image object:

  • BufferedImage objects leave the primary Raster which stores their pixels untouched, but flush any information cached about those pixels such as copies uploaded to the display hardware for accelerated blits.
  • Image objects created by the Component methods which take a width and height leave their primary buffer of pixels untouched, but have all cached information released much like is done for BufferedImage objects.
  • VolatileImage objects release all of their pixel resources including their primary copy which is typically stored on the display hardware where resources are scarce. These objects can later be restored using their validate method.
  • Image objects created by the Toolkit and Component classes which are loaded from files, URLs or produced by an ImageProducer are unloaded and all local resources are released. These objects can later be reloaded from their original source as needed when they are rendered, just as when they were first created.

public BufferedImage getBufferedImage ()

public ColorModel getColorModel ()

public Graphics getGraphics ()

Creates a graphics context for drawing to an off-screen image. This method can only be called for off-screen images.

Returns
  • a graphics context to draw to the off-screen image.

public int getHeight ()

Return the height of the original image source. If the height isn't known, then the image is reconstructed.

public synchronized int getHeight (ImageObserver iw)

Return the height of the original image source. If the height isn't known, then the ImageObserver object will be notified when the data is available.

Parameters
iw an object waiting for the image to be loaded.
Returns
  • the height of this image, or -1 if the height is not yet known.

public synchronized ImageRepresentation getImageRep ()

public Object getProperty (String name, ImageObserver observer)

Return a property of the image by name. Individual property names are defined by the various image formats. If a property is not defined for a particular image, then this method will return the UndefinedProperty object. If the properties for this image are not yet known, then this method will return null and the ImageObserver object will be notified later. The property name "comment" should be used to store an optional comment which can be presented to the user as a description of the image, its source, or its author.

Parameters
name a property name.
observer an object waiting for this image to be loaded.
Returns
  • the value of the named property.

public ImageProducer getSource ()

Gets the object that produces the pixels for the image. This method is called by the image filtering classes and by methods that perform image conversion and scaling.

Returns
  • the image producer that produces the pixels for this image.

public int getWidth ()

Return the width of the original image source. If the width isn't known, then the image is reconstructed.

public synchronized int getWidth (ImageObserver iw)

Return the width of the original image source. If the width isn't known, then the ImageObserver object will be notified when the data is available.

Parameters
iw an object waiting for the image to be loaded.
Returns
  • the width of this image, or -1 if the width is not yet known.

public boolean hasError ()

public void preload (ImageObserver iw)

public void setAccelerationPriority (float priority)

Sets a hint for this image about how important acceleration is. This priority hint is used to compare to the priorities of other Image objects when determining how to use scarce acceleration resources such as video memory. When and if it is possible to accelerate this Image, if there are not enough resources available to provide that acceleration but enough can be freed up by de-accelerating some other image of lower priority, then that other Image may be de-accelerated in deference to this one. Images that have the same priority take up resources on a first-come, first-served basis.

Parameters
priority a value between 0 and 1, inclusive, where higher values indicate more importance for acceleration. A value of 0 means that this Image should never be accelerated. Other values are used simply to determine acceleration priority relative to other Images.

Protected Methods

protected ImageRepresentation makeImageRep ()