java.awt

Class Image

Known Direct Subclasses:
AsyncImage, AsyncImage, BufferedImage, GtkImage, QtImage, VolatileImage, XImage, XOffScreenImage

public abstract class Image
extends Object

This is the abstract superclass of all image objects in Java.
Since:
1.0

Field Summary

static int
SCALE_AREA_AVERAGING
Constant indicating that the area averaging scaling algorithm should be used.
static int
SCALE_DEFAULT
Constant indicating that the default scaling algorithm should be used.
static int
SCALE_FAST
Constant indicating that a fast scaling algorithm should be used.
static int
SCALE_REPLICATE
Constant indicating that the ReplicateScaleFilter class algorithm should be used for scaling.
static int
SCALE_SMOOTH
Constant indicating that a smooth scaling algorithm should be used.
static Object
UndefinedProperty
This variable is returned whenever a property that is not defined is requested.
protected float
accelerationPriority
The acceleration priority of the image

Constructor Summary

Image()
A default constructor for subclasses.

Method Summary

abstract void
flush()
Flushes (that is, destroys) any resources used for this image.
float
getAccelerationPriority()
Returns the acceleration priority of the image.
abstract Graphics
getGraphics()
Returns a graphics context object for drawing an off-screen object.
abstract int
getHeight(ImageObserver observer)
Returns the height of the image, or -1 if it is unknown.
abstract Object
getProperty(String name, ImageObserver observer)
This method requests a named property for an object.
Image
getScaledInstance(int width, int height, int flags)
Scales the image to the requested dimension.
abstract ImageProducer
getSource()
Returns the image producer object for this object.
abstract int
getWidth(ImageObserver observer)
Returns the width of the image, or -1 if it is unknown.
void
setAccelerationPriority(float priority)
Sets the acceleration priority of the image.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SCALE_AREA_AVERAGING

public static final int SCALE_AREA_AVERAGING
Constant indicating that the area averaging scaling algorithm should be used.
Field Value:
16
Since:
1.1

SCALE_DEFAULT

public static final int SCALE_DEFAULT
Constant indicating that the default scaling algorithm should be used.
Field Value:
1
Since:
1.1

SCALE_FAST

public static final int SCALE_FAST
Constant indicating that a fast scaling algorithm should be used.
Field Value:
2
Since:
1.1

SCALE_REPLICATE

public static final int SCALE_REPLICATE
Constant indicating that the ReplicateScaleFilter class algorithm should be used for scaling.
Field Value:
8
Since:
1.1

SCALE_SMOOTH

public static final int SCALE_SMOOTH
Constant indicating that a smooth scaling algorithm should be used.
Field Value:
4
Since:
1.1

UndefinedProperty

public static final Object UndefinedProperty
This variable is returned whenever a property that is not defined is requested.

accelerationPriority

protected float accelerationPriority
The acceleration priority of the image
Since:
1.5

Constructor Details

Image

public Image()
A default constructor for subclasses.

Method Details

flush

public abstract void flush()
Flushes (that is, destroys) any resources used for this image. This includes the actual image data.

getAccelerationPriority

public float getAccelerationPriority()
Returns the acceleration priority of the image.
Since:
1.5

getGraphics

public abstract Graphics getGraphics()
Returns a graphics context object for drawing an off-screen object. This method is only valid for off-screen objects.
Returns:
a graphics context object for an off-screen object

getHeight

public abstract int getHeight(ImageObserver observer)
Returns the height of the image, or -1 if it is unknown. If the image height is unknown, the observer object will be notified when the value is known.
Parameters:
observer - the image observer for this object
Returns:
the height in pixels

getProperty

public abstract Object getProperty(String name,
                                   ImageObserver observer)
This method requests a named property for an object. The value of the property is returned. The value UndefinedProperty is returned if there is no property with the specified name. The value null is returned if the properties for the object are not yet known. In this case, the specified image observer is notified when the properties are known.
Parameters:
name - the requested property name
observer - the image observer for this object
Returns:
the named property, if available

getScaledInstance

public Image getScaledInstance(int width,
                               int height,
                               int flags)
Scales the image to the requested dimension. A new Image with asynchronous loading will be produced according to the hints of the algorithm requested. If either the width or height is non-positive, it is adjusted to preserve the original aspect ratio. If an illegal value of flags is passed, the default algorithm is used.
Parameters:
width - the width of the scaled image
height - the height of the scaled image
flags - a value indicating the algorithm to use
Returns:
the scaled Image object
Since:
1.1

getSource

public abstract ImageProducer getSource()
Returns the image producer object for this object. The producer is the object which generates pixels for this image.
Returns:
the image producer for this object

getWidth

public abstract int getWidth(ImageObserver observer)
Returns the width of the image, or -1 if it is unknown. If the image width is unknown, the observer object will be notified when the value is known.
Parameters:
observer - the image observer for this object
Returns:
the width in pixels

setAccelerationPriority

public void setAccelerationPriority(float priority)
Sets the acceleration priority of the image. This is a value from 0 (lowest) to 1 (highest), which may be used as a hint for image acceleration. E.g. higher priority images may be stored in video memory.
Parameters:
priority - - the priority
Throws:
IllegalArgumentException - if priority is not >= 0 and <= 1.
Since:
1.5

Image.java -- superclass for images Copyright (C) 1999, 2002, 2004, 2005, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.